Skip to content
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

Hide credentials from generated code snippets #1050

Merged
merged 2 commits into from
Dec 16, 2024
Merged

Conversation

sserrata
Copy link
Member

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 to makeRequest will 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

  • New feature (non-breaking change which adds functionality)

@sserrata sserrata added enhancement New feature or request v4.0.0 v4.0.0 labels Dec 16, 2024
@sserrata sserrata self-assigned this Dec 16, 2024
Copy link

github-actions bot commented Dec 16, 2024

Size Change: 0 B

Total Size: 2.02 MB

ℹ️ View Unchanged
Filename Size
demo/.docusaurus/codeTranslations.json 2 B
demo/.docusaurus/docusaurus.config.mjs 13.9 kB
demo/.docusaurus/globalData.json 39 kB
demo/.docusaurus/i18n.json 267 B
demo/.docusaurus/registry.js 57.5 kB
demo/.docusaurus/routes.js 53.1 kB
demo/.docusaurus/routesChunkNames.json 22 kB
demo/.docusaurus/site-metadata.json 1.23 kB
demo/build/assets/css/styles.********.css 146 kB
demo/build/assets/js/main.********.js 693 kB
demo/build/assets/js/runtime~main.********.js 15.3 kB
demo/build/index.html 90.4 kB
demo/build/petstore/add-pet/index.html 27.4 kB
demo/build/petstore/create-user/index.html 21.5 kB
demo/build/petstore/create-users-with-array-input/index.html 21.5 kB
demo/build/petstore/create-users-with-list-input/index.html 21.5 kB
demo/build/petstore/delete-order/index.html 21.5 kB
demo/build/petstore/delete-pet/index.html 21.6 kB
demo/build/petstore/delete-user/index.html 21.8 kB
demo/build/petstore/find-pets-by-status/index.html 22.3 kB
demo/build/petstore/find-pets-by-tags/index.html 22.9 kB
demo/build/petstore/get-inventory/index.html 20.8 kB
demo/build/petstore/get-order-by-id/index.html 21.8 kB
demo/build/petstore/get-pet-by-id/index.html 22.4 kB
demo/build/petstore/get-user-by-name/index.html 21.9 kB
demo/build/petstore/login-user/index.html 22.4 kB
demo/build/petstore/logout-user/index.html 21.2 kB
demo/build/petstore/new-pet/index.html 21.8 kB
demo/build/petstore/pet/index.html 23.5 kB
demo/build/petstore/place-order/index.html 21 kB
demo/build/petstore/schemas/apiresponse/index.html 22.8 kB
demo/build/petstore/schemas/cat/index.html 36.7 kB
demo/build/petstore/schemas/category/index.html 23.9 kB
demo/build/petstore/schemas/dog/index.html 37.1 kB
demo/build/petstore/schemas/honeybee/index.html 37.2 kB
demo/build/petstore/schemas/id/index.html 20.9 kB
demo/build/petstore/schemas/order/index.html 25 kB
demo/build/petstore/schemas/pet/index.html 36.6 kB
demo/build/petstore/schemas/tag/index.html 22.3 kB
demo/build/petstore/schemas/user/index.html 44.8 kB
demo/build/petstore/store/index.html 21.5 kB
demo/build/petstore/subscribe-to-the-store-events/index.html 27.8 kB
demo/build/petstore/swagger-petstore-yaml/index.html 27.8 kB
demo/build/petstore/update-pet-with-form/index.html 21.7 kB
demo/build/petstore/update-pet/index.html 22.2 kB
demo/build/petstore/update-user/index.html 21.8 kB
demo/build/petstore/upload-file/index.html 21.6 kB
demo/build/petstore/user/index.html 22.4 kB

compressed-size-action

Copy link

github-actions bot commented Dec 16, 2024

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

@sserrata sserrata merged commit 1f875bc into main Dec 16, 2024
9 checks passed
@sserrata sserrata deleted the clean-credentials branch December 16, 2024 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request v4.0.0 v4.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant