docs(configuration): add missing config options to documentation#10840
Open
yogeshwaran-c wants to merge 1 commit intoswagger-api:masterfrom
Open
docs(configuration): add missing config options to documentation#10840yogeshwaran-c wants to merge 1 commit intoswagger-api:masterfrom
yogeshwaran-c wants to merge 1 commit intoswagger-api:masterfrom
Conversation
Add the following options that were defined in defaults.js but missing from docs/usage/configuration.md: - components: plugin system object for component overrides - fn: plugin system object for function overrides - configs: internal configuration pass-through object - initialState: initial Redux store state - fileUploadMediaTypes: media type prefixes for file upload UI - uncaughtExceptionHandler: handler for uncaught exceptions Fixes swagger-api#10745
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Several configuration options defined in
src/core/config/defaults.jswere missing from the configuration documentation atdocs/usage/configuration.md.The following options have been added to their appropriate sections:
components(Plugin system section) - Object for component overridesfn(Plugin system section) - Object for function overridesinitialState(Plugin system section) - Object for initial Redux store stateconfigs(Core section) - Object for additional configuration valuesfileUploadMediaTypes(Display section) - Array of media type prefixes that trigger file upload UIuncaughtExceptionHandler(Core section) - Function to handle uncaught exceptionsMotivation and Context
Fixes #10745
Users looking at the configuration documentation could not find these options, even though they are available and functional. This made it harder to discover and use them properly.
How Has This Been Tested?
src/core/config/defaults.jsto verify correct types and default valuesScreenshots (if appropriate):
N/A
Checklist
My PR contains...
src/is unmodified: changes to documentation, CI, metadata, etc.)package.json)My changes...
Documentation
Automated tests