Query flags result in optional args#4
Merged
jwoudenberg merged 1 commit intomasterfrom Dec 29, 2020
Merged
Conversation
When adding a query flag to an existing endpoint it would be nice if this were a backwards-compatible change. From the HTTP perspective it already is: the query flag is an optional element of the URI that can be omitted. But code generation produces a non-optional argument. This imposes a hard order-of-deploy between the service that supports the new parameter and the client that makes use of it (or not). This changes the code so the query flag is an optional argument in ruby generated code. That way the backwards-compatibility of adding a query parameter to an API is preserved into our generated code.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Use case: we'd love to add a query flag to an existing endpoint in a backwards compatible manner. This makes it possible by using optional ruby args for query parameters.