swagger-api / swagger-api/swagger-ui
a11y: Improper use of preformatted text elements for version labels
Open
Nobody has claimed this yet.
backlog
cat: a11y
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Q&A
- OS: [e.g. macOS]: macOS
- Browser: [e.g. chrome, safari]: Chrome
- Version: [e.g. 22]: 136
- Method of installation: [e.g. npm, dist assets]:
@nestjs/swaggervia npm - Swagger-UI version: [e.g. 3.10.0]: @nestjs/swagger version 11.2.0 which uses Swagger UI version 5.21.0.
- Swagger/OpenAPI version: [e.g. Swagger 2.0, OpenAPI 3.0]: OpenAPI version 3.0
Content & configuration
Basic/default configuration
Describe the bug you're encountering
The version labels are represented in the DOM by <pre> tags:
Expected behavior
<pre> tags should only be used to represent blocks of computer code or figures:
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
Inspect the rendered Swagger UI version labels in the default configuration and identify where their DOM elements are produced. Confirm that version labels no longer use preformatted text elements, while code blocks and figures retain appropriate preformatted markup.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- accessibility, frontend
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100