feat: Document env var redaction on deployment and app reads

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 125
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-83323f87ab825547b6cd11caa46e2643ebb0a68bbd326d4e07ccab970638fc03.yml
-openapi_spec_hash: 69ed04a66b4ef68e97f7bdc07dfe6df2
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/kernel/kernel-89a500b26fe8126183d55aaca53f5615c6a25561d8e01e907f4998239ccc7a0b.yml
+openapi_spec_hash: 50236a5e713d5424ca35c0883926b0a5
 config_hash: 06186eb40e0058a2a87ac251fc07415d

src/resources/apps.ts

@@ -47,7 +47,9 @@ export interface AppListResponse {
   deployment: string;
 
   /**
-   * Environment variables configured for this app version
+   * Environment variables configured for this app version. Values are redacted for
+   * API key, OAuth, and managed-auth callers, which receive every key with an empty
+   * string value. Only dashboard sessions receive the actual values.
    */
   env_vars: { [key: string]: string };
 

src/resources/deployments.ts

@@ -159,7 +159,9 @@ export namespace DeploymentStateEvent {
     entrypoint_rel_path?: string;
 
     /**
-     * Environment variables configured for this deployment
+     * Environment variables configured for this deployment. Values are redacted for
+     * API key, OAuth, and managed-auth callers, which receive every key with an empty
+     * string value. Only dashboard sessions receive the actual values.
      */
     env_vars?: { [key: string]: string };
 
@@ -205,7 +207,9 @@ export interface DeploymentCreateResponse {
   entrypoint_rel_path?: string;
 
   /**
-   * Environment variables configured for this deployment
+   * Environment variables configured for this deployment. Values are redacted for
+   * API key, OAuth, and managed-auth callers, which receive every key with an empty
+   * string value. Only dashboard sessions receive the actual values.
    */
   env_vars?: { [key: string]: string };
 
@@ -250,7 +254,9 @@ export interface DeploymentRetrieveResponse {
   entrypoint_rel_path?: string;
 
   /**
-   * Environment variables configured for this deployment
+   * Environment variables configured for this deployment. Values are redacted for
+   * API key, OAuth, and managed-auth callers, which receive every key with an empty
+   * string value. Only dashboard sessions receive the actual values.
    */
   env_vars?: { [key: string]: string };
 
@@ -295,7 +301,9 @@ export interface DeploymentListResponse {
   entrypoint_rel_path?: string;
 
   /**
-   * Environment variables configured for this deployment
+   * Environment variables configured for this deployment. Values are redacted for
+   * API key, OAuth, and managed-auth callers, which receive every key with an empty
+   * string value. Only dashboard sessions receive the actual values.
    */
   env_vars?: { [key: string]: string };
 
@@ -361,7 +369,8 @@ export namespace DeploymentFollowResponse {
     version: string;
 
     /**
-     * Environment variables configured for this app version
+     * Environment variables configured for this app version. Not currently populated
+     * on streamed app_version_summary events.
      */
     env_vars?: { [key: string]: string };
   }