kubiya-control-plane-api 0.9.15__py3-none-any.whl

control_plane_api/app/schemas/template_schemas.py

@@ -0,0 +1,133 @@
+"""
+Pydantic schemas for template API endpoints.
+
+Defines request and response models for template compilation and validation.
+"""
+
+from pydantic import BaseModel, Field
+from typing import Dict, List, Any, Optional
+
+
+class TemplateVariableSchema(BaseModel):
+    """Schema for a template variable."""
+    name: str = Field(..., description="Variable name (e.g., 'api_key' or 'secret.github_token')")
+    type: str = Field(..., description="Variable type: 'simple', 'secret', or 'env'")
+    raw: str = Field(..., description="Raw template string (e.g., '{{.secret.api_key}}')")
+    start: int = Field(..., description="Start position in template")
+    end: int = Field(..., description="End position in template")
+    display_name: str = Field(..., description="Display name without type prefix")
+
+
+class ValidationErrorSchema(BaseModel):
+    """Schema for a validation error."""
+    message: str = Field(..., description="Human-readable error message")
+    variable: Optional[TemplateVariableSchema] = Field(None, description="Variable that caused the error")
+    position: Optional[int] = Field(None, description="Character position in template")
+    code: Optional[str] = Field(None, description="Machine-readable error code")
+
+
+class TemplateCompileRequest(BaseModel):
+    """Request schema for template compilation endpoint."""
+    template: str = Field(..., description="Template string with {{variable}} syntax", min_length=1)
+    context: Optional[Dict[str, Any]] = Field(
+        default_factory=dict,
+        description="Context for compilation (variables, secrets, env_vars)"
+    )
+    validate_only: bool = Field(
+        False,
+        description="Only validate syntax without compiling"
+    )
+    environment_id: Optional[str] = Field(
+        None,
+        description="Environment ID for secret validation"
+    )
+
+    class Config:
+        json_schema_extra = {
+            "example": {
+                "template": "http://api.example.com:{{.env.PORT}}/auth?key={{.secret.api_key}}",
+                "context": {
+                    "variables": {},
+                    "secrets": {"api_key": "secret-value"},
+                    "env_vars": {"PORT": "8080"}
+                },
+                "validate_only": False,
+                "environment_id": "env-123"
+            }
+        }
+
+
+class TemplateCompileResponse(BaseModel):
+    """Response schema for template compilation endpoint."""
+    valid: bool = Field(..., description="Whether the template is valid")
+    compiled: Optional[str] = Field(None, description="Compiled template (if valid and context provided)")
+    variables: List[TemplateVariableSchema] = Field(default_factory=list, description="Variables found in template")
+    errors: List[ValidationErrorSchema] = Field(default_factory=list, description="Validation/compilation errors")
+    warnings: List[str] = Field(default_factory=list, description="Non-fatal warnings")
+
+    class Config:
+        json_schema_extra = {
+            "example": {
+                "valid": True,
+                "compiled": "http://api.example.com:8080/auth?key=secret-value",
+                "variables": [
+                    {
+                        "name": "env.PORT",
+                        "type": "env",
+                        "raw": "{{.env.PORT}}",
+                        "start": 25,
+                        "end": 38,
+                        "display_name": "PORT"
+                    },
+                    {
+                        "name": "secret.api_key",
+                        "type": "secret",
+                        "raw": "{{.secret.api_key}}",
+                        "start": 48,
+                        "end": 68,
+                        "display_name": "api_key"
+                    }
+                ],
+                "errors": [],
+                "warnings": []
+            }
+        }
+
+
+class TemplateExtractVariablesRequest(BaseModel):
+    """Request schema for extracting variables from a template."""
+    template: str = Field(..., description="Template string to analyze", min_length=1)
+
+    class Config:
+        json_schema_extra = {
+            "example": {
+                "template": "User {{user}} accessing {{.secret.database}} on {{.env.HOST}}"
+            }
+        }
+
+
+class TemplateExtractVariablesResponse(BaseModel):
+    """Response schema for variable extraction endpoint."""
+    variables: List[TemplateVariableSchema] = Field(..., description="All variables found in template")
+    secrets: List[str] = Field(default_factory=list, description="Secret names required")
+    env_vars: List[str] = Field(default_factory=list, description="Environment variable names required")
+    simple_vars: List[str] = Field(default_factory=list, description="Simple variable names required")
+
+    class Config:
+        json_schema_extra = {
+            "example": {
+                "variables": [
+                    {
+                        "name": "user",
+                        "type": "simple",
+                        "raw": "{{user}}",
+                        "start": 5,
+                        "end": 13,
+                        "display_name": "user"
+                    }
+                ],
+                "secrets": ["database"],
+                "env_vars": ["HOST"],
+                "simple_vars": ["user"]
+            }
+        }

control_plane_api/app/schemas/trace_schemas.py

@@ -0,0 +1,168 @@
+"""
+Pydantic schemas for trace API endpoints.
+
+These schemas define the request/response models for the traces REST API.
+"""
+
+from pydantic import BaseModel, Field
+from typing import Optional, List, Dict, Any
+from datetime import datetime
+from enum import Enum
+
+
+class TraceStatus(str, Enum):
+    """Trace status enum"""
+    SUCCESS = "success"
+    ERROR = "error"
+    RUNNING = "running"
+
+
+class SpanKind(str, Enum):
+    """OTEL span kind enum"""
+    INTERNAL = "INTERNAL"
+    SERVER = "SERVER"
+    CLIENT = "CLIENT"
+    PRODUCER = "PRODUCER"
+    CONSUMER = "CONSUMER"
+
+
+class SpanStatusCode(str, Enum):
+    """OTEL span status code enum"""
+    UNSET = "UNSET"
+    OK = "OK"
+    ERROR = "ERROR"
+
+
+# Response schemas
+
+class SpanResponse(BaseModel):
+    """Span response schema"""
+    id: str
+    trace_id: str
+    span_id: str
+    parent_span_id: Optional[str] = None
+    organization_id: str
+    name: str
+    kind: SpanKind
+    status_code: SpanStatusCode
+    status_message: Optional[str] = None
+    start_time_unix_nano: int
+    end_time_unix_nano: Optional[int] = None
+    duration_ns: Optional[int] = None
+    duration_ms: Optional[float] = None
+    attributes: Dict[str, Any] = Field(default_factory=dict)
+    resource_attributes: Dict[str, Any] = Field(default_factory=dict)
+    events: List[Dict[str, Any]] = Field(default_factory=list)
+    links: List[Dict[str, Any]] = Field(default_factory=list)
+    created_at: datetime
+
+    # Nested children for tree structure
+    children: List["SpanResponse"] = Field(default_factory=list)
+
+    class Config:
+        from_attributes = True
+
+
+class TraceListItem(BaseModel):
+    """Trace list item for list view"""
+    id: str
+    trace_id: str
+    organization_id: str
+    name: str
+    service_name: Optional[str] = None
+    status: TraceStatus
+    execution_id: Optional[str] = None
+    execution_type: Optional[str] = None
+    user_id: Optional[str] = None
+    user_email: Optional[str] = None
+    user_name: Optional[str] = None
+    user_avatar: Optional[str] = None
+    started_at: datetime
+    ended_at: Optional[datetime] = None
+    duration_ms: Optional[int] = None
+    span_count: int = 0
+    error_count: int = 0
+    created_at: datetime
+    updated_at: Optional[datetime] = None
+
+    class Config:
+        from_attributes = True
+
+
+class TraceDetailResponse(BaseModel):
+    """Detailed trace response with spans"""
+    id: str
+    trace_id: str
+    organization_id: str
+    name: str
+    service_name: Optional[str] = None
+    status: TraceStatus
+    execution_id: Optional[str] = None
+    execution_type: Optional[str] = None
+    user_id: Optional[str] = None
+    user_email: Optional[str] = None
+    user_name: Optional[str] = None
+    user_avatar: Optional[str] = None
+    started_at: datetime
+    ended_at: Optional[datetime] = None
+    duration_ms: Optional[int] = None
+    span_count: int = 0
+    error_count: int = 0
+    created_at: datetime
+    updated_at: Optional[datetime] = None
+
+    # Spans as tree structure (root spans with nested children)
+    spans: List[SpanResponse] = Field(default_factory=list)
+
+    class Config:
+        from_attributes = True
+
+
+class TraceListResponse(BaseModel):
+    """Paginated trace list response"""
+    items: List[TraceListItem]
+    total: int
+    page: int
+    page_size: int
+    total_pages: int
+    has_next: bool
+    has_previous: bool
+
+
+class TraceStatsResponse(BaseModel):
+    """Trace statistics response"""
+    total_traces: int
+    success_count: int
+    error_count: int
+    running_count: int
+    error_rate: float
+    avg_duration_ms: Optional[float] = None
+    total_spans: int
+    # Stats by time period
+    period_start: Optional[datetime] = None
+    period_end: Optional[datetime] = None
+
+
+class DeleteTraceResponse(BaseModel):
+    """Delete trace response"""
+    trace_id: str
+    deleted: bool
+    message: str
+
+
+# Request/Query schemas
+
+class TraceFilters(BaseModel):
+    """Query filters for trace list"""
+    status: Optional[TraceStatus] = None
+    time_from: Optional[datetime] = None
+    time_to: Optional[datetime] = None
+    search: Optional[str] = None
+    execution_id: Optional[str] = None
+    service_name: Optional[str] = None
+    user_id: Optional[str] = None
+    has_errors: Optional[bool] = None
+
+
+# Allow forward references for self-referencing SpanResponse
+SpanResponse.model_rebuild()

control_plane_api/app/schemas/worker_queue_observability_schemas.py

@@ -0,0 +1,165 @@
+"""
+Pydantic schemas for Worker Queue Observability API.
+
+This module defines request/response schemas for worker queue metrics,
+workflow tracking, and activity tracing.
+"""
+
+from pydantic import BaseModel, Field
+from typing import Optional, List, Dict, Any
+from datetime import datetime
+
+
+class WorkerQueueMetricsResponse(BaseModel):
+    """Comprehensive metrics for a worker queue"""
+    queue_id: str = Field(..., description="Worker queue UUID")
+
+    # Worker Health
+    active_workers: int = Field(..., description="Number of active workers")
+    idle_workers: int = Field(..., description="Number of idle workers")
+    busy_workers: int = Field(..., description="Number of busy workers")
+    total_workers: int = Field(..., description="Total number of workers")
+
+    # Task Metrics (24h window)
+    tasks_processed_24h: int = Field(..., description="Tasks completed in last 24 hours")
+    tasks_failed_24h: int = Field(..., description="Tasks failed in last 24 hours")
+    tasks_pending: int = Field(..., description="Tasks currently pending")
+    avg_task_duration_ms: float = Field(..., description="Average task duration in milliseconds")
+
+    # Error Tracking
+    error_rate_percent: float = Field(..., description="Error rate percentage")
+    last_error_at: Optional[datetime] = Field(None, description="Timestamp of last error")
+
+    # Temporal Queue Metrics
+    task_queue_backlog: int = Field(0, description="Number of tasks in backlog")
+    task_queue_pollers: int = Field(0, description="Number of active pollers")
+
+    # Timing
+    last_activity_at: Optional[datetime] = Field(None, description="Last activity timestamp")
+    updated_at: datetime = Field(..., description="Metrics update timestamp")
+
+
+class WorkflowListItem(BaseModel):
+    """Workflow list item for queue workflows"""
+    workflow_id: str = Field(..., description="Temporal workflow ID")
+    run_id: str = Field(..., description="Temporal run ID")
+    task_queue: str = Field(..., description="Task queue name")
+    worker_id: Optional[str] = Field(None, description="Worker ID processing this workflow")
+    status: str = Field(..., description="Workflow status")
+    execution_id: str = Field(..., description="Execution entity ID")
+    started_at: Optional[datetime] = Field(None, description="Workflow start time")
+    close_time: Optional[datetime] = Field(None, description="Workflow completion time")
+    workflow_type: str = Field(..., description="Workflow type")
+    attempt: int = Field(1, description="Execution attempt number")
+    history_length: int = Field(0, description="Workflow history event count")
+
+
+class WorkflowsListResponse(BaseModel):
+    """Response for list queue workflows"""
+    workflows: List[WorkflowListItem] = Field(..., description="List of workflows")
+    total: int = Field(..., description="Total number of workflows")
+    pending_count: int = Field(0, description="Number of pending workflows")
+    running_count: int = Field(0, description="Number of running workflows")
+    completed_count: int = Field(0, description="Number of completed workflows")
+    failed_count: int = Field(0, description="Number of failed workflows")
+
+
+class WorkflowEvent(BaseModel):
+    """Individual workflow history event"""
+    event_id: int = Field(..., description="Event ID")
+    event_type: str = Field(..., description="Event type")
+    event_time: datetime = Field(..., description="Event timestamp")
+    details: Dict[str, Any] = Field(default_factory=dict, description="Event details")
+
+
+class ActivityExecution(BaseModel):
+    """Individual activity execution within a workflow"""
+    activity_id: str = Field(..., description="Activity ID")
+    activity_type: str = Field(..., description="Activity type/name")
+    status: str = Field(..., description="Activity status: scheduled, started, completed, failed, timed_out")
+    scheduled_time: datetime = Field(..., description="Activity scheduled timestamp")
+    started_time: Optional[datetime] = Field(None, description="Activity start timestamp")
+    completed_time: Optional[datetime] = Field(None, description="Activity completion timestamp")
+    duration_ms: Optional[float] = Field(None, description="Activity duration in milliseconds")
+    attempt: int = Field(1, description="Attempt number")
+    worker_identity: Optional[str] = Field(None, description="Worker that executed this activity")
+    failure_message: Optional[str] = Field(None, description="Failure message if activity failed")
+    input: Optional[Dict[str, Any]] = Field(None, description="Activity input data")
+    result: Optional[Dict[str, Any]] = Field(None, description="Activity result data")
+
+
+class WorkflowTrace(BaseModel):
+    """Execution trace with activities and timeline"""
+    activities: List[ActivityExecution] = Field(..., description="List of activity executions")
+    timeline: List[Dict[str, Any]] = Field(..., description="Timeline events for visualization")
+    total_activities: int = Field(..., description="Total number of activities")
+    completed_activities: int = Field(0, description="Number of completed activities")
+    failed_activities: int = Field(0, description="Number of failed activities")
+
+
+class WorkflowDetailsResponse(BaseModel):
+    """Detailed workflow information"""
+    workflow_id: str = Field(..., description="Temporal workflow ID")
+    run_id: str = Field(..., description="Temporal run ID")
+    status: str = Field(..., description="Workflow status")
+
+    # Execution Info
+    execution_id: str = Field(..., description="Execution entity ID")
+    execution_status: str = Field(..., description="Execution status from DB")
+
+    # Timing
+    start_time: Optional[datetime] = Field(None, description="Workflow start time")
+    close_time: Optional[datetime] = Field(None, description="Workflow close time")
+    execution_duration_ms: float = Field(0, description="Execution duration in milliseconds")
+
+    # Temporal Details
+    task_queue: str = Field(..., description="Task queue name")
+    workflow_type: str = Field(..., description="Workflow type")
+    attempt: int = Field(1, description="Execution attempt number")
+    history_length: int = Field(0, description="History event count")
+    history_size_bytes: int = Field(0, description="History size in bytes")
+
+    # Input
+    input: Optional[Dict[str, Any]] = Field(None, description="Workflow input data")
+
+    # Links
+    temporal_web_url: str = Field(..., description="Temporal Web UI URL")
+
+    # Events and Trace
+    recent_events: List[WorkflowEvent] = Field(default_factory=list, description="Recent workflow events")
+    trace: WorkflowTrace = Field(..., description="Workflow execution trace")
+
+
+class TerminateWorkflowRequest(BaseModel):
+    """Request to terminate a running workflow"""
+    reason: str = Field(..., min_length=1, max_length=500, description="Termination reason")
+
+
+class TerminateWorkflowResponse(BaseModel):
+    """Response after terminating a workflow"""
+    success: bool = Field(..., description="Whether termination was successful")
+    workflow_id: str = Field(..., description="Workflow ID that was terminated")
+    terminated_at: datetime = Field(..., description="Termination timestamp")
+
+
+class BatchTerminateRequest(BaseModel):
+    """Request to terminate multiple executions"""
+    execution_ids: List[str] = Field(..., min_length=1, max_length=100, description="List of execution IDs to terminate")
+    reason: str = Field(..., min_length=1, max_length=500, description="Termination reason")
+
+
+class BatchTerminateResult(BaseModel):
+    """Result for a single execution in batch termination"""
+    execution_id: str = Field(..., description="Execution ID")
+    success: bool = Field(..., description="Whether termination was successful")
+    workflow_id: Optional[str] = Field(None, description="Workflow ID if successful")
+    error: Optional[str] = Field(None, description="Error message if failed")
+    terminated_at: Optional[datetime] = Field(None, description="Termination timestamp if successful")
+
+
+class BatchTerminateResponse(BaseModel):
+    """Response after batch terminating executions"""
+    total_requested: int = Field(..., description="Total number of executions requested for termination")
+    total_succeeded: int = Field(..., description="Number of successfully terminated executions")
+    total_failed: int = Field(..., description="Number of failed terminations")
+    results: List[BatchTerminateResult] = Field(..., description="Results for each execution")

control_plane_api/app/services/__init__.py

@@ -0,0 +1 @@
+# Services