swagger-api / swagger-api/swagger-ui
Support Markdown for tags externalDocs description
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Content & configuration
Swagger/OpenAPI definition:
tags:
- name: pet
description: Everything <br /> about your Pets
externalDocs:
description: Find out more about this on our website page you can blah blah blah blah blah blah <br />
url: 'http://swagger.io'
Is your feature request related to a problem?
When creating my documentation I would like the documentation to display my URL on a different line than the description for my external docs. Markdown is supported for the Tag description but this does not seem to work for external docs as seen in my example.
Describe the solution you'd like
Please support the use of Markdown here as well to display documentation appropriately
Additional context
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
No file or test is named in the issue. Start by locating the renderer for tag externalDocs and compare it with the existing Markdown handling for tag descriptions. Done means Markdown in the externalDocs description is rendered so the documentation text and URL display appropriately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100