swagger-api / swagger-api/swagger-ui
Markdown not rendered
Open
Nobody has claimed this yet.
cat: rendering
P2
type: bug
version: 3.x
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
In responses, the markdown is not rendered
Current result:
You can see that the MD is not rendered
Expected result
the MD is rendered. Image from the editor , but rendering was similar in previous version of Swagger UI
How to reproduce
Paste this code in YAML API spec
responses:
Error403:
description: |
** Forbidden **
Possible values
| Error Name | Error Message |
|--------|---|---|
| FORBIDDEN | Forbidden |
schema:
$ref: '#/definitions/Error'
And use it as response
Notes
- Same behavior seems to occurs in other parts of the API spec interpretation ( tested in API call description and reproduced )
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue with the provided YAML response description, then compare rendering in response descriptions and API call descriptions. Trace the Swagger UI entry point that interprets these Markdown fields; done means the bold text, image, and table render as Markdown in both reported locations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100