Allow description to be optional #120
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
flxdot
force-pushed
the
optional-description
branch
from
763be1f to
11356b2
Compare
stephenfin
force-pushed
the
optional-description
branch
from
11356b2 to
82a458d
Compare
|
Both in OpenAPI spec 2.0 and 3.0, |
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.
I encountered this problem during the usage of this library in a project of mine. One endpoint was missing a description, which resulted in an build error.
This Pullrequest allows descriptions of any sort to be missing from the
openapi.json.The Specification it self does not require those fields (see https://swagger.io/specification/), thus this library should not force the user to provide it.
I would greatly appreciate, if this proposal makes it way into the next release.