Docs: Add expand secret references to single secret sdk docs

This commit is contained in:
Daniel Hougaard
2024-08-20 01:12:42 +04:00
parent d021b414cf
commit 95cf3cf6cc
4 changed files with 14 additions and 1 deletions

View File

@@ -382,6 +382,10 @@ By default, `GetSecret()` fetches and returns a shared secret.
<ParamField query="IncludeImports" type="boolean" optional> <ParamField query="IncludeImports" type="boolean" optional>
Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference) Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)
</ParamField> </ParamField>
<ParamField query="ExpandSecretReferences" type="boolean" optional>
Whether or not to expand secret references in the fetched secrets. Read about [secret reference](/documentation/platform/secret-reference)
</ParamField>
</Expandable> </Expandable>
</ParamField> </ParamField>

View File

@@ -367,9 +367,12 @@ By default, `getSecret()` fetches and returns a shared secret.
<ParamField query="setType()" type="string" optional> <ParamField query="setType()" type="string" optional>
The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared". The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".
</ParamField> </ParamField>
<ParamField query="setIncludeImports" type="boolean" optional> <ParamField query="setIncludeImports()" type="boolean" optional>
Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference) Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)
</ParamField> </ParamField>
<ParamField query="setExpandSecretReferences()" type="boolean" default="true" optional>
Whether or not to expand secret references in the fetched secrets. Read about [secret reference](/documentation/platform/secret-reference)
</ParamField>
</Expandable> </Expandable>
</ParamField> </ParamField>

View File

@@ -363,6 +363,9 @@ By default, `getSecret()` fetches and returns a shared secret.
<ParamField query="includeImports" type="boolean" optional> <ParamField query="includeImports" type="boolean" optional>
Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference) Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)
</ParamField> </ParamField>
<ParamField query="expandSecretReferences" type="boolean" default="true" optional>
Whether or not to expand secret references in the fetched secrets. Read about [secret reference](/documentation/platform/secret-reference)
</ParamField>
</Expandable> </Expandable>
</ParamField> </ParamField>

View File

@@ -335,6 +335,9 @@ By default, `getSecret()` fetches and returns a shared secret. If not found, it
<ParamField query="include_imports" type="boolean" default="false" optional> <ParamField query="include_imports" type="boolean" default="false" optional>
Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference) Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)
</ParamField> </ParamField>
<ParamField query="expand_secret_references" type="boolean" default="true" optional>
Whether or not to expand secret references in the fetched secrets. Read about [secret reference](/documentation/platform/secret-reference)
</ParamField>
</Expandable> </Expandable>
</ParamField> </ParamField>