swagger-api / swagger-api/swagger-ui
A few options has been missing from `docs/usage/configuration.md`.
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Q&A (please complete the following information)
- OS: N/A
- Browser: N/A
- Version: Latest
- Method of installation: N/A
- Swagger-UI version: Latest
- Swagger/OpenAPI version: Latest
Content & configuration
It seems the below options appears on src/core/config/defaults.js, but missing from docs/usage/configuration.md.
componentsfnconfigsinitialStatefileUploadMediaTypesuncaughtExceptionHandler
I think they should be added into the markdown doc, for better referencing purpose.
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
Compare the options documented in docs/usage/configuration.md with the defaults listed in src/core/config/defaults.js. Add documentation for components, fn, configs, initialState, fileUploadMediaTypes, and uncaughtExceptionHandler. Done means each listed option is represented in the configuration reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 76/100