Sync OpenAPI; Multiple parameter correctness changes #206
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
This includes the results of: * hashicorp/vault#21949 * hashicorp/vault#21942 * hashicorp/vault#22027 The general direction of change is pretty positive, but in reviewing the generated diffs, I have spotted an issue: we are now generating correct parameters for query parameters... but those query parameters are being handled as individual function parameters... which are generated in the order listed in the OpenAPI spec... which is dependent on random Go hash iteration ordering. Ugh. Oh well, let's catch up with latest developments in the Vault repo for now, and I'll go put in a new PR to at least sort the parameters alphabetically. Longer term, this is probably going to push us in the direction of excluding the GET version of APIs with equivalent GET and POST versions from the generated libraries.
averche
approved these changes
Jul 25, 2023
We can definitely do that. As a library user, I would rather want just the a single "recommended" method exposed to me rather than having to guess which one to use. |
Merged
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.
This includes the results of:
Query: truemetadata to API definitions vault#21949The general direction of change is pretty positive, but in reviewing the
generated diffs, I have spotted an issue: we are now generating correct
parameters for query parameters... but those query parameters are being
handled as individual function parameters... which are generated in the
order listed in the OpenAPI spec... which is dependent on random Go hash
iteration ordering. Ugh.
Oh well, let's catch up with latest developments in the Vault repo for
now, and I'll go put in a new PR to at least sort the parameters
alphabetically.
Longer term, this is probably going to push us in the direction of
excluding the GET version of APIs with equivalent GET and POST versions
from the generated libraries.