Add missing Query: true metadata to API definitions
#189
Conversation
This file contains 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
As described in hashicorp/vault#21949 endpoints with non-path parameters that can be made use of during ReadOperation callbacks should have those fields marked as `Query: true` to ensure the OpenAPI spec truly reflects how the endpoints can be called. Endpoints concerned: - gcp/key/{roleset} - gcp/roleset/{roleset}/key - gcp/static-account/{name}/key The OpenAPI operation IDs for these operations that mention "with-parameters" should also be changed, as they perpetuate a misunderstanding - both read (GET) and update (POST/PUT) forms of these APIs are **equally** capable of being used with parameters.
averche
approved these changes
Jul 21, 2023
|
Thanks again for the work, @maxb! |
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.
As described in hashicorp/vault#21949 endpoints with non-path parameters
that can be made use of during ReadOperation callbacks should have those
fields marked as
Query: trueto ensure the OpenAPI spec truly reflectshow the endpoints can be called.
Endpoints concerned:
The OpenAPI operation IDs for these operations that mention
"with-parameters" should also be changed, as they perpetuate
a misunderstanding - both read (GET) and update (POST/PUT) forms of
these APIs are equally capable of being used with parameters.