Add support to x-codeSamples in v3 #701
Merged
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.
Description
This PR aims to fix the
x-codeSamples
integration. Whenx-codeSamples
are provided, add as a variant for the target supported language in the API Explorer. At first it seems that the code was aiming to only display the custom code sample whenx-codeSamples
is provided. I assumed it's better to add the custom code samples to the existing generated code samples in the list of variantsMotivation and Context
x-codeSamples
redoc extension was partially supported and breaking the rendering if loaded in API Explorer. Continues #589 (@joecrop I tried to continue the implementation but the codebase has changed considerably)How Has This Been Tested?
Go to http://localhost:3000/petstore/add-pet and check API Explorer code samples. It reflects the OpenAPI spec now on
x-codeSamples
, following syntax highlightingTypes of changes
Checklist