internal/proto: improvements to OpenAPIv2 spec #4555
Merged
Commits on Apr 6, 2024
-
Add various pieces of metadata that can be used by the API docs renderer. Improve the service labels by specifying explicit tags. Specify error responses. Specify version at generation time.
-
internal/gen: add better errors
The default error entry is now used to cover all errors, as adding a new error for every possible status code was a bit much. This also properly includes the real error type now!
-
Add various pieces of metadata that can be used by the API docs rende…
…rer. Improve the service labels by specifying explicit tags.
-
-
-
-
internal/gen: better attribute examples
Replace Output Only comments with a field behavior annotation in accounts. Mark some fields as required. Add elaborate description for attributes.
-
-
-
-
-
-
-
-
-
-
internal/gen: add better API intro
Copy parts of the API docs into the description
-
-
-
internal/gen: remove required annotations
Unfortunately, while these help with the creating of resources, they still appear required in contexts where they are not, such as when updating a resource.
-
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.