Adding capabilities endpoint to the REST API - #850
Open
FHatCSW wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new unauthenticated REST endpoint under the management API to advertise what this Trustpoint instance supports (protocol enablement plus crypto backend status), and wires it into the router with initial tests.
Changes:
- Introduces
CapabilitiesViewSetat/api/capabilities/to return supported onboarding/no-onboarding protocols and crypto backend info. - Registers the new viewset in
management/api_urls.py. - Adds basic endpoint tests for auth-free access and protocol-availability behavior.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
trustpoint/management/views/capabilities.py |
Implements the capabilities endpoint and its OpenAPI schema. |
trustpoint/management/tests/test_capabilities.py |
Adds tests for endpoint accessibility and protocol flags. |
trustpoint/management/api_urls.py |
Registers /api/capabilities/ route in the management API router. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 'crypto_backend': { | ||
| 'type': 'object', | ||
| 'properties': { | ||
| 'kind': {'type': 'string', 'example': 'software'}, |
Comment on lines
+140
to
+146
| try: | ||
| active_profile = CryptoProviderProfileModel.objects.filter(active=True).first() | ||
| if active_profile: | ||
| crypto_backend_kind = active_profile.backend_kind | ||
| crypto_backend_active = True | ||
| except Exception: | ||
| self.logger.exception('Failed to retrieve crypto backend information') |
Comment on lines
+56
to
+58
| # Check crypto backend | ||
| assert 'kind' in data['crypto_backend'] | ||
| assert 'active' in data['crypto_backend'] |
Comment on lines
+59
to
+60
|
|
||
| def test_capabilities_with_security_config(self) -> None: |
|
Codecov Report❌ Patch coverage is
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Legal