first commit

docs/openapi/schemas/management/config.yaml

@@ -0,0 +1,200 @@
+# Config API schemas
+
+Version:
+  type: string
+  description: Version information
+  example: "1.0.0"
+
+ClientConfig:
+  type: object
+  description: Client configuration
+  properties:
+    drop_excess_requests:
+      type: boolean
+      description: Whether to drop excess requests when rate limited
+    prometheus_labels:
+      type: array
+      items:
+        type: string
+      description: Custom Prometheus labels
+    allowed_origins:
+      type: array
+      items:
+        type: string
+      description: Allowed CORS origins
+    initial_pool_size:
+      type: integer
+      description: Initial connection pool size
+    enable_logging:
+      type: boolean
+      description: Whether logging is enabled
+    disable_content_logging:
+      type: boolean
+      description: Whether content logging is disabled
+    enforce_auth_on_inference:
+      type: boolean
+      description: Whether to enforce virtual key authentication on inference requests
+    enforce_governance_header:
+      type: boolean
+      deprecated: true
+      description: "Deprecated: use enforce_auth_on_inference instead"
+    allow_direct_keys:
+      type: boolean
+      description: Whether to allow direct API keys
+    max_request_body_size_mb:
+      type: integer
+      description: Maximum request body size in MB
+    compat:
+      type: object
+      description: Compat plugin configuration
+      properties:
+        convert_text_to_chat:
+          type: boolean
+          description: Convert text completion requests to chat
+        convert_chat_to_responses:
+          type: boolean
+          description: Convert chat completion requests to responses
+        should_drop_params:
+          type: boolean
+          description: Drop unsupported parameters based on model catalog
+        should_convert_params:
+          type: boolean
+          default: false
+          description: Converts model parameter values that are not supported by the model
+      additionalProperties: false
+    log_retention_days:
+      type: integer
+      description: Number of days to retain logs
+    header_filter_config:
+      $ref: '#/HeaderFilterConfig'
+    mcp_agent_depth:
+      type: integer
+      description: Depth of MCP agent
+    mcp_tool_execution_timeout:
+      type: integer
+      description: Timeout for MCP tool execution in seconds
+    mcp_code_mode_binding_level:
+      type: string
+      description: Binding level for MCP code mode
+    required_headers:
+      type: array
+      items:
+        type: string
+      description: Headers that must be present on every request. Requests missing any of these headers are rejected with 400. Case-insensitive matching.
+    logging_headers:
+      type: array
+      items:
+        type: string
+      description: Headers to capture in log metadata. Values are extracted from incoming requests and stored in the metadata field of log entries. Case-insensitive matching. No restart required.
+
+FrameworkConfig:
+  type: object
+  description: Framework configuration
+  properties:
+    id:
+      type: integer
+      description: Unique identifier for the framework config
+    pricing_url:
+      type: string
+      description: URL for pricing data
+    pricing_sync_interval:
+      type: integer
+      format: int64
+      description: Pricing sync interval in seconds
+
+AuthConfig:
+  type: object
+  description: Authentication configuration
+  properties:
+    admin_username:
+      type: string
+    admin_password:
+      type: string
+      description: Password (redacted as <redacted> in responses)
+    is_enabled:
+      type: boolean
+    disable_auth_on_inference:
+      type: boolean
+
+HeaderFilterConfig:
+  type: object
+  description: Header filter configuration
+  properties:
+    allowlist:
+      type: array
+      items:
+        type: string
+    denylist:
+      type: array
+      items:
+        type: string
+
+ProxyConfig:
+  type: object
+  description: Global proxy configuration
+  properties:
+    enabled:
+      type: boolean
+    type:
+      type: string
+      enum: [http, socks5, tcp]
+    url:
+      type: string
+    username:
+      type: string
+    password:
+      type: string
+      description: Password (redacted as <redacted> in responses)
+    no_proxy:
+      type: string
+    timeout:
+      type: integer
+    skip_tls_verify:
+      type: boolean
+    enable_for_scim:
+      type: boolean
+    enable_for_inference:
+      type: boolean
+    enable_for_api:
+      type: boolean
+
+RestartRequiredConfig:
+  type: object
+  description: Restart required configuration
+  properties:
+    required:
+      type: boolean
+    reason:
+      type: string
+
+GetConfigResponse:
+  type: object
+  description: Configuration response
+  properties:
+    client_config:
+      $ref: '#/ClientConfig'
+    framework_config:
+      $ref: '#/FrameworkConfig'
+    auth_config:
+      $ref: '#/AuthConfig'
+    is_db_connected:
+      type: boolean
+    is_cache_connected:
+      type: boolean
+    is_logs_connected:
+      type: boolean
+    proxy_config:
+      $ref: '#/ProxyConfig'
+    restart_required:
+      $ref: '#/RestartRequiredConfig'
+
+UpdateConfigRequest:
+  type: object
+  description: Update configuration request
+  properties:
+    client_config:
+      $ref: '#/ClientConfig'
+    framework_config:
+      $ref: '#/FrameworkConfig'
+    auth_config:
+      $ref: '#/AuthConfig'