From c7dc595e1ae8d627001fae11bcc6555570cfa0fe Mon Sep 17 00:00:00 2001 From: x032205 Date: Thu, 15 May 2025 12:05:06 -0400 Subject: [PATCH] doc overview update --- docs/integrations/secret-syncs/overview.mdx | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/integrations/secret-syncs/overview.mdx b/docs/integrations/secret-syncs/overview.mdx index f097f0503..87527fd02 100644 --- a/docs/integrations/secret-syncs/overview.mdx +++ b/docs/integrations/secret-syncs/overview.mdx @@ -97,24 +97,22 @@ via the UI or API for the third-party service you intend to sync secrets to. ## Key Schemas -Key Schemas let you control how Infisical names your secret keys when syncing to external destinations. This makes it clear which secrets are managed by Infisical and prevents accidental changes to unrelated secrets. +Key Schemas transform your secret keys by applying a prefix, suffix, or format pattern during sync to external destinations. This makes it clear which secrets are managed by Infisical and prevents accidental changes to unrelated secrets. -A Key Schema adds a prefix, suffix, or format to your secrets before they reach the destination. - -This example demonstrates key behavior if the schema was set to `INFISICAL_{{secretKey}}`: +**Example:** +- Infisical key: `SECRET_1` +- Schema: `INFISICAL_{{secretKey}}` +- Synced key: `INFISICAL_SECRET_1`
```mermaid graph LR - A[SECRET_1] --> T["Syncs as"] --> B[INFISICAL_SECRET_1] - - style A fill:#E6F4FF,stroke:#0096D6,stroke-width:2px,color:black,rx:15px - style B fill:#F4FFE6,stroke:#96D600,stroke-width:2px,color:black,rx:15px - style T fill:#FFF2B2,stroke:#E6C34A,stroke-width:2px,color:black,rx:2px,font-size:12px - + A[Infisical: **SECRET_1**] -->|Apply Schema| B[Destination: **INFISICAL_SECRET_1**] + style B fill:#F4FFE6,stroke:#96D600,stroke-width:2px,color:black,rx:15px + style A fill:#E6F4FF,stroke:#0096D6,stroke-width:2px,color:black,rx:15px ```
- When importing secrets from the destination into infisical, the schema is stripped from imported secret keys. + When importing secrets from the destination into Infisical, the schema is stripped from imported secret keys.