Always render a collection's description and example. #48
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
|
Are there any existing OAS docs that don’t render collection descriptions and rely on this behaviour? |
|
I'm going through all of them, I should have opened a Draft PR |
This removes the need of the `x-nexmo-developer-collection-description-shown` property in the api specifications, and treats collections as any other type.
fabianrbz
force-pushed
the
remove-x-nexmo-developer-collection-description-shown
branch
from
5e9219a
to
b89d46d
Compare
|
@mheap should be ready now |
|
@fabianrbz To confirm, this won't have any impact on existing OAS docs that previously didn't show the description? |
|
@fabianrbz Ping |
|
Unfortunately we can't merge this. we have some docs that have a dummy description in them. |
|
Do you have examples of things in our specs that we shouldn't render? Should we fix the specs and then merge this? |
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 removes the need of the
x-nexmo-developer-collection-description-shownproperty in the apispecifications, and treats collections as any other type.
Doesn't break backward compatibility and renders arrays for all the oas