Allow JSON-like examples to be shown #225
Closed
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
|
I also noticed #171, so I realise there might be other ways you'd prefer to support this, and that's fine too 👍 |
|
Hey @brendo, thanks for PR. Sorry for long reply, a bit busy with other projects. |
|
Closing in favour of #227 |
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.
The API my company is trying to describe with Open API implements JSON API which dictates that the Content Type be set to
application/vnd.api+json.We are encouraging developers to make use of the
examplesfunctionality for their endpoints and noticed that the current codebase only shows examples if they matchedapplication/json. This essentially meant our examples were not being displayed by ReDoc.This change does a fuzzy match to see if the content type contains anything like
json. It's working well for us so-far, so thought we'd share back!