Hide credentials from generated code snippets#1050
Merged
Conversation
|
Size Change: 0 B Total Size: 2.02 MB ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit 97d0d8b): https://docusaurus-openapi-36b86--pr1050-jr3638v6.web.app (expires Wed, 15 Jan 2025 21:27:15 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
4 tasks
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
1 participant
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
Follow up to #1039 with the goal of masking credentials in generated code snippets. The expected behavior is that any credentials included in code snippets will be replaced with placeholders, e.g.
<api_key>, matching the key name of the credential property. Meanwhile, credentials passed tomakeRequestwill still be represented by the actual values.Motivation and Context
Follows best practice of hiding credentials from UI to improve privacy and security. Additionally, anyone creating screenshots or demo videos will not need to worry about credentials leaking or having to blur or mask them before publishing/sharing.
How Has This Been Tested?
Tested locally in dev
Screenshots (if appropriate)
See deploy preview
Types of changes