feat(portal): Sanitize sensitive data in Spec Renderer#5704
Open
cloudjumpercat wants to merge 1 commit into
Open
feat(portal): Sanitize sensitive data in Spec Renderer#5704cloudjumpercat wants to merge 1 commit into
cloudjumpercat wants to merge 1 commit into
Conversation
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
cloudjumpercat
added
do not merge
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation to the Dev Portal “APIs” page describing how the Spec Renderer masks sensitive data in generated examples and in the Try It UI, aligning with issue #5088.
Changes:
- Adds “Sensitive data masking” to the Spec renderer feature support list.
- Introduces a new “Protect sensitive data in your API docs” section covering
x-sensitive-datamask strategies, usage example, and the “Mask sensitive data” toggle behavior.
| ``` | ||
|
|
||
| {:.info} | ||
| > Masking is display-only. Try It always sends the real credential values so API calls work correctly. |
| If your spec includes example values for fields like passwords, API keys, or email addresses, you can prevent those values from appearing in generated code samples, spec examples, and Try It responses. | ||
|
|
||
| * **Automatic masking:** Authentication credentials from `securitySchemes` are masked automatically in code samples and Try It response headers. No annotation is needed. | ||
| * **Opt-in masking with `x-sensitive-data`:** For request and response body properties that contain sensitive values, add `x-sensitive-data` to the schema property. This controls how the value is displayed in code sample examples and Try It response bodies. |
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
Fixes #5088
Preview Links
/catalog/apis/#protect-sensitive-data-in-your-api-docs
Checklist
descriptionentry in frontmatter.