SRV-754 Add Network Device Creation Endpoint Documentation #26
Conversation
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
Added comprehensive documentation for the new network device creation endpoint supporting both immutable and mutable device types with detailed parameter specifications and examples.
Added missing security configuration specifying Network-Token authentication for the Create Device using Network endpoint.
Enhanced documentation with structured bullet points for device types and added warning about required Network-Token privileges.
bgelatti
changed the title
Added documentation for the network token creation endpoint including request schema with privilege configuration and response examples.
Fixed OpenAPI specification by moving response schema from request body to proper responses section with detailed property definitions.
…oint Updated field name from singular privilege to plural previlegies for consistency across request and response schemas.
Enhanced request body schema by defining createDevice property with explicit type and example instead of using inline example object.
Member
|
This documentation requires the release of the feature in the API and NextADmin to be approved |
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.
Problem
The API documentation was missing the
/integration/network/deviceendpoint, which allows creating devices directly through the Network integration without authentication headers required for standard device creation.Investigation
The endpoint supports two device types:
chunk_periodandchunk_retention) for optimized long-term, append-only storageThe endpoint was implemented but lacked comprehensive documentation and proper security configuration in the OpenAPI specification.
Solution
tagoio-api.yaml