A few options has been missing from `docs/usage/configuration.md`.

Open Beginner friendly
#10,745 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
javascript
Domain
documentation

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.

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.

  • components
  • fn
  • configs
  • initialState
  • fileUploadMediaTypes
  • uncaughtExceptionHandler

I think they should be added into the markdown doc, for better referencing purpose.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from swagger-api/swagger-ui

All issues in swagger-api/swagger-ui

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.