fix: renders Markdown in all description fields
#34
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
HiDeoo
approved these changes
Jun 4, 2024
HiDeoo
changed the title
description fields
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.
Describe the pull request
Closes #33
This PR uses the Markdown component to render all description fields in line with the OpenAPI spec linked in the above issue. From my own testing, the component renders Markdown as expected.
Why
As mentioned in #33, description fields for parameters may include Markdown just as the schema description field does. To ensure that these fields are rendered properly, the
Md.astrocomponent should be used in place of theText.astrocomponent.How
The
Text.astrocomponent has been replaced with theMd.astrocomponent for all parameter description fields.Screenshots