api: networking: document Scope, ConfigOnly, ConfigFrom, Peers #47865
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
GoDoc is mostly copied from NetworkResource, which is the equivalent for retrieving the information. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Move the example values per-field to reduce the risk of the example given from diverging with the actual struct that's used for the request. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
…1.45) Move the example values per-field to reduce the risk of the example given from diverging with the actual struct that's used for the request. This patch updates older API versions (went back to v1.41). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
These fields were added in 9ee7b4d, but not documented in the API docs / swagger. Also move the example values per-field to reduce the risk of the example given from diverging with the actual struct that's used for the request. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
…igFrom Adds missing documentation for Scope, ConfigOnly, and ConfigFrom. The ConfigOnly and ConfigFrom fields were added in 9ee7b4d, but not documented in the API docs / swagger. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Add documentation for the Peers field. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
- api: swagger: Network: inline examples, and add ConfigOnly, ConfigFrom These fields were added in 9ee7b4d, but not documented in the API docs / swagger. Also move the example values per-field to reduce the risk of the example given from diverging with the actual struct that's used for the request. - api: swagger: POST /networks/create: document Scope, ConfigOnly, ConfigFrom Adds missing documentation for Scope, ConfigOnly, and ConfigFrom. The ConfigOnly and ConfigFrom fields were added in 9ee7b4d, but not documented in the API docs / swagger. - api: swagger: Network: add Peers Add documentation for the Peers field. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
akerouanton
approved these changes
May 28, 2024
Member
Author
|
Thanks! Let me bring this one in; added docs are not "amazing", but at least document some of the missing fields, so "slightly better". |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
api/types: NetworkCreate: add GoDoc
GoDoc is mostly copied from NetworkResource, which is the equivalent for
retrieving the information.
api: swagger: POST /networks/create: inline examples per-field
Move the example values per-field to reduce the risk of the example given
from diverging with the actual struct that's used for the request.
docs/api: POST /networks/create: inline examples per-field (v1.41 - v1.45)
Move the example values per-field to reduce the risk of the example given
from diverging with the actual struct that's used for the request.
This patch updates older API versions (went back to v1.41).
api: swagger: Network: inline examples, and add ConfigOnly, ConfigFrom
These fields were added in 9ee7b4d, but
not documented in the API docs / swagger.
Also move the example values per-field to reduce the risk of the example
given from diverging with the actual struct that's used for the request.
api: swagger: POST /networks/create: document Scope, ConfigOnly, ConfigFrom
Adds missing documentation for Scope, ConfigOnly, and ConfigFrom. The ConfigOnly
and ConfigFrom fields were added in 9ee7b4d,
but not documented in the API docs / swagger.
api: swagger: Network: add Peers
Add documentation for the Peers field.
docs/api: add Scope, ConfigOnly, ConfigFrom, Peers (v1.41 - v1.45)
api: swagger: Network: inline examples, and add ConfigOnly, ConfigFrom
These fields were added in 9ee7b4d, but
not documented in the API docs / swagger.
Also move the example values per-field to reduce the risk of the example
given from diverging with the actual struct that's used for the request.
api: swagger: POST /networks/create: document Scope, ConfigOnly, ConfigFrom
Adds missing documentation for Scope, ConfigOnly, and ConfigFrom. The ConfigOnly
and ConfigFrom fields were added in 9ee7b4d,
but not documented in the API docs / swagger.
api: swagger: Network: add Peers
Add documentation for the Peers field.
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)