Set x-nullable based on field informations #217
Merged
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
Many fields may be set a nullable in an API. While not covered explicitly by Swagger 2, this information is usually indicated as a [vendor extension](https://swagger.io/docs/specification/2-0/swagger-extensions/) using the x-nullable field.
|
Hey - sorry for the delayed response. This seems allright, it's pretty non-intrusive and seems to be accepted by many tools. However it seems to me that it should only apply to JSON Schemas, not path/query/form/header parameters, am I wrong? |
|
Hi, thanks for the feedback. I did not dive much in drf-yasg so I'm not sure what you are refering to. I do not know much of the usage of vendor extensions on Swagger but the resulting YAML seems fine to me. |
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.
Many fields may be set a nullable in an API. While not covered explicitly
by Swagger 2, this information is usually indicated as a
vendor extension
using the x-nullable field.