chore: add missing docstrings

stainless-app[bot] · stainless-app[bot] · commit 75fa7cb7b954 · 2025-12-09T03:44:10.000Z
diff --git a/src/kernel/types/agents/agent_auth_discover_response.py b/src/kernel/types/agents/agent_auth_discover_response.py
@@ -9,6 +9,8 @@
 
 
 class AgentAuthDiscoverResponse(BaseModel):
+    """Response from discover endpoint matching AuthBlueprint schema"""
+
     success: bool
     """Whether discovery succeeded"""
 
diff --git a/src/kernel/types/agents/agent_auth_invocation_response.py b/src/kernel/types/agents/agent_auth_invocation_response.py
@@ -9,6 +9,8 @@
 
 
 class AgentAuthInvocationResponse(BaseModel):
+    """Response from get invocation endpoint"""
+
     app_name: str
     """App name (org name at time of invocation creation)"""
 
diff --git a/src/kernel/types/agents/agent_auth_submit_response.py b/src/kernel/types/agents/agent_auth_submit_response.py
@@ -9,6 +9,8 @@
 
 
 class AgentAuthSubmitResponse(BaseModel):
+    """Response from submit endpoint matching SubmitResult schema"""
+
     success: bool
     """Whether submission succeeded"""
 
diff --git a/src/kernel/types/agents/auth/invocation_exchange_response.py b/src/kernel/types/agents/auth/invocation_exchange_response.py
@@ -6,6 +6,8 @@
 
 
 class InvocationExchangeResponse(BaseModel):
+    """Response from exchange endpoint"""
+
     invocation_id: str
     """Invocation ID"""
 
diff --git a/src/kernel/types/agents/auth_agent.py b/src/kernel/types/agents/auth_agent.py
@@ -8,6 +8,10 @@
 
 
 class AuthAgent(BaseModel):
+    """
+    An auth agent that manages authentication for a specific domain and profile combination
+    """
+
     id: str
     """Unique identifier for the auth agent"""
 
diff --git a/src/kernel/types/agents/auth_agent_invocation_create_response.py b/src/kernel/types/agents/auth_agent_invocation_create_response.py
@@ -8,6 +8,8 @@
 
 
 class AuthAgentInvocationCreateResponse(BaseModel):
+    """Response from creating an auth agent invocation"""
+
     expires_at: datetime
     """When the handoff code expires"""
 
diff --git a/src/kernel/types/agents/auth_create_params.py b/src/kernel/types/agents/auth_create_params.py
@@ -26,5 +26,7 @@ class AuthCreateParams(TypedDict, total=False):
 
 
 class Proxy(TypedDict, total=False):
+    """Optional proxy configuration"""
+
     proxy_id: str
     """ID of the proxy to use"""
diff --git a/src/kernel/types/agents/discovered_field.py b/src/kernel/types/agents/discovered_field.py
@@ -9,6 +9,8 @@
 
 
 class DiscoveredField(BaseModel):
+    """A discovered form field"""
+
     label: str
     """Field label"""
 
diff --git a/src/kernel/types/app_list_response.py b/src/kernel/types/app_list_response.py
@@ -10,6 +10,8 @@
 
 
 class AppListResponse(BaseModel):
+    """Summary of an application version."""
+
     id: str
     """Unique identifier for the app version"""
 
diff --git a/src/kernel/types/browser_persistence.py b/src/kernel/types/browser_persistence.py
@@ -6,5 +6,7 @@
 
 
 class BrowserPersistence(BaseModel):
+    """DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead."""
+
     id: str
     """DEPRECATED: Unique identifier for the persistent browser session."""
diff --git a/src/kernel/types/browser_persistence_param.py b/src/kernel/types/browser_persistence_param.py
@@ -8,5 +8,7 @@
 
 
 class BrowserPersistenceParam(TypedDict, total=False):
+    """DEPRECATED: Use timeout_seconds (up to 72 hours) and Profiles instead."""
+
     id: Required[str]
     """DEPRECATED: Unique identifier for the persistent browser session."""
diff --git a/src/kernel/types/browser_pool.py b/src/kernel/types/browser_pool.py
@@ -10,6 +10,8 @@
 
 
 class BrowserPool(BaseModel):
+    """A browser pool containing multiple identically configured browsers."""
+
     id: str
     """Unique identifier for the browser pool"""
 
diff --git a/src/kernel/types/browser_pool_request.py b/src/kernel/types/browser_pool_request.py
@@ -11,6 +11,11 @@
 
 
 class BrowserPoolRequest(BaseModel):
+    """Parameters for creating a browser pool.
+
+    All browsers in the pool will be created with the same configuration.
+    """
+
     size: int
     """Number of browsers to create in the pool"""
 
diff --git a/src/kernel/types/browsers/computer_set_cursor_visibility_response.py b/src/kernel/types/browsers/computer_set_cursor_visibility_response.py
@@ -6,5 +6,7 @@
 
 
 class ComputerSetCursorVisibilityResponse(BaseModel):
+    """Generic OK response."""
+
     ok: bool
     """Indicates success."""
diff --git a/src/kernel/types/browsers/fs/watch_events_response.py b/src/kernel/types/browsers/fs/watch_events_response.py
@@ -9,6 +9,8 @@
 
 
 class WatchEventsResponse(BaseModel):
+    """Filesystem change event."""
+
     path: str
     """Absolute path of the file or directory."""
 
diff --git a/src/kernel/types/browsers/playwright_execute_response.py b/src/kernel/types/browsers/playwright_execute_response.py
@@ -8,6 +8,8 @@
 
 
 class PlaywrightExecuteResponse(BaseModel):
+    """Result of Playwright code execution"""
+
     success: bool
     """Whether the code executed successfully"""
 
diff --git a/src/kernel/types/browsers/process_exec_response.py b/src/kernel/types/browsers/process_exec_response.py
@@ -8,6 +8,8 @@
 
 
 class ProcessExecResponse(BaseModel):
+    """Result of a synchronous command execution."""
+
     duration_ms: Optional[int] = None
     """Execution duration in milliseconds."""
 
diff --git a/src/kernel/types/browsers/process_kill_response.py b/src/kernel/types/browsers/process_kill_response.py
@@ -6,5 +6,7 @@
 
 
 class ProcessKillResponse(BaseModel):
+    """Generic OK response."""
+
     ok: bool
     """Indicates success."""
diff --git a/src/kernel/types/browsers/process_spawn_response.py b/src/kernel/types/browsers/process_spawn_response.py
@@ -9,6 +9,8 @@
 
 
 class ProcessSpawnResponse(BaseModel):
+    """Information about a spawned process."""
+
     pid: Optional[int] = None
     """OS process ID."""
 
diff --git a/src/kernel/types/browsers/process_status_response.py b/src/kernel/types/browsers/process_status_response.py
@@ -9,6 +9,8 @@
 
 
 class ProcessStatusResponse(BaseModel):
+    """Current status of a process."""
+
     cpu_pct: Optional[float] = None
     """Estimated CPU usage percentage."""
 
diff --git a/src/kernel/types/browsers/process_stdin_response.py b/src/kernel/types/browsers/process_stdin_response.py
@@ -8,5 +8,7 @@
 
 
 class ProcessStdinResponse(BaseModel):
+    """Result of writing to stdin."""
+
     written_bytes: Optional[int] = None
     """Number of bytes written."""
diff --git a/src/kernel/types/browsers/process_stdout_stream_response.py b/src/kernel/types/browsers/process_stdout_stream_response.py
@@ -9,6 +9,8 @@
 
 
 class ProcessStdoutStreamResponse(BaseModel):
+    """SSE payload representing process output or lifecycle events."""
+
     data_b64: Optional[str] = None
     """Base64-encoded data from the process stream."""
 
diff --git a/src/kernel/types/browsers/replay_list_response.py b/src/kernel/types/browsers/replay_list_response.py
@@ -10,6 +10,8 @@
 
 
 class ReplayListResponseItem(BaseModel):
+    """Information about a browser replay recording."""
+
     replay_id: str
     """Unique identifier for the replay recording."""
 
diff --git a/src/kernel/types/browsers/replay_start_response.py b/src/kernel/types/browsers/replay_start_response.py
@@ -9,6 +9,8 @@
 
 
 class ReplayStartResponse(BaseModel):
+    """Information about a browser replay recording."""
+
     replay_id: str
     """Unique identifier for the replay recording."""
 
diff --git a/src/kernel/types/deployment_create_params.py b/src/kernel/types/deployment_create_params.py
@@ -37,6 +37,8 @@ class DeploymentCreateParams(TypedDict, total=False):
 
 
 class SourceAuth(TypedDict, total=False):
+    """Authentication for private repositories."""
+
     token: Required[str]
     """GitHub PAT or installation access token"""
 
@@ -45,6 +47,8 @@ class SourceAuth(TypedDict, total=False):
 
 
 class Source(TypedDict, total=False):
+    """Source from which to fetch application code."""
+
     entrypoint: Required[str]
     """Relative path to the application entrypoint within the selected path."""
 
diff --git a/src/kernel/types/deployment_create_response.py b/src/kernel/types/deployment_create_response.py
@@ -10,6 +10,8 @@
 
 
 class DeploymentCreateResponse(BaseModel):
+    """Deployment record information."""
+
     id: str
     """Unique identifier for the deployment"""
 
diff --git a/src/kernel/types/deployment_follow_response.py b/src/kernel/types/deployment_follow_response.py
@@ -16,6 +16,8 @@
 
 
 class AppVersionSummaryEvent(BaseModel):
+    """Summary of an application version."""
+
     id: str
     """Unique identifier for the app version"""
 
diff --git a/src/kernel/types/deployment_list_response.py b/src/kernel/types/deployment_list_response.py
@@ -10,6 +10,8 @@
 
 
 class DeploymentListResponse(BaseModel):
+    """Deployment record information."""
+
     id: str
     """Unique identifier for the deployment"""
 
diff --git a/src/kernel/types/deployment_retrieve_response.py b/src/kernel/types/deployment_retrieve_response.py
@@ -10,6 +10,8 @@
 
 
 class DeploymentRetrieveResponse(BaseModel):
+    """Deployment record information."""
+
     id: str
     """Unique identifier for the deployment"""
 
diff --git a/src/kernel/types/deployment_state_event.py b/src/kernel/types/deployment_state_event.py
@@ -10,6 +10,8 @@
 
 
 class Deployment(BaseModel):
+    """Deployment record information."""
+
     id: str
     """Unique identifier for the deployment"""
 
@@ -36,6 +38,8 @@ class Deployment(BaseModel):
 
 
 class DeploymentStateEvent(BaseModel):
+    """An event representing the current state of a deployment."""
+
     deployment: Deployment
     """Deployment record information."""
 
diff --git a/src/kernel/types/extension_list_response.py b/src/kernel/types/extension_list_response.py
@@ -10,6 +10,8 @@
 
 
 class ExtensionListResponseItem(BaseModel):
+    """A browser extension uploaded to Kernel."""
+
     id: str
     """Unique identifier for the extension"""
 
diff --git a/src/kernel/types/extension_upload_response.py b/src/kernel/types/extension_upload_response.py
@@ -9,6 +9,8 @@
 
 
 class ExtensionUploadResponse(BaseModel):
+    """A browser extension uploaded to Kernel."""
+
     id: str
     """Unique identifier for the extension"""
 
diff --git a/src/kernel/types/invocation_state_event.py b/src/kernel/types/invocation_state_event.py
@@ -51,6 +51,8 @@ class Invocation(BaseModel):
 
 
 class InvocationStateEvent(BaseModel):
+    """An event representing the current state of an invocation."""
+
     event: Literal["invocation_state"]
     """Event type identifier (always "invocation_state")."""
 
diff --git a/src/kernel/types/profile.py b/src/kernel/types/profile.py
@@ -9,6 +9,8 @@
 
 
 class Profile(BaseModel):
+    """Browser profile metadata."""
+
     id: str
     """Unique identifier for the profile"""
 
diff --git a/src/kernel/types/proxy_create_params.py b/src/kernel/types/proxy_create_params.py
@@ -35,16 +35,22 @@ class ProxyCreateParams(TypedDict, total=False):
 
 
 class ConfigDatacenterProxyConfig(TypedDict, total=False):
+    """Configuration for a datacenter proxy."""
+
     country: str
     """ISO 3166 country code. Defaults to US if not provided."""
 
 
 class ConfigIspProxyConfig(TypedDict, total=False):
+    """Configuration for an ISP proxy."""
+
     country: str
     """ISO 3166 country code. Defaults to US if not provided."""
 
 
 class ConfigResidentialProxyConfig(TypedDict, total=False):
+    """Configuration for residential proxies."""
+
     asn: str
     """Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html"""
 
@@ -68,6 +74,8 @@ class ConfigResidentialProxyConfig(TypedDict, total=False):
 
 
 class ConfigMobileProxyConfig(TypedDict, total=False):
+    """Configuration for mobile proxies."""
+
     asn: str
     """Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html"""
 
@@ -150,6 +158,8 @@ class ConfigMobileProxyConfig(TypedDict, total=False):
 
 
 class ConfigCreateCustomProxyConfig(TypedDict, total=False):
+    """Configuration for a custom proxy (e.g., private proxy server)."""
+
     host: Required[str]
     """Proxy host address or IP."""
 
diff --git a/src/kernel/types/proxy_create_response.py b/src/kernel/types/proxy_create_response.py
diff --git a/src/kernel/types/proxy_list_response.py b/src/kernel/types/proxy_list_response.py
diff --git a/src/kernel/types/proxy_retrieve_response.py b/src/kernel/types/proxy_retrieve_response.py
diff --git a/src/kernel/types/shared/app_action.py b/src/kernel/types/shared/app_action.py
diff --git a/src/kernel/types/shared/browser_extension.py b/src/kernel/types/shared/browser_extension.py
diff --git a/src/kernel/types/shared/browser_profile.py b/src/kernel/types/shared/browser_profile.py
diff --git a/src/kernel/types/shared/browser_viewport.py b/src/kernel/types/shared/browser_viewport.py
diff --git a/src/kernel/types/shared/error_event.py b/src/kernel/types/shared/error_event.py
diff --git a/src/kernel/types/shared/heartbeat_event.py b/src/kernel/types/shared/heartbeat_event.py
diff --git a/src/kernel/types/shared/log_event.py b/src/kernel/types/shared/log_event.py
diff --git a/src/kernel/types/shared_params/browser_extension.py b/src/kernel/types/shared_params/browser_extension.py
diff --git a/src/kernel/types/shared_params/browser_profile.py b/src/kernel/types/shared_params/browser_profile.py
diff --git a/src/kernel/types/shared_params/browser_viewport.py b/src/kernel/types/shared_params/browser_viewport.py
