Add example and warning for comma-separated query input values #3344
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
andreazube
force-pushed
the
docs/example-csv-query-parameter
branch
from
335ee77 to
e7fe960
Compare
|
Great example - thank you! :) |
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 mentioned on #3343, Tapir only supports comma-separated values (out of the box, that is) on Scala 2.13+.
This small PR makes that explicit in the main documentation, as it would've personally saved me a few minutes.
For good measure, I also added a complete runnable example.
To be fair, the existing doc page already includes clear code, but I thought a complete example could still be useful. Wdyt?
p.s. It's my first contribution to Tapir. It's a very small one and only touches documentation, but still, I'd be extra careful in case I missed something :)