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/kernel/types/app_list_response.py

@@ -25,7 +25,12 @@ class AppListResponse(BaseModel):
     """Deployment ID"""
 
     env_vars: Dict[str, str]
-    """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.
+    """
 
     region: Literal["aws.us-east-1a"]
     """Deployment region code"""

src/kernel/types/deployment_create_response.py

@@ -28,7 +28,12 @@ class DeploymentCreateResponse(BaseModel):
     """Relative path to the application entrypoint"""
 
     env_vars: Optional[Dict[str, str]] = None
-    """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.
+    """
 
     status_reason: Optional[str] = None
     """Status reason"""

src/kernel/types/deployment_follow_response.py

@@ -40,7 +40,10 @@ class AppVersionSummaryEvent(BaseModel):
     """Version label for the application"""
 
     env_vars: Optional[Dict[str, str]] = None
-    """Environment variables configured for this app version"""
+    """Environment variables configured for this app version.
+
+    Not currently populated on streamed app_version_summary events.
+    """
 
 
 DeploymentFollowResponse: TypeAlias = Annotated[

src/kernel/types/deployment_list_response.py

@@ -28,7 +28,12 @@ class DeploymentListResponse(BaseModel):
     """Relative path to the application entrypoint"""
 
     env_vars: Optional[Dict[str, str]] = None
-    """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.
+    """
 
     status_reason: Optional[str] = None
     """Status reason"""

src/kernel/types/deployment_retrieve_response.py

@@ -28,7 +28,12 @@ class DeploymentRetrieveResponse(BaseModel):
     """Relative path to the application entrypoint"""
 
     env_vars: Optional[Dict[str, str]] = None
-    """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.
+    """
 
     status_reason: Optional[str] = None
     """Status reason"""

src/kernel/types/deployment_state_event.py

@@ -28,7 +28,12 @@ class Deployment(BaseModel):
     """Relative path to the application entrypoint"""
 
     env_vars: Optional[Dict[str, str]] = None
-    """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.
+    """
 
     status_reason: Optional[str] = None
     """Status reason"""