From 02aca3dde931b49d4f9b3968fb0c65fcc2dee53f Mon Sep 17 00:00:00 2001 From: wix-docs-feds <87931637+wix-docs-feds@users.noreply.github.com> Date: Mon, 5 Dec 2022 12:46:29 +0200 Subject: [PATCH] secrets-backend intro update * DocWorks for wix-secrets-backend - 1 change detected changes: Service wix-secrets-backend has changed description * DocWorks for wix-secrets-backend - 1 change detected changes: Service wix-secrets-backend has changed description * DocWorks for wix-secrets-backend - 1 change detected changes: Service wix-secrets-backend has changed description * DocWorks for wix-secrets-backend - 1 change detected changes: Service wix-secrets-backend has changed description Co-authored-by: christopherbWIX Co-authored-by: christopherbWIX <116498462+christopherbWIX@users.noreply.github.com> --- .../wix-secrets-backend.service.json | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/wix-secrets-backend/wix-secrets-backend.service.json b/wix-secrets-backend/wix-secrets-backend.service.json index 204708826f7..c9119eea227 100644 --- a/wix-secrets-backend/wix-secrets-backend.service.json +++ b/wix-secrets-backend/wix-secrets-backend.service.json @@ -8,18 +8,17 @@ "docs": { "summary": "The wix-secrets-backend module contains functionality for\nmanaging secrets you safely store in your site's [Secrets Manager](https://support.wix.com/en/article/velo-about-the-secrets-manager).", "description": - [ "The Secrets Manager allows you to store and encrypt API keys and other secrets on your site.", - "Then, you can use the secret's name or ID in your backend code instead of a hardcoded value.", + [ "Velo's Secrets Manager allows you to securely store API keys and other secrets on your site. ", + "Each secret's value is encrypted, and assigned a name of your choice and an ID.", + "You can then use the name or ID to refer to the secret in your backend code rather than hardcoding its value.", + "", + "Learn more [about Velo's Secrets Manager](https://support.wix.com/en/article/velo-about-the-secrets-manager).", "", "With the Secrets API, you can safely:", "", "- Manage secrets.", "- Retrieve secret values.", - "- Retrieve non-value information. For example, names and descriptions.", - "", - "Learn more [about the Secrets Manager](https://support.wix.com/en/article/velo-about-the-secrets-manager).", - "", - "Learn how to [work with the Secrets Manager](https://support.wix.com/en/article/velo-working-with-the-secrets-manager).", + "- Retrieve other information about your secrets, such as their names and descriptions.", "", " To use the Secrets API, import `wixSecretsBackend` from the `wix-secrets-backend` module:", "", @@ -27,25 +26,26 @@ " import wixSecretsBackend from 'wix-secrets-backend';", " ```", "", - "> Learn more about wix-secrets-backend in [Getting Started](/getting-started/integration-with-third-party-services) and on [Wix Learn](https://www.wix.com/learn/online-course/coding-with-velo/velo-backend#secure-api-keys).", + "> Learn more about the Wix Secrets API in [Secrets Manager](/getting-started/integration-with-third-party-services_secrets-manager) in the Velo API Reference, and on [Wix Learn](https://www.wix.com/learn/online-course/coding-with-velo/velo-backend#secure-api-keys).", "", "## Before you begin", "", "It's important to note these points before coding:", "", "- You must set up a [Members Area](https://support.wix.com/en/article/site-members-adding-and-setting-up-a-members-area), before you can create or manage secrets with the Secrets API. ", - " The Members Area isn't required to retrieve secrets with getSecret().", - "- Deleting a secret, or modifying a secret's name or value breaks all code using the secret.", + " The Members Area isn't required to retrieve secrets with [`getSecret()`](https://www.wix.com/velo/reference/wix-secrets-backend/getsecret).", + "- Deleting a secret, or modifying a secret's name or value, breaks all code using the secret.", "- You can't create or rename a secret with a name that's already in use.", "", - "**Security Considerations**", - "- If you currently use private keys in your code, we recommend to remove them. ", + "**Security considerations**", + "- If you currently use private keys in your code, we recommend removing them. ", " You can either create a secret with the Secrets API or the [Functional Testing](https://support.wix.com/en/article/velo-functional-testing-in-the-backend) tool.", "- To prevent malicious users from accessing the values of your secrets, use them only in backend code. Avoid using secret values in client side code. ", "", " ## Terminology", "", - "- **Secret**: Secrets are values that you don’t want to be publicly accessible, such as login credentials or API keys." ], + "- **Secret**: Secrets are values that you don’t want to be publicly accessible, such as login credentials or API keys.", + "- **API key**: An API (Application Programming Interface) key is a unique code used to authenticate a user or program when making a call to an API." ], "links": [], "examples": [], "extra":