swagger-api / swagger-api/swagger-ui
IBM accessibility and KC rendered swagger yaml/json files
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
To be accessible with IBM, we follow the accessibility guidelines and scan our web documents using the Dynamic Assessment Plugin (DAP) for FireFox; which is an automated test tool that is required to test accessibility complaisance of all Web content rendered in a standard browser. To be compliant, all violations (V), if any are reported, must be fixed to comply with the Web accessibility checklist. Unfixed violations result in a failure (non-compliance) with the associated checkpoints.
Using the DAP tool, the swagger docs include a few violations (see image below)
- we are using swagger-ui v2.2.10
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 by reproducing the rendered Swagger YAML/JSON documentation with swagger-ui v2.2.10 and running the Dynamic Assessment Plugin for Firefox. Use the linked image and reported DAP violations to identify the affected rendered elements; done means the documented accessibility violations are fixed and the scan passes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- accessibility, frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100