Restyle Fix query flag casing #20
Open
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
![restyled-io[bot]](https://avatars.githubusercontent.com/in/5851?s=60&v=4){kind=small}
Next version
Creates space for other test suites in the `test` directory, such as the golden test I'm about to add.
These test (and document) what code generation currently looks like for various Servant API constructors.
Query flags are the Http equivalent of booleans. You can either set them or you cannot. Currently the generated ruby code treats them as values: You pass in a string and it gets added to the query string. This ensures query flags in a servant API are modeled as booleans in the generated ruby code.
Fix query param generation
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.
Query flags result in optional args
We weren't using the snake-cased variable name for a query flag in all the places we were using the query flag.
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.
A duplicate of #19 with additional commits that automatically address
incorrect style, created by Restyled.
Since the original Pull Request was opened as a fork in a contributor's
repository, we are unable to create a Pull Request branching from it with only
the style fixes.
The following Restylers made fixes:
To incorporate these changes, you can either:
Merge this Pull Request instead of the original, or
Ask your contributor to locally incorporate these commits and push them to
the original Pull Request
Expand for example instructions
NOTE: As work continues on the original Pull Request, this process will
re-run and update (force-push) this Pull Request with updated style fixes as
necessary. If the style is fixed manually at any point (i.e. this process finds
no fixes to make), this Pull Request will be closed automatically.
Sorry if this was unexpected. To disable it, see our documentation.