refactor(schema): support properly Literal in generated JSON schema
#2348
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
PrettyWood
force-pushed
the
literal-schema
branch
from
46dae1b
to
577d8c3
Compare
4 tasks
Codecov Report
@@ Coverage Diff @@
## master #2348 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 23 23
Lines 4485 4489 +4
Branches 909 910 +1
=========================================
+ Hits 4485 4489 +4
Continue to review full report at Codecov.
|
PrettyWood
commented
Feb 12, 2021
| 'a': {'title': 'A', 'type': 'integer', 'enum': [1]}, | ||
| 'b': {'title': 'B', 'type': 'string', 'enum': ['a']}, | ||
| 'c': {'title': 'C', 'anyOf': [{'type': 'string', 'enum': ['a']}, {'type': 'integer', 'enum': [1]}]}, | ||
| 'd': { |
There was a problem hiding this comment.
Worth comparing with the first commit 3a14c72 😉
|
great, thank you. 🙇 🐗 |
13 tasks
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.
Change Summary
Currently we don't support properly
Literalwith multi valuesFollowing this comment I feel like it could be good to support them properly.
Using
enumeven with one value should not have any impact and work everywhere sinceconstis just syntactic sugar forenumwith a single element (see ref)ReDoc
q: Literal["pika"]q: Literal["pika", Literal["chu"]]Swagger
q: Literal["pika"]q: Literal["pika", Literal["chu"]]Related issue number
Closes #1350
Checklist
changes/<pull request or issue id>-<github username>.mdfile added describing change(see changes/README.md for details)