-
Notifications
You must be signed in to change notification settings - Fork 289
Add maskCredentials as a pluginOption #1212
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add maskCredentials as a pluginOption #1212
Conversation
Thanks @Devon-White!
As a reminder, swizzling is another option for overriding the credential masking behavior but I believe there is definitely space for your proposed feature.
I think the key is that credential masking will be true by default with the option for users to implicitly "accept the risk" of un-masking them. I'll spend time testing/reviewing your PR and will let you know if any revisions are needed. Thanks!
Visit the preview URL for this PR (updated for commit 0da0a2f):
https://docusaurus-openapi-36b86--pr1212-f50qxc17.web.app
(expires 2025年8月27日 14:15:36 GMT)
🔥 via Firebase Hosting GitHub Action 🌎
Sign: bf293780ee827f578864d92193b8c2866acd459f
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@sserrata sorry to be pinging on a old PR, was just wondering if you had a estimate on when this new addition will be added to a new release! Thanks for for reviewing and approving! :)
Edit: Looks like the main released was skipped, but canary version was released: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/actions/runs/16571851556/job/47222835499
* Add maskCredentials as a pluginOption * fix formatting to be consistent
Uh oh!
There was an error while loading. Please reload this page.
Description
Related issue: #1157 (second reported issue)
added
maskCredentialsas 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 newfutureflags Docusaurus has exposed to speed up build times.The credentials will still be masked by default, but setting
maskCredentials: falsewill revert back to original behavior.How Has This Been Tested?
Locally forked, and built.
Test suite ran, and all passed.
Types of changes
Checklist