Add maskCredentials as a pluginOption #1212
Merged
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
Related issue: #1157 (second reported issue)
added
maskCredentials
as a plugin option.Motivation and Context
We have had multiple customers complain about our REST docs being "broken" because they would copy the generated code snippets that mask the API credentials. After some investigation and realizing this design was by choice, I figured I would add a plugin option to revert back to the original behavior.
Due to the number of complaints from our customers, we have gone ahead and rolled back to a older Docusaurus version (
3.6.3
) & plugin version (4.3.0
) as a compromise for our customers. We however would like to keep the old behavior of the plugin while also being able to benefit from the newfuture
flags Docusaurus has exposed to speed up build times.The credentials will still be masked by default, but setting
maskCredentials: false
will revert back to original behavior.How Has This Been Tested?
Locally forked, and built.
Test suite ran, and all passed.
Types of changes
Checklist