OpenAPIv3: description bugs #3645
Closed
Conversation
This file contains hidden or 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
This means that if you have two types in your design which are structurally identical but with different descriptions on some attributes they will no longer be deduped. This is useful if descriptions are used in generated documentation or clients.
isaacseymour
force-pushed
the
openapi-v3-dont-dedupe-on-description
branch
from
6b82bb3 to
2e67f99
Compare
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.
This means that if you have two types in your design which are structurally identical but with different descriptions on some attributes they will no longer be deduped. This is useful if descriptions are used in generated documentation or clients.
Previously any attribute which was defined as a
refto another schema in the output would not have the description included. This is now included!