Updated Python docs

This commit is contained in:
Daniel Hougaard
2023-12-24 17:11:08 +04:00
parent 8df22302fd
commit c463256058
+40 -20
View File
@@ -62,24 +62,40 @@ client = InfisicalClient(ClientSettings(
### Parameters ### Parameters
<ParamField query="client_id" type="string" optional> <ParamField query="options" type="object">
Your Infisical Client ID. <Expandable title="properties">
</ParamField> <ParamField query="client_id" type="string" optional>
<ParamField query="client_secret" type="string" optional> Your Infisical Client ID.
Your Infisical Client Secret. </ParamField>
</ParamField> <ParamField query="client_secret" type="string" optional>
<ParamField query="access_token" type="string" optional> Your Infisical Client Secret.
If you want to directly pass an access token obtained from the authentication endpoints, you can do so. </ParamField>
</ParamField> <ParamField query="access_token" type="string" optional>
<ParamField If you want to directly pass an access token obtained from the authentication endpoints, you can do so.
query="site_url" </ParamField>
type="string"
default="https://app.infisical.com" <ParamField query="cache_ttl" type="number" default="300" optional>
optional Time-to-live (in seconds) for refreshing cached secrets.
> If manually set to 0, caching will be disabled, this is not recommended.
Your self-hosted absolute site URL including the protocol (e.g. </ParamField>
`https://app.infisical.com`)
</ParamField>
<ParamField
query="site_url"
type="string"
default="https://app.infisical.com"
optional
>
Your self-hosted absolute site URL including the protocol (e.g.
`https://app.infisical.com`)
</ParamField>
</Expandable>
</ParamField>
### Caching
The SDK caches every secret and updates it periodically based on the provided cacheTTL. For example, if cacheTTL of 300 is provided, then a secret will be refetched every 5 minutes. The SDK first attempts to return the cached secret, but if no secret is found it'll make a request to get the fresh secret. Every time the secret is fetched from the cache, the cached secret expiry is reset.
## Working with Secrets ## Working with Secrets
@@ -109,7 +125,11 @@ Retrieve all secrets within the Infisical project and environment that client is
The path from where secrets should be fetched from. The path from where secrets should be fetched from.
</ParamField> </ParamField>
<ParamField query="include_imports" type="string" default="https://app.infisical.com" optional> <ParamField query="attach_to_process_env" type="boolean" default="false" optional>
Whether or not to set the fetched secrets to the process environment. If true, you can access the secrets like so `process.env["SECRET_NAME"]`.
</ParamField>
<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>
</Expandable> </Expandable>
@@ -148,7 +168,7 @@ By default, `getSecret()` fetches and returns a shared secret. If not found, it
<ParamField query="type" type="string" optional> <ParamField query="type" type="string" optional>
The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "personal". The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "personal".
</ParamField> </ParamField>
<ParamField query="include_imports" type="string" default="https://app.infisical.com" 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>
</Expandable> </Expandable>