swagger-api / swagger-api/swagger-ui
Collapsible markdown in descriptions?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Content & configuration
n/a
Is your feature request related to a problem?
Some of our endpoints have very large descriptions. It would help a lot if we could use collapsible blocks in Markdown, like you can do on GitHub, e.g.:
CLICK ME
yes, even hidden code blocks!
print("hello world!")
Describe the solution you'd like
Swagger-UI’s Markdown parser accepting collapsibles, like the CLICK ME one above.
Describe alternatives you've considered
We’re using sections, but, say, 10 screen heights of text, images etc. is… bad UX.
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
Start at Swagger UI’s Markdown parser and the description-rendering entry point; the issue does not name specific files or tests. Reproduce the example with a details/summary block, including a hidden Python code block, and verify that collapsible content renders correctly in endpoint descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, markdown
- Domain
- documentation, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100