PaloAltoNetworks / PaloAltoNetworks/docusaurus-openapi-docs
Mask password fields
Open
@sserrata is already working on this.
Since Jun 28, 2024.
enhancement
roadmap
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 315
- Avg merge
- 7d 5h
- Merged PRs (30d)
- 7
Description
OpenAPI supports optional "formats" on certain types:
https://spec.openapis.org/oas/v3.1.0#data-types
One of these is format: password for hinting to clients to mask the input.
This would be a useful addition so that docs can be used in demos and screencasts without revealing the presenter's password.
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.
Assessment
This issue has not been assessed yet.