{ "openapi": "3.0.3", "info": { "title": "Ai Services", "description": "Query handling through inference routing with production and test modes. Positive and negative quality markers with detailed categorization capture assistant performance. Streaming connections support authenticated access, subscription lifecycles, and feature flags. IP provisioning services allocate infrastructure resources for model workloads across distributed systems.", "version": "8.0.2", "contact": { "name": "F5 Distributed Cloud", "url": "https://docs.cloud.f5.com" }, "license": { "name": "Proprietary", "url": "https://www.f5.com/company/policies/eula" }, "x-f5xc-description-long": "Query handling through inference routing with production and test modes. Positive and negative quality markers with detailed categorization capture assistant performance. Streaming connections support authenticated access, subscription lifecycles, and feature flags. IP provisioning services allocate infrastructure resources for model workloads across distributed systems.", "x-f5xc-summary": "Natural language processing with quality signals and anomaly monitoring. Token authentication for data stream subscriptions.", "x-f5xc-cli-domain": "ai_services", "externalDocs": { "url": "https://docs.cloud.f5.com/docs/how-to/ai-assistant", "description": "F5 XC Documentation - AI Features" }, "x-f5xc-api-reference-url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ai_services/", "x-f5xc-best-practices": { "common_errors": [ { "code": 400, "message": "Invalid request body", "resolution": "Validate JSON structure and required fields before submission", "prevention": "Use schema validation from OpenAPI spec" }, { "code": 401, "message": "Authentication failed", "resolution": "Verify API token is valid and not expired", "prevention": "Use environment variables for token management" }, { "code": 403, "message": "Permission denied", "resolution": "Check user role and namespace permissions", "prevention": "Verify RBAC policies before operations" }, { "code": 404, "message": "Resource not found", "resolution": "Verify resource name and namespace exist", "prevention": "List resources before attempting operations" }, { "code": 409, "message": "Resource already exists", "resolution": "Use unique name or delete existing resource", "prevention": "Check existence before creation" }, { "code": 429, "message": "Rate limit exceeded", "resolution": "Implement exponential backoff and retry logic", "prevention": "Batch operations and add delays between requests" } ], "security_notes": [ "Always use HTTPS for all API communications", "Store API tokens securely, never in source code", "Rotate API tokens regularly following security policies" ], "performance_tips": [ "Use pagination for large result sets", "Batch related operations when possible", "Cache read-only responses appropriately" ] }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "servers": [ { "url": "https://{tenant}.{console_url}/api/v1/{domain_prefix}/{environment}/{region}/namespaces/{namespace}", "description": "F5 Distributed Cloud Console", "variables": { "tenant": { "default": "example-corp", "description": "F5 Distributed Cloud tenant identifier (e.g., example-corp, example-partners)" }, "console_url": { "default": "console.ves.volterra.io", "description": "Console URL base (e.g., console.ves.volterra.io for production, staging.volterra.us for staging)", "enum": [ "console.ves.volterra.io", "staging.volterra.us" ] }, "environment": { "default": "production", "description": "Environment designation (production, staging, development)", "enum": [ "production", "staging", "development" ] }, "domain_prefix": { "default": "api", "description": "Domain naming prefix for consistent naming conventions" }, "region": { "default": "us-east-1", "description": "Geographic region for API deployment (e.g., us-east-1, eu-west-1)" }, "namespace": { "default": "default", "description": "Kubernetes-style namespace for environment separation (e.g., 'default', 'production', 'staging')" } } } ], "security": [ { "ApiToken": [] } ], "tags": [ { "name": "ai_data" }, { "name": "gen-ai" }, { "name": "gia" } ], "paths": { "/api/gen-ai/namespaces/{namespace}/eval_query": { "post": { "summary": "Eval AI Assistant Query.", "description": "Temporarily to be used in place of AIAssistantQuery for evaluating API access/RBAC check.", "operationId": "ves.io.schema.ai_assistant.SahayaAPI.EvalAIAssistantQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemaEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace of the HTTP Load Balancer for current request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai_assistantAIAssistantQueryRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ai_services/" }, "x-ves-proto-rpc": "ves.io.schema.ai_assistant.SahayaAPI.EvalAIAssistantQuery", "tags": [ "gen-ai" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Eval-query resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "eval-query" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "eval-query" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "AI Assistant APIs.", "x-ves-proto-service": "ves.io.schema.ai_assistant.SahayaAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/gen-ai/namespaces/{namespace}/eval_query_feedback": { "post": { "summary": "Eval Feedback of AI Assistant Query.", "description": "Temporarily to be used in place of AIAssistantFeedback for evaluating API access/RBAC check.", "operationId": "ves.io.schema.ai_assistant.SahayaAPI.EvalAIAssistantFeedback", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemaEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace of the HTTP Load Balancer for current request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai_assistantAIAssistantQueryFeedbackRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ai_services/" }, "x-ves-proto-rpc": "ves.io.schema.ai_assistant.SahayaAPI.EvalAIAssistantFeedback", "tags": [ "gen-ai" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Eval-query-feedback resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "eval-query-feedback" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "eval-query-feedback" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "AI Assistant APIs.", "x-ves-proto-service": "ves.io.schema.ai_assistant.SahayaAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/gen-ai/namespaces/{namespace}/query": { "post": { "summary": "AI Assistant Query.", "description": "Enable service by returning service account details.", "operationId": "ves.io.schema.ai_assistant.SahayaAPI.AIAssistantQuery", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai_assistantAIAssistantQueryResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace of the HTTP Load Balancer for current request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai_assistantAIAssistantQueryRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ai_services/" }, "x-ves-proto-rpc": "ves.io.schema.ai_assistant.SahayaAPI.AIAssistantQuery", "tags": [ "gen-ai" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Query resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "query" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "query" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "AI Assistant APIs.", "x-ves-proto-service": "ves.io.schema.ai_assistant.SahayaAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/gen-ai/namespaces/{namespace}/query_feedback": { "post": { "summary": "Feedback of AI Assistant Query.", "description": "Enable service by returning service account details.", "operationId": "ves.io.schema.ai_assistant.SahayaAPI.AIAssistantFeedback", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemaEmpty" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "parameters": [ { "name": "namespace", "description": "Namespace\nNamespace of the HTTP Load Balancer for current request.", "in": "path", "required": true, "x-displayname": "Namespace", "schema": { "type": "string" }, "x-f5xc-example": "system" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ai_assistantAIAssistantQueryFeedbackRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ai_services/" }, "x-ves-proto-rpc": "ves.io.schema.ai_assistant.SahayaAPI.AIAssistantFeedback", "tags": [ "gen-ai" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Query-feedback resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "query-feedback" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "query-feedback" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "AI Assistant APIs.", "x-ves-proto-service": "ves.io.schema.ai_assistant.SahayaAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/ai_data/bfdp/namespaces/system/bfdp/enable_feature": { "post": { "summary": "Enable feature.", "description": "Enable service by returning service account details.", "operationId": "ves.io.schema.ai_data.bfdp.CustomAPI.EnableFeature", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bfdpEnableFeatureResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bfdpEnableFeatureRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ai_services/" }, "x-ves-deprecated": "Use Subscribe API", "x-ves-proto-rpc": "ves.io.schema.ai_data.bfdp.CustomAPI.EnableFeature", "tags": [ "ai_data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Enable-feature resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "enable-feature" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "enable-feature" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BFDP APIs", "x-ves-proto-service": "ves.io.schema.ai_data.bfdp.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/ai_data/bfdp/namespaces/system/bfdp/refresh_token": { "post": { "summary": "Refresh Token.", "description": "Enable service by returning service account details.", "operationId": "ves.io.schema.ai_data.bfdp.CustomAPI.RefreshToken", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bfdpRefreshTokenResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bfdpRefreshTokenRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ai_services/" }, "x-ves-proto-rpc": "ves.io.schema.ai_data.bfdp.CustomAPI.RefreshToken", "tags": [ "ai_data" ], "x-f5xc-operation-metadata": { "purpose": "Authentication credential for access control", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Refresh-token resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "refresh-token" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "refresh-token" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BFDP APIs", "x-ves-proto-service": "ves.io.schema.ai_data.bfdp.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/ai_data/bfdp/namespaces/system/bfdp/gettoken": { "post": { "summary": "Subscribe to BFDP pipeline.", "description": "Subscribe to BFDP pipeline.", "operationId": "ves.io.schema.ai_data.bfdp.subscription.CustomAPI.GetToken", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionTokenResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionTokenRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ai_services/" }, "x-ves-proto-rpc": "ves.io.schema.ai_data.bfdp.subscription.CustomAPI.GetToken", "tags": [ "ai_data" ], "x-f5xc-operation-metadata": { "purpose": "Authentication credential for access control", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Gettoken resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "gettoken" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "gettoken" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BFDP Subscription API.", "x-ves-proto-service": "ves.io.schema.ai_data.bfdp.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/ai_data/bfdp/namespaces/system/bfdp/subscribe": { "post": { "summary": "Subscribe to BFDP pipeline.", "description": "Subscribe to BFDP pipeline.", "operationId": "ves.io.schema.ai_data.bfdp.subscription.CustomAPI.Subscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeResponse__ves_io_schema_ai_data_bfdp_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionSubscribeRequest__ves_io_schema_ai_data_bfdp_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ai_services/" }, "x-ves-proto-rpc": "ves.io.schema.ai_data.bfdp.subscription.CustomAPI.Subscribe", "tags": [ "ai_data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Subscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "subscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "subscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BFDP Subscription API.", "x-ves-proto-service": "ves.io.schema.ai_data.bfdp.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/ai_data/bfdp/namespaces/system/bfdp/unsubscribe": { "post": { "summary": "Unsubscribe to BFDP pipeline.", "description": "Unsubscribe to BFDP pipeline.", "operationId": "ves.io.schema.ai_data.bfdp.subscription.CustomAPI.Unsubscribe", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeResponse__ves_io_schema_ai_data_bfdp_subscription" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscriptionUnsubscribeRequest__ves_io_schema_ai_data_bfdp_subscription" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ai_services/" }, "x-ves-proto-rpc": "ves.io.schema.ai_data.bfdp.subscription.CustomAPI.Unsubscribe", "tags": [ "ai_data" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Unsubscribe resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "unsubscribe" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "unsubscribe" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "BFDP Subscription API.", "x-ves-proto-service": "ves.io.schema.ai_data.bfdp.subscription.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/gia/gia/allocateip": { "post": { "summary": "Allocate IP through Global IP Allocator.", "description": "AllocateIP will allocate an IP address for the tenant read from context.", "operationId": "ves.io.schema.gia.CustomAPI.AllocateIP", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/giaAllocateIPResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/giaAllocateIPRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ai_services/" }, "x-ves-proto-rpc": "ves.io.schema.gia.CustomAPI.AllocateIP", "tags": [ "gia" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Allocateip resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "allocateip" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "allocateip" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Global IP Allocator.", "x-ves-proto-service": "ves.io.schema.gia.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" }, "/api/gia/gia/deallocateip": { "delete": { "summary": "Deallocate IP through Global IP Allocator.", "description": "DeallocateIP will de-allocate the specified IP address for tenant.", "operationId": "ves.io.schema.gia.CustomAPI.DeallocateIP", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/giaDeallocateIPResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "504": { "description": "Returned when server timed out processing request.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/giaDeallocateIPRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/ai_services/" }, "x-ves-proto-rpc": "ves.io.schema.gia.CustomAPI.DeallocateIP", "tags": [ "gia" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [], "postconditions": [ "Resource removed from system" ] }, "side_effects": { "deletes": [ "deallocateip" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "deallocateip" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Global IP Allocator.", "x-ves-proto-service": "ves.io.schema.gia.CustomAPI", "x-ves-proto-service-type": "CUSTOM_PUBLIC" } }, "components": { "securitySchemes": { "ApiToken": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "API Token authentication. Format: 'APIToken '" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "F5 XC API Token (format: APIToken )" } }, "schemas": { "ai_assistantAIAssistantQueryFeedbackRequest": { "type": "object", "description": "AI Assistant Query Feedback Request.", "title": "AI Assistant Query Feedback Request", "x-displayname": "AI Assistant Query Feedback Request.", "x-ves-oneof-field-feedback_choice": "[\"negative_feedback\",\"positive_feedback\"]", "x-ves-proto-message": "ves.io.schema.ai_assistant.AIAssistantQueryFeedbackRequest", "properties": { "comment": { "type": "string", "description": "Configuration parameter for comment", "title": "comment", "maxLength": 4096, "x-displayname": "Comment", "x-ves-example": "Response is biased.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "4096" }, "x-f5xc-example": "Response is biased", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "4096" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 4096, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace of the HTTP Load Balancer for current request.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-f5xc-example": "system", "x-f5xc-description-short": "Namespace of the HTTP Load Balancer for current request.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "negative_feedback": { "allOf": [ { "$ref": "#/components/schemas/ai_assistantNegativeFeedbackDetails" } ], "x-f5xc-description-short": "Configuration parameter for negative feedback.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "positive_feedback" ] }, "positive_feedback": { "allOf": [ { "$ref": "#/components/schemas/schemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for positive feedback.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "negative_feedback" ] }, "query": { "type": "string", "description": "Query will be in text format.", "title": "query", "x-displayname": "Query", "x-ves-example": "How to investigate request log.", "x-f5xc-example": "How to investigate request log", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "maxLength": 1024, "minLength": 0, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "query_id": { "type": "string", "description": "Query Identifier.", "title": "query_id", "x-displayname": "Query ID", "x-ves-example": "00000000-0000-4000-8000-f44fac7dd7bf.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$" }, "x-f5xc-example": "00000000-0000-4000-8000-f44fac7dd7bf", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ai_assistantAIAssistantQueryFeedbackRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ai_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "ai_assistantAIAssistantQueryRequest": { "type": "object", "description": "AI Assistant Query Request.", "title": "AI Assistant Query Request", "x-displayname": "AI Assistant Query Request.", "x-ves-proto-message": "ves.io.schema.ai_assistant.AIAssistantQueryRequest", "properties": { "current_query": { "type": "string", "description": "Current query will be in text format.", "title": "current_query", "x-displayname": "Current query.", "x-ves-example": "Explain security event 00000000-0000-4000-8000-f44fac7dd7bf.", "x-f5xc-example": "Explain security event 00000000-0000-4000-8000-f44fac7dd7bf", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace of the HTTP Load Balancer for current request.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-f5xc-example": "system", "x-f5xc-description-short": "Namespace of the HTTP Load Balancer for current request.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ai_assistantAIAssistantQueryRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ai_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "ai_assistantAIAssistantQueryResponse": { "type": "object", "description": "AI Assistant Query Response.", "title": "AI Assistant Query Response", "x-displayname": "AI Assistant Query Response.", "x-ves-oneof-field-response_choice": "[\"explain_log\",\"gen_dashboard_filter\",\"generic_response\",\"list_response\",\"site_analysis_response\",\"widget_response\"]", "x-ves-proto-message": "ves.io.schema.ai_assistant.AIAssistantQueryResponse", "properties": { "current_query": { "type": "string", "description": "Current query will be in text format.", "title": "current_query", "x-displayname": "Current query.", "x-ves-example": "Explain security event 00000000-0000-4000-8000-f44fac7dd7bf.", "x-f5xc-example": "Explain security event 00000000-0000-4000-8000-f44fac7dd7bf", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "explain_log": { "allOf": [ { "$ref": "#/components/schemas/explain_log_recordExplainLogRecordResponse" } ], "x-f5xc-description-short": "Configuration parameter for explain log.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "gen_dashboard_filter", "generic_response", "list_response", "site_analysis_response", "widget_response" ] }, "follow_up_queries": { "type": "array", "description": "Follow up Queries to be given as suggestion to users.", "title": "follow_up_queries", "items": { "type": "string" }, "x-displayname": "Follow up Queries.", "x-ves-example": "Explain following violation in whole namespace.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "Explain following violation in whole namespace", "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Follow up Queries to be given as suggestion to users.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "gen_dashboard_filter": { "allOf": [ { "$ref": "#/components/schemas/gen_dashboard_filterGenDashboardFilterResponse" } ], "x-f5xc-description-short": "Configuration parameter for gen dashboard filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "explain_log", "generic_response", "list_response", "site_analysis_response", "widget_response" ] }, "generic_response": { "allOf": [ { "$ref": "#/components/schemas/commonGenericResponse" } ], "x-f5xc-description-short": "Configuration parameter for generic response.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "explain_log", "gen_dashboard_filter", "list_response", "site_analysis_response", "widget_response" ] }, "list_response": { "allOf": [ { "$ref": "#/components/schemas/listListResponse" } ], "x-f5xc-description-short": "Configuration parameter for list response.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "explain_log", "gen_dashboard_filter", "generic_response", "site_analysis_response", "widget_response" ] }, "query_id": { "type": "string", "description": "Query Identifier.", "title": "query_id", "x-displayname": "Query ID", "x-ves-example": "00000000-0000-4000-8000-f44fac7dd7bf.", "x-ves-validation-rules": { "ves.io.schema.rules.string.pattern": "^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$" }, "x-f5xc-example": "00000000-0000-4000-8000-f44fac7dd7bf", "x-validation-rules": { "ves.io.schema.rules.string.pattern": "^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "pattern": "^([0-9a-f]{8}-){1}([0-9a-f]{4}-){3}([0-9a-f]{12})$", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "site_analysis_response": { "allOf": [ { "$ref": "#/components/schemas/site_analysisSiteAnalysisResponse" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "explain_log", "gen_dashboard_filter", "generic_response", "list_response", "widget_response" ] }, "widget_response": { "allOf": [ { "$ref": "#/components/schemas/widgetWidgetResponse" } ], "x-f5xc-description-short": "Configuration parameter for widget response.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "explain_log", "gen_dashboard_filter", "generic_response", "list_response", "site_analysis_response" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ai_assistantAIAssistantQueryResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ai_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "ai_assistantNegativeFeedbackDetails": { "type": "object", "description": "Negative Feedback Details.", "title": "NegativeFeedbackDetails", "x-displayname": "Negative Feedback Details.", "x-ves-proto-message": "ves.io.schema.ai_assistant.NegativeFeedbackDetails", "properties": { "remarks": { "type": "array", "description": "Configuration parameter for remarks", "title": "remarks", "items": { "$ref": "#/components/schemas/ai_assistantNegativeFeedbackType" }, "x-displayname": "Feedback", "x-ves-example": "Inaccurate data.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.items.enum.defined_only": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "Inaccurate data", "x-validation-rules": { "ves.io.schema.rules.repeated.items.enum.defined_only": "true", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ai_assistantNegativeFeedbackDetails", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "ai_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "ai_assistantNegativeFeedbackType": { "type": "string", "description": "X-displayName \"Negative Feedback Type\"\nType of Negative Feedback\n\n- OTHER: x-displayName \"Other\"\nOther\n- INACCURATE_DATA: x-displayName \"Inaccurate data\"\nInaccurate data\n- IRRELEVANT_CONTENT: x-displayName \"Irrelevant content\"\nIrrelevant content\n- POOR_FORMAT: x-displayName \"Poor format\"\nPoor format\n- SLOW_RESPONSE: x-displayName \"Slow response\"\nSlow response.", "title": "Negative Feedback Type", "enum": [ "OTHER", "INACCURATE_DATA", "IRRELEVANT_CONTENT", "POOR_FORMAT", "SLOW_RESPONSE" ], "default": "OTHER", "x-displayname": "", "x-ves-proto-enum": "ves.io.schema.ai_assistant.NegativeFeedbackType", "x-f5xc-description-short": "X-displayName \"Negative Feedback Type\" Type of Negative Feedback - OTHER: x-displayName \"Other\" Other - INACCURATE_DATA: x-displayName \"Inaccurate...", "x-f5xc-description-medium": "X-displayName \"Negative Feedback Type\" Type of Negative Feedback - OTHER: x-displayName \"Other\" Other - INACCURATE_DATA: x-displayName \"Inaccurate data\" Inaccurate data - IRRELEVANT_CONTENT: x-displayName \"Irrelevant content\" Irrelevant content - POOR_FORMAT: x-displayName \"Poor format\" Poor...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ai_assistantNegativeFeedbackType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"OTHER\"", "example_yaml": "OTHER\n..." }, "x-f5xc-cli-domain": "ai_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "ai_assistantcommonUnitType": { "type": "string", "description": "Unit Type defines the unit for each fields.\n\n- UNIT_TYPE_NONE: None\n\nNone type\n- GB: GB\n\n- PERCENT: Percent\n\n- BYTE: Byte.", "title": "UnitType", "enum": [ "UNIT_TYPE_NONE", "GB", "PERCENT", "BYTE" ], "default": "UNIT_TYPE_NONE", "x-displayname": "Unit Type", "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.UnitType", "x-f5xc-description-short": "Unit Type defines the unit for each fields. - UNIT_TYPE_NONE: None None type - GB: GB - PERCENT: Percent - BYTE: Byte.", "x-f5xc-description-medium": "Unit Type defines the unit for each fields. - UNIT_TYPE_NONE: None None type - GB: GB - PERCENT: Percent - BYTE: Byte.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ai_assistantcommonUnitType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"UNIT_TYPE_NONE\"", "example_yaml": "UNIT_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "ai_services", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "ai_assistantexplain_log_recordAction": { "type": "string", "description": "Action taken for the request\n\n- ACTION_NONE: None\n\nNo action\n- ALLOW: Allow\n\nThe request was allowed to pass\n- BLOCK: Block\n\nThe request was blocked\n- REDIRECT: Redirect\n\nThe request was redirected.", "title": "Action", "enum": [ "ACTION_NONE", "ALLOW", "BLOCK", "REDIRECT" ], "default": "ACTION_NONE", "x-displayname": "Action", "x-ves-proto-enum": "ves.io.schema.ai_assistant.explain_log_record.Action", "x-f5xc-description-short": "Action taken for the request - ACTION_NONE: None No action - ALLOW: Allow The request was allowed to pass - BLOCK: Block The request was blocked ...", "x-f5xc-description-medium": "Action taken for the request - ACTION_NONE: None No action - ALLOW: Allow The request was allowed to pass - BLOCK: Block The request was blocked - REDIRECT: Redirect The request was redirected.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ai_assistantexplain_log_recordAction", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ACTION_NONE\"", "example_yaml": "ACTION_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonCellProperties": { "type": "object", "x-ves-proto-message": "ves.io.schema.ai_assistant.common.CellProperties", "properties": { "status_style": { "allOf": [ { "$ref": "#/components/schemas/commonStatusStyle" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonCellProperties", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonColourType": { "type": "string", "description": "Colour Type defines the colour of fields to be displayed.\n\n- COLOUR_TYPE_NONE: None\n\nNo colour\n- DANGER: danger\n\ncolour type red\n- INFO: info\n\ncolour type blue\n- WARNING: warning\n\ncolour type orange\n- AMBER: amber\n\ncolour type yellow\n- SUCCESS: success\n\ncolour type green\n- MALIBU: malibu\n\ncolour type blue.", "title": "ColourType", "enum": [ "COLOUR_TYPE_NONE", "DANGER", "INFO", "WARNING", "AMBER", "SUCCESS", "MALIBU" ], "default": "COLOUR_TYPE_NONE", "x-displayname": "Colour Type.", "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.ColourType", "x-f5xc-description-short": "Colour Type defines the colour of fields to be displayed. - COLOUR_TYPE_NONE: None No colour - DANGER: danger colour type red - INFO: info colour...", "x-f5xc-description-medium": "Colour Type defines the colour of fields to be displayed. - COLOUR_TYPE_NONE: None No colour - DANGER: danger colour type red - INFO: info colour type blue - WARNING: warning colour type orange - AMBER: amber colour type yellow - SUCCESS: success colour type green - MALIBU: malibu colour type blue.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonColourType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"COLOUR_TYPE_NONE\"", "example_yaml": "COLOUR_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonColumnType": { "type": "string", "description": "Column Type defines the data type for each column.\n\n- COLUMN_TYPE_NONE: None\n\n- STRING: string\n\n- INT: integer\n\n- FLOAT: float\n\n- BOOL: boolean.", "title": "ColumnType", "enum": [ "COLUMN_TYPE_NONE", "STRING", "INT", "FLOAT", "BOOL" ], "default": "COLUMN_TYPE_NONE", "x-displayname": "Column Type.", "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.ColumnType", "x-f5xc-description-short": "Column Type defines the data type for each column. - COLUMN_TYPE_NONE: None - STRING: string - INT: integer - FLOAT: float - BOOL: boolean.", "x-f5xc-description-medium": "Column Type defines the data type for each column. - COLUMN_TYPE_NONE: None - STRING: string - INT: integer - FLOAT: float - BOOL: boolean.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonColumnType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"COLUMN_TYPE_NONE\"", "example_yaml": "COLUMN_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonDashboardLink": { "type": "object", "description": "Dashboard link will present common fields like type, namespace, object, dateFilter, logFilter.", "title": "DashboardLink", "x-displayname": "Dashboard Link.", "x-ves-proto-message": "ves.io.schema.ai_assistant.common.DashboardLink", "properties": { "key": { "type": "string", "description": "Key will present a placeholder in a text field to insert the link.\nFor example: To view these events go to the ${{link:db_link}}.", "title": "key", "x-displayname": "Key", "x-ves-example": "Db_link", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "db_link", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Key will present a placeholder in a text field to insert the link. For", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "log_filters": { "type": "array", "description": "Logs filter.", "title": "log_filters", "items": { "$ref": "#/components/schemas/commonLogFilter" }, "x-displayname": "Logs Filter.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "namespace": { "type": "string", "description": "Namespace for current request.", "title": "Namespace", "x-displayname": "Namespace", "x-ves-example": "System", "x-f5xc-example": "system", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "object_name": { "type": "string", "description": "Object name such as LB, VH.", "title": "object_name", "x-displayname": "Object name.", "x-ves-example": "VES-I/O-HTTP-loadbalancer-prod-NGINX.", "x-f5xc-example": "ves-io-http-loadbalancer-prod-nginx", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "time_range": { "type": "string", "description": "Time range filter.", "title": "time_range", "x-displayname": "Time Range.", "x-ves-example": "604800", "x-f5xc-example": "604800", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "title": { "type": "string", "description": "Title for the link.", "title": "title", "x-displayname": "Title", "x-ves-example": "Security Analytics lb1.", "x-f5xc-example": "Security Analytics lb1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "allOf": [ { "$ref": "#/components/schemas/commonDashboardLinkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Dashboard link will present common fields like type, namespace, object, dateFilter, logFilter.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonDashboardLink", "required_fields": [ "key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"key\": \"db_link\"\n}", "example_yaml": "key: db_link" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonDashboardLinkType": { "type": "string", "description": "Link Type to be presented\n\n- SECURITY_ANALYTICS_EVENTS: SECURITY_ANALYTICS_EVENTS\n\nSecurity analytics dashboard: /web/workspaces/web-app-and-API-protection/../dashboard/security-dashboard/../security_analytics/events\n- REQUESTS_EVENTS: REQUESTS_EVENTS\n\nRequests dashboard: /web/workspaces/web-app-and-API-protection/../dashboard/security-dashboard/../security_monitoring/request\n- SITES: SITES\n\nSites dashboard: /web/workspaces/multi-cloud-network-connect/overview/sites/dashboard\n- CLOUD_CREDENTIALS: CLOUD_CREDENTIALS\n\nCLOUD_CREDENTIALS --> /web/workspaces/multi-cloud-network-connect/manage/site_management/cloud_sites/cloud_credential\n- SITES_UBER: SITES_UBER\n\nSites dashboard: /web/workspaces/multi-cloud-network-connect/overview/sites/dashboard\n- SITE_ALERTS: SITE_ALERTS\n\nAlerts dashboard: /web/workspaces/multi-cloud-network-connect/overview/infrastructure/sites/alerts\n- SITE_MANAGEMENT_AWS_VPC_SITES: SITE_MANAGEMENT_AWS_VPC_SITES\n\nSite Management dashboard: /web/workspaces/multi-cloud-network-connect/manage/site_management/cloud_sites/aws_vpc_site\n- SITE_MANAGEMENT_AWS_TGW_SITES: SITE_MANAGEMENT_AWS_TGW_SITES\n\nSite Management dashboard: /web/workspacesmulti-cloud-network-connect/manage/site_management/cloud_sites/aws_tgw_site\n- SITE_MANAGEMENT_AZURE_VNET_SITES: SITE_MANAGEMENT_AZURE_VNET_SITES\n\nSite Management dashboard: /web/workspaces/multi-cloud-network-connect/manage/site_management/cloud_sites/azure_site\n- SITE_MANAGEMENT_GCP_VPC_SITES: SITE_MANAGEMENT_GCP_VPC_SITES\n\nSite Management dashboard: /web/workspaces/multi-cloud-network-connect/manage/site_management/cloud_sites/gcp_vpc_site\n- SITE_MANAGEMENT_APP_STACK_SITES: SITE_MANAGEMENT_APP_STACK_SITES\n\nSite Management dashboard: /web/workspaces/multi-cloud-network-connect/manage/site_management/cloud_sites/appstack_site\n- SITE_MANAGEMENT_SECURE_MESH_SITES: SITE_MANAGEMENT_SECURE_MESH_SITES\n\nSite Management dashboard: /web/workspaces/multi-cloud-network-connect/manage/site_management/legacy_configs/securemesh_site\n- TENANT_OVERVIEW_PAGE: TENANT_OVERVIEW_PAGE\n\nTenant Overview Page: /web/workspaces/administration/tenant-settings/tenant-overview\n- SUPPORT: SUPPORT\n\nSupport Page: /web/home.", "title": "LinkType", "enum": [ "SECURITY_ANALYTICS_EVENTS", "REQUESTS_EVENTS", "SITES", "CLOUD_CREDENTIALS", "SITES_UBER", "SITE_ALERTS", "SITE_MANAGEMENT_AWS_VPC_SITES", "SITE_MANAGEMENT_AWS_TGW_SITES", "SITE_MANAGEMENT_AZURE_VNET_SITES", "SITE_MANAGEMENT_GCP_VPC_SITES", "SITE_MANAGEMENT_APP_STACK_SITES", "SITE_MANAGEMENT_SECURE_MESH_SITES", "TENANT_OVERVIEW_PAGE", "SUPPORT" ], "default": "SECURITY_ANALYTICS_EVENTS", "x-displayname": "Link Type", "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.DashboardLinkType", "x-f5xc-description-short": "Link Type to be presented - SECURITY_ANALYTICS_EVENTS: SECURITY_ANALYTICS_EVENTS Security analytics dashboard...", "x-f5xc-description-medium": "Link Type to be presented - SECURITY_ANALYTICS_EVENTS: SECURITY_ANALYTICS_EVENTS Security analytics dashboard: /web/workspaces/web-app-and-API-protection/../dashboard/security-dashboard/../security_analytics/events - REQUESTS_EVENTS: REQUESTS_EVENTS Requests dashboard...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonDashboardLinkType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SECURITY_ANALYTICS_EVENTS\"", "example_yaml": "SECURITY_ANALYTICS_EVENTS\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonDisplay": { "type": "object", "x-ves-proto-message": "ves.io.schema.ai_assistant.common.Display", "properties": { "colour": { "allOf": [ { "$ref": "#/components/schemas/commonColourType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "display_type": { "allOf": [ { "$ref": "#/components/schemas/commonDisplayType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "formats": { "type": "array", "description": "Data format specification", "title": "format", "items": { "$ref": "#/components/schemas/commonFormatType" }, "x-displayname": "Formats", "x-ves-example": "Bold Italic.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "Bold Italic", "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonDisplay", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonDisplayType": { "type": "string", "description": "Render Type defines the format to which data has to be rendered on UI.\n\n- DISPLAY_TYPE_NONE: None\n\nNone type\n- ICON: icon\n\nValue to be displayed as ICON\n- PROGRESS_BAR: progress bar\n\n- DATE: date\n\n- DURATION: duration\n\n- PROVIDER_ICON: provider icon.", "title": "DisplayType", "enum": [ "DISPLAY_TYPE_NONE", "ICON", "DOT_WITH_VALUE", "PROGRESS_BAR", "DATE", "DURATION", "PROVIDER_ICON" ], "default": "DISPLAY_TYPE_NONE", "x-displayname": "DisplayType Type.", "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.DisplayType", "x-f5xc-description-short": "Render Type defines the format to which data has to be rendered on UI. - DISPLAY_TYPE_NONE: None None type - ICON: icon Value to be displayed as...", "x-f5xc-description-medium": "Render Type defines the format to which data has to be rendered on UI. - DISPLAY_TYPE_NONE: None None type - ICON: icon Value to be displayed as ICON - PROGRESS_BAR: progress bar - DATE: date - DURATION: duration - PROVIDER_ICON: provider icon.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonDisplayType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"DISPLAY_TYPE_NONE\"", "example_yaml": "DISPLAY_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonFieldProperties": { "type": "object", "x-ves-proto-message": "ves.io.schema.ai_assistant.common.FieldProperties", "properties": { "data_type": { "allOf": [ { "$ref": "#/components/schemas/commonColumnType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "display": { "allOf": [ { "$ref": "#/components/schemas/commonDisplay" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Human-readable name for the resource", "title": "Name", "x-displayname": "Name", "x-ves-example": "Provider", "x-f5xc-example": "provider", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "title": { "type": "string", "description": "Human-readable title for the resource", "title": "Title", "x-displayname": "Title", "x-ves-example": "Site Name", "x-f5xc-example": "Site Name", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "tooltip": { "type": "string", "description": "Tooltip for the field.", "title": "Tooltip", "x-displayname": "Tooltip", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "unit": { "allOf": [ { "$ref": "#/components/schemas/ai_assistantcommonUnitType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonFieldProperties", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonFilterOperator": { "type": "string", "description": "Operator for query filter\n\n- IN: Filter Operator\n\nSpecifies that query result includes filter values\n- NOT_IN: Filter Operator\n\nSpecifies that query result excludes filter values.", "title": "Filter Operator", "enum": [ "IN", "NOT_IN" ], "default": "IN", "x-displayname": "Filter Operator.", "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.FilterOperator", "x-f5xc-description-short": "Operator for query filter - IN: Filter Operator Specifies that query result includes filter values - NOT_IN: Filter Operator Specifies that query...", "x-f5xc-description-medium": "Operator for query filter - IN: Filter Operator Specifies that query result includes filter values - NOT_IN: Filter Operator Specifies that query result excludes filter values.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonFilterOperator", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"IN\"", "example_yaml": "IN\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonFormatType": { "type": "string", "description": "Format Type defines the format type for each fields.\n\n- FORMAT_TYPE_NONE: None\n\nNo format\n- INLINE: Inline\n\nKey value to be displayed in inline format\n- BOLD: Bold\n\nValue to be displayed in bold format\n- REVERSE_KEY_VALUE_ORDER: ReverseKeyValueOrder\n\nKey value to be displayed in Reverse Key Value Order format\n- WRAP: Wrap\n\nValue to be wrapped.", "title": "FormatType", "enum": [ "FORMAT_TYPE_NONE", "INLINE", "BOLD", "REVERSE_KEY_VALUE_ORDER", "WRAP" ], "default": "FORMAT_TYPE_NONE", "x-displayname": "Format Type.", "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.FormatType", "x-f5xc-description-short": "Format Type defines the format type for each fields. - FORMAT_TYPE_NONE: None No format - INLINE: Inline Key value to be displayed in inline...", "x-f5xc-description-medium": "Format Type defines the format type for each fields. - FORMAT_TYPE_NONE: None No format - INLINE: Inline Key value to be displayed in inline format - BOLD: Bold Value to be displayed in bold format - REVERSE_KEY_VALUE_ORDER: ReverseKeyValueOrder Key value to be displayed in Reverse Key Value...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonFormatType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"FORMAT_TYPE_NONE\"", "example_yaml": "FORMAT_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonGenericLink": { "type": "object", "description": "Generic link can have external link with full URL.", "title": "GenericLink", "x-displayname": "Generic Link.", "x-ves-proto-message": "ves.io.schema.ai_assistant.common.GenericLink", "properties": { "key": { "type": "string", "description": "Key will present a placeholder in a text field to insert the link.\nFor example: To view these events go to the ${{link:db_link}}.", "title": "key", "x-displayname": "Key", "x-ves-example": "Db_link", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "db_link", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Key will present a placeholder in a text field to insert the link. For", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "title": { "type": "string", "description": "Title for the link.", "title": "title", "x-displayname": "Title", "x-ves-example": "Security Analytics lb1.", "x-f5xc-example": "Security Analytics lb1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "url": { "type": "string", "description": "Full URL", "title": "url", "x-displayname": "URL", "x-ves-example": "https://datatracker.ietf.org/doc/HTML/rfc3986.", "x-f5xc-example": "https://datatracker.ietf.org/doc/html/rfc3986", "format": "uri", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "inferred", "confidence": 0.9, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Generic link can have external link with full URL.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonGenericLink", "required_fields": [ "key" ], "mutually_exclusive_groups": [], "example_json": "{\n \"key\": \"db_link\"\n}", "example_yaml": "key: db_link" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonGenericResponse": { "type": "object", "description": "Generic Response.", "title": "Generic Response", "x-displayname": "Generic Response.", "x-ves-proto-message": "ves.io.schema.ai_assistant.common.GenericResponse", "properties": { "error": { "allOf": [ { "$ref": "#/components/schemas/schemaErrorType__ves_io_schema_ai_assistant" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "is_error": { "type": "boolean", "description": "Configuration parameter for is error", "title": "is_error", "format": "boolean", "x-displayname": "Is_error", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "summary": { "type": "string", "description": "Configuration parameter for summary", "title": "Summary", "x-displayname": "Summary", "x-ves-example": "Query not supported.", "x-f5xc-example": "Query not supported", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonGenericResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonLink": { "type": "object", "description": "Link for a page.", "title": "Link", "x-displayname": "Link", "x-ves-oneof-field-link_type": "[\"dashboard_link\",\"generic_link\"]", "x-ves-proto-message": "ves.io.schema.ai_assistant.common.Link", "properties": { "dashboard_link": { "allOf": [ { "$ref": "#/components/schemas/commonDashboardLink" } ], "x-f5xc-description-short": "Configuration parameter for dashboard link.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "generic_link" ] }, "generic_link": { "allOf": [ { "$ref": "#/components/schemas/commonGenericLink" } ], "x-f5xc-description-short": "Configuration parameter for generic link.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "dashboard_link" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonLink", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonLogFilter": { "type": "object", "description": "Log filter for filter query.", "title": "LogFilter", "x-displayname": "Log Filter.", "x-ves-proto-message": "ves.io.schema.ai_assistant.common.LogFilter", "properties": { "key": { "type": "string", "description": "Key to be presented in the filter.", "title": "key", "x-displayname": "Key", "x-ves-example": "Attack_types.name.", "x-f5xc-example": "attack_types.name", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 7, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "op": { "allOf": [ { "$ref": "#/components/schemas/commonFilterOperator" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "values": { "type": "array", "description": "Values to be presented in the filter.", "title": "values", "items": { "type": "string" }, "x-displayname": "Values", "x-ves-example": "ATTACK_TYPE_CROSS_SITE_SCRIPTING.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-example": "ATTACK_TYPE_CROSS_SITE_SCRIPTING", "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonLogFilter", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonOverlayContent": { "type": "object", "description": "Overlay link for creating ticket.", "title": "Overlay Link", "x-displayname": "Overlay Link.", "x-ves-proto-message": "ves.io.schema.ai_assistant.common.OverlayContent", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/commonOverlayData" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "title": { "type": "string", "description": "Title for the link.", "title": "title", "x-displayname": "Title", "x-ves-example": "Security Analytics lb1.", "x-f5xc-example": "Security Analytics lb1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "allOf": [ { "$ref": "#/components/schemas/commonDashboardLinkType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonOverlayContent", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonOverlayData": { "type": "object", "description": "Overlay data for creating support ticket.", "title": "Overlay Data", "x-displayname": "Overlay Data.", "x-ves-proto-message": "ves.io.schema.ai_assistant.common.OverlayData", "properties": { "priority": { "type": "string", "description": "Priority for the support ticket.", "title": "priority", "x-displayname": "Priority", "x-ves-example": "Normal", "x-f5xc-example": "Normal", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "product_data": { "type": "string", "description": "Product Data for the support ticket.", "title": "product data", "x-displayname": "Product Data.", "x-ves-example": "Site X is in Failed state for 2 reasons. Customer Tunnel Interface Down and Site Heartbeat Down.", "x-f5xc-example": "Site X is in Failed state for 2 reasons. Customer Tunnel Interface Down and Site Heartbeat Down", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subject": { "type": "string", "description": "Subject for the support ticket.", "title": "subject", "x-displayname": "Subject", "x-ves-example": "Troubleshoot site.", "x-f5xc-example": "Troubleshoot site", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "support_type": { "type": "string", "description": "Type for the support ticket.", "title": "type", "x-displayname": "Type", "x-ves-example": "Technical Support.", "x-f5xc-example": "Technical Support", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "topic": { "type": "string", "description": "Topic for the support ticket.", "title": "topic", "x-displayname": "Topic", "x-ves-example": "Troubleshooting.", "x-f5xc-example": "Troubleshooting", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "workspace": { "type": "string", "description": "Workspace for the support ticket.", "title": "workspace", "x-displayname": "Workspace", "x-ves-example": "Multi-Cloud Network Connect.", "x-f5xc-example": "Multi-Cloud Network Connect", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Overlay data for creating support ticket.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonOverlayData", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonStatusStyle": { "type": "string", "description": "Status Style defines the colour of status to be displayed.\n\n- STATUS_STYLE_UNKNOWN: Unknown\n\nNo colour\n- STATUS_STYLE_SUCCESS: success\n\ncolour type green\n- STATUS_STYLE_DANGER: danger\n\ncolour type red\n- STATUS_STYLE_WARNING: warning\n\ncolour type yellow\n- STATUS_STYLE_INACTIVE: inactive\n\ncolour type grey\n- STATUS_STYLE_MINOR: minor\n\ncolour type blue.", "title": "StatusStyle", "enum": [ "STATUS_STYLE_UNKNOWN", "STATUS_STYLE_SUCCESS", "STATUS_STYLE_DANGER", "STATUS_STYLE_WARNING", "STATUS_STYLE_INACTIVE", "STATUS_STYLE_MINOR" ], "default": "STATUS_STYLE_UNKNOWN", "x-displayname": "Status Style.", "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.StatusStyle", "x-f5xc-description-short": "Status Style defines the colour of status to be displayed. - STATUS_STYLE_UNKNOWN: Unknown No colour - STATUS_STYLE_SUCCESS: success colour type...", "x-f5xc-description-medium": "Status Style defines the colour of status to be displayed. - STATUS_STYLE_UNKNOWN: Unknown No colour - STATUS_STYLE_SUCCESS: success colour type green - STATUS_STYLE_DANGER: danger colour type red - STATUS_STYLE_WARNING: warning colour type yellow - STATUS_STYLE_INACTIVE: inactive colour type...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonStatusStyle", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"STATUS_STYLE_UNKNOWN\"", "example_yaml": "STATUS_STYLE_UNKNOWN\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "commonWidgetType": { "type": "string", "description": "Widget Type defines the data type for widget.\n\n- WIDGET_TYPE_NONE: None\n\nNone type\n- TWO_VALUE: two_value\n\nTwo Value type widget\n- DISTRIBUTION_CHART: distribution_chart\n\nDistribution Chart type widget\n- TABLE: table\n\nTable type widget\n- LIST: list\n\nList type widget\n- GRID: grid\n\nGrid type widget\n- PIE: pie\n\npie type widget.", "title": "WidgetType", "enum": [ "WIDGET_TYPE_NONE", "TWO_VALUE", "DISTRIBUTION_CHART", "TABLE", "LIST", "GRID", "PIE" ], "default": "WIDGET_TYPE_NONE", "x-displayname": "Widget Type.", "x-ves-proto-enum": "ves.io.schema.ai_assistant.common.WidgetType", "x-f5xc-description-short": "Widget Type defines the data type for widget. - WIDGET_TYPE_NONE: None None type - TWO_VALUE: two_value Two Value type widget ...", "x-f5xc-description-medium": "Widget Type defines the data type for widget. - WIDGET_TYPE_NONE: None None type - TWO_VALUE: two_value Two Value type widget - DISTRIBUTION_CHART: distribution_chart Distribution Chart type widget - TABLE: table Table type widget - LIST: list List type widget - GRID: grid Grid type widget ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for commonWidgetType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"WIDGET_TYPE_NONE\"", "example_yaml": "WIDGET_TYPE_NONE\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "explain_log_recordAccuracy": { "type": "string", "description": "Specifies accuracy of the signature\n\n- ACCURACY_NONE: None\n\nNo accuracy\n- ACCURACY_LOW: Low\n\nSpecifies low accuracy of the signature\n- ACCURACY_MEDIUM: Medium\n\nSpecifies medium accuracy of the signature\n- ACCURACY_HIGH: High\n\nSpecifies high accuracy of the signature.", "title": "Accuracy", "enum": [ "ACCURACY_NONE", "ACCURACY_LOW", "ACCURACY_MEDIUM", "ACCURACY_HIGH" ], "default": "ACCURACY_NONE", "x-displayname": "Accuracy", "x-ves-proto-enum": "ves.io.schema.ai_assistant.explain_log_record.Accuracy", "x-f5xc-description-short": "Specifies accuracy of the signature - ACCURACY_NONE: None No accuracy - ACCURACY_LOW: Low Specifies low accuracy of the signature ...", "x-f5xc-description-medium": "Specifies accuracy of the signature - ACCURACY_NONE: None No accuracy - ACCURACY_LOW: Low Specifies low accuracy of the signature - ACCURACY_MEDIUM: Medium Specifies medium accuracy of the signature - ACCURACY_HIGH: High Specifies high accuracy of the signature.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for explain_log_recordAccuracy", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ACCURACY_NONE\"", "example_yaml": "ACCURACY_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "explain_log_recordBot": { "type": "object", "description": "Bot details.", "title": "Bot", "x-displayname": "Bot", "x-ves-proto-message": "ves.io.schema.ai_assistant.explain_log_record.Bot", "properties": { "classification": { "type": "string", "description": "Bot classification.", "title": "classification", "x-displayname": "Classification.", "x-ves-example": "Suspicious.", "x-f5xc-example": "suspicious", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Bot name", "title": "name", "x-displayname": "Name", "x-ves-example": "Curl", "x-f5xc-example": "curl", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "type": { "type": "string", "description": "Bot type", "title": "name", "x-displayname": "Type", "x-ves-example": "HTTP Library.", "x-f5xc-example": "HTTP Library", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for explain_log_recordBot", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "explain_log_recordBotDefenseEventDetails": { "type": "object", "description": "Bot Defense security events details.", "title": "BotDefenseEventDetails", "x-displayname": "Bot Defense Event Details.", "x-ves-proto-message": "ves.io.schema.ai_assistant.explain_log_record.BotDefenseEventDetails", "properties": { "action": { "allOf": [ { "$ref": "#/components/schemas/ai_assistantexplain_log_recordAction" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "automation_type": { "type": "string", "description": "Bot automation type.", "title": "automation_type", "x-displayname": "Automation type.", "x-ves-example": "Token Missing.", "x-f5xc-example": "Token Missing", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bot_type": { "type": "string", "description": "Bot type", "title": "bot_type", "x-displayname": "Bot type", "x-ves-example": "MALICIOUS", "x-f5xc-example": "MALICIOUS", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "method": { "type": "string", "description": "Method of the request.", "title": "method", "x-displayname": "Method", "x-ves-example": "GET", "x-f5xc-example": "GET", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "request_path": { "type": "string", "description": "Request path.", "title": "request_path", "x-displayname": "Request Path.", "x-ves-example": "/API/support/cases/case1.", "x-f5xc-example": "/api/support/cases/case1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for explain_log_recordBotDefenseEventDetails", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "explain_log_recordEnforcementMode": { "type": "string", "description": "Enforcement mode of WAF\n\n- ENFORCEMENT_NONE: None\n\nNo enforcement\n- MONITORING: Monitoring\n\nMonitoring mode of WAF\n- BLOCKING: Blocking\n\nBlocking mode of WAF.", "title": "EnforcementMode", "enum": [ "ENFORCEMENT_NONE", "MONITORING", "BLOCKING" ], "default": "ENFORCEMENT_NONE", "x-displayname": "Enforcement Mode.", "x-ves-proto-enum": "ves.io.schema.ai_assistant.explain_log_record.EnforcementMode", "x-f5xc-description-short": "Enforcement mode of WAF - ENFORCEMENT_NONE: None No enforcement - MONITORING: Monitoring Monitoring mode of WAF - BLOCKING: Blocking Blocking mode...", "x-f5xc-description-medium": "Enforcement mode of WAF - ENFORCEMENT_NONE: None No enforcement - MONITORING: Monitoring Monitoring mode of WAF - BLOCKING: Blocking Blocking mode of WAF.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for explain_log_recordEnforcementMode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"ENFORCEMENT_NONE\"", "example_yaml": "ENFORCEMENT_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "explain_log_recordExplainLogRecordResponse": { "type": "object", "description": "Explain log response.", "title": "ExplainLogRecordResponse", "x-displayname": "Explain Log Record Response.", "x-ves-oneof-field-details": "[\"bot_defense_event_details\",\"request_details\",\"svc_policy_event_details\",\"waf_event_details\"]", "x-ves-proto-message": "ves.io.schema.ai_assistant.explain_log_record.ExplainLogRecordResponse", "properties": { "actions": { "type": "string", "description": "Follow-up actions.", "title": "actions", "x-displayname": "Actions", "x-ves-example": "If you think that this is a false positive you can create exclusion rule..", "x-f5xc-example": "If you think that this is a false positive you can create exclusion rule..", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "analysis": { "type": "string", "description": "Log analysis.", "title": "analysis", "x-displayname": "Analysis", "x-ves-example": "The request was blocked because Null in request violation was detected.", "x-f5xc-example": "The request was blocked because Null in request violation was detected", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bot_defense_event_details": { "allOf": [ { "$ref": "#/components/schemas/explain_log_recordBotDefenseEventDetails" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "request_details", "svc_policy_event_details", "waf_event_details" ] }, "request_details": { "allOf": [ { "$ref": "#/components/schemas/explain_log_recordRequestDetails" } ], "x-f5xc-description-short": "Configuration parameter for request details.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bot_defense_event_details", "svc_policy_event_details", "waf_event_details" ] }, "summary": { "type": "string", "description": "Log summary.", "title": "summary", "x-displayname": "Summary", "x-ves-example": "Request ID 12345 refers to a WAF security event for an HTTP request that was blocked.", "x-f5xc-example": "Request Id 12345 refers to a WAF security event for an HTTP request that was blocked", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "svc_policy_event_details": { "allOf": [ { "$ref": "#/components/schemas/explain_log_recordSvcPolicyEventDetails" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bot_defense_event_details", "request_details", "waf_event_details" ] }, "waf_event_details": { "allOf": [ { "$ref": "#/components/schemas/explain_log_recordWAFEventDetails" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "bot_defense_event_details", "request_details", "svc_policy_event_details" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for explain_log_recordExplainLogRecordResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "explain_log_recordIPReputation": { "type": "string", "description": "Specifies IP risk/trustworthiness\n\n- IP_REPUTATION_NONE: None\n\nNo IP reputation\n- IP_REPUTATION_LOW: Low\n\nSpecifies low IP risk/trustworthiness\n- IP_REPUTATION_HIGH: High\n\nSpecifies high IP risk/trustworthiness.", "title": "IPReputation", "enum": [ "IP_REPUTATION_NONE", "IP_REPUTATION_LOW", "IP_REPUTATION_HIGH" ], "default": "IP_REPUTATION_NONE", "x-displayname": "IP Reputation.", "x-ves-proto-enum": "ves.io.schema.ai_assistant.explain_log_record.IPReputation", "x-f5xc-description-short": "Specifies IP risk/trustworthiness - IP_REPUTATION_NONE: None No IP reputation - IP_REPUTATION_LOW: Low Specifies low IP risk/trustworthiness ...", "x-f5xc-description-medium": "Specifies IP risk/trustworthiness - IP_REPUTATION_NONE: None No IP reputation - IP_REPUTATION_LOW: Low Specifies low IP risk/trustworthiness - IP_REPUTATION_HIGH: High Specifies high IP risk/trustworthiness.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for explain_log_recordIPReputation", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"IP_REPUTATION_NONE\"", "example_yaml": "IP_REPUTATION_NONE\n..." }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "explain_log_recordRequestDetails": { "type": "object", "description": "Request details.", "title": "RequestDetails", "x-displayname": "Request Details.", "x-ves-proto-message": "ves.io.schema.ai_assistant.explain_log_record.RequestDetails", "properties": { "domain": { "type": "string", "description": "Domain", "title": "domain", "x-displayname": "Domain", "x-ves-example": "example.com.", "x-f5xc-example": "example.com", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 26, "format": "hostname", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "rsp_code": { "type": "integer", "description": "Rsp_code", "title": "rsp_code", "format": "int64", "x-displayname": "Response Code.", "x-ves-example": "200", "x-f5xc-example": "200", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rsp_code_details": { "type": "string", "description": "Rsp_code_details.", "title": "rsp_code_details", "x-displayname": "Response Code Details.", "x-ves-example": "Via upstream.", "x-f5xc-example": "via upstream", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "upstream_protocol_error_reason": { "type": "string", "description": "Upstream_protocol_error_reason.", "title": "upstream_protocol_error_reason", "x-displayname": "Upstream Protocol Error Reason.", "x-ves-example": "Headers_count_exceeds_limit.", "x-f5xc-example": "headers_count_exceeds_limit", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for explain_log_recordRequestDetails", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "explain_log_recordSignature": { "type": "object", "description": "Signature details.", "title": "Signature", "x-displayname": "Signature", "x-ves-proto-message": "ves.io.schema.ai_assistant.explain_log_record.Signature", "properties": { "accuracy": { "allOf": [ { "$ref": "#/components/schemas/explain_log_recordAccuracy" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "attack_type": { "type": "string", "description": "Attack type of the signature.", "title": "attack_type", "x-displayname": "Attack Type.", "x-ves-example": "Command Execution.", "x-f5xc-example": "Command Execution", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "context": { "type": "string", "description": "Context of the signature.", "title": "context", "x-displayname": "Context", "x-ves-example": "Parameter", "x-f5xc-example": "parameter", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "Signature ID.", "title": "id", "x-displayname": "Signature ID.", "x-ves-example": "200013569", "x-f5xc-example": "200013569", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "matching_info": { "type": "string", "description": "Matching info.", "title": "matching_info", "x-displayname": "Matching Info.", "x-ves-example": "Matched 7 chars on offset 6 against value: Token.", "x-f5xc-example": "Matched 7 chars on offset 6 against valueToken", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Signature name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Shell command processor.", "x-f5xc-example": "shell command processor", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "state": { "type": "string", "description": "State of the signature, can be enabled, suppressed and etc.", "title": "state", "x-displayname": "State", "x-ves-example": "Enabled", "x-f5xc-example": "Enabled", "x-f5xc-description-short": "State of the signature, can be enabled, suppressed and etc.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for explain_log_recordSignature", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "explain_log_recordSvcPolicyEventDetails": { "type": "object", "description": "Service policy security events details.", "title": "SvcPolicyEventDetails", "x-displayname": "Service Policy Event Details.", "x-ves-proto-message": "ves.io.schema.ai_assistant.explain_log_record.SvcPolicyEventDetails", "properties": { "action": { "allOf": [ { "$ref": "#/components/schemas/ai_assistantexplain_log_recordAction" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_risk": { "allOf": [ { "$ref": "#/components/schemas/explain_log_recordIPReputation" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_threat_categories": { "type": "array", "description": "IP threat categories.", "title": "ip threat categories", "items": { "$ref": "#/components/schemas/policyIPThreatCategory" }, "x-displayname": "IP threat categories.", "x-ves-example": "SPAM_SOURCES,PHISHING.", "x-f5xc-example": "SPAM_SOURCES,PHISHING", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip_trustworthiness": { "allOf": [ { "$ref": "#/components/schemas/explain_log_recordIPReputation" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "policy": { "type": "string", "description": "Policy name.", "title": "policy", "x-displayname": "Policy", "x-ves-example": "Policy-1", "x-f5xc-example": "policy-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "policy_namespace": { "type": "string", "description": "Policy namespace.", "title": "policy namespace", "x-displayname": "Policy namespace.", "x-ves-example": "Data-path", "x-f5xc-example": "data-path", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "policy_rule": { "type": "string", "description": "Policy rule name.", "title": "policy rule", "x-displayname": "Policy rule.", "x-ves-example": "Policy-rule-1.", "x-f5xc-example": "policy-rule-1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for explain_log_recordSvcPolicyEventDetails", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "explain_log_recordThreatCampaign": { "type": "object", "description": "Threat campaign details.", "title": "ThreatCampaign", "x-displayname": "Threat Campaign.", "x-ves-proto-message": "ves.io.schema.ai_assistant.explain_log_record.ThreatCampaign", "properties": { "attack_type": { "type": "string", "description": "Attack type of threat campaign.", "title": "attack_type", "x-displayname": "Attack Type.", "x-ves-example": "Command Execution.", "x-f5xc-example": "Command Execution", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "id": { "type": "string", "description": "ThreatCampaign ID.", "title": "id", "x-displayname": "ThreatCampaign ID.", "x-ves-example": "Cmpe1ab3d4feddb3c691bc68201d253be66.", "x-f5xc-example": "cmpe1ab3d4feddb3c691bc68201d253be66", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "ThreatCampaign name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Nette Framework Remote Code Execution - oshi.", "x-f5xc-example": "Nette Framework Remote Code Execution - oshi", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for explain_log_recordThreatCampaign", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "explain_log_recordViolation": { "type": "object", "description": "Violation details.", "title": "Violation", "x-displayname": "Violation", "x-ves-proto-message": "ves.io.schema.ai_assistant.explain_log_record.Violation", "properties": { "attack_type": { "type": "string", "description": "Attack type of the violation.", "title": "attack_type", "x-displayname": "Attack Type.", "x-ves-example": "Command Execution.", "x-f5xc-example": "Command Execution", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "context": { "type": "string", "description": "Context of the violation.", "title": "context", "x-displayname": "Context", "x-ves-example": "Parameter", "x-f5xc-example": "parameter", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "matching_info": { "type": "string", "description": "Matching info.", "title": "matching_info", "x-displayname": "Matching Info.", "x-ves-example": "File extension was dat.", "x-f5xc-example": "File extension was dat", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "Violation name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Illegal filetype.", "x-f5xc-example": "Illegal filetype", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "state": { "type": "string", "description": "State of the violation, can be enabled, suppressed and etc.", "title": "state", "x-displayname": "State", "x-ves-example": "Enabled", "x-f5xc-example": "Enabled", "x-f5xc-description-short": "State of the violation, can be enabled, suppressed and etc.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for explain_log_recordViolation", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "statistics", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "explain_log_recordWAFEventDetails": { "type": "object", "description": "WAF security events details.", "title": "WAFEventDetails", "x-displayname": "WAF Event Details.", "x-ves-proto-message": "ves.io.schema.ai_assistant.explain_log_record.WAFEventDetails", "properties": { "action": { "allOf": [ { "$ref": "#/components/schemas/ai_assistantexplain_log_recordAction" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "app_firewall": { "type": "string", "description": "App Firewall name.", "title": "app_firewall", "x-displayname": "App Firewall.", "x-ves-example": "App-firewall.", "x-f5xc-example": "app-firewall", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "bot": { "allOf": [ { "$ref": "#/components/schemas/explain_log_recordBot" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "enforcement_mode": { "allOf": [ { "$ref": "#/components/schemas/explain_log_recordEnforcementMode" } ], "x-f5xc-description-short": "Configuration parameter for enforcement mode.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "signatures": { "type": "array", "description": "The signatures that were detected in the request.", "title": "signatures", "items": { "$ref": "#/components/schemas/explain_log_recordSignature" }, "x-displayname": "Signatures.", "x-f5xc-description-short": "The signatures that were detected in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "threat_campaigns": { "type": "array", "description": "Threat campaigns that were detected in the request.", "title": "threat_campaigns", "items": { "$ref": "#/components/schemas/explain_log_recordThreatCampaign" }, "x-displayname": "Threat Campaign.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "Threat campaigns that were detected in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "violations": { "type": "array", "description": "The violations that were detected in the request.", "title": "violations", "items": { "$ref": "#/components/schemas/explain_log_recordViolation" }, "x-displayname": "Violations.", "x-f5xc-description-short": "The violations that were detected in the request.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for explain_log_recordWAFEventDetails", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "virtual", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "gen_dashboard_filterGenDashboardFilterResponse": { "type": "object", "description": "Generate dashboard filter response.", "title": "GenDashboardFilterResponse", "x-displayname": "Generate Dashboard Filter.", "x-ves-proto-message": "ves.io.schema.ai_assistant.gen_dashboard_filter.GenDashboardFilterResponse", "properties": { "actions": { "type": "string", "description": "Follow-up actions.", "title": "actions", "x-displayname": "Actions", "x-ves-example": "To view these events go to the ${{link:dashboard_link}} page.", "x-f5xc-example": "To view these events go to the ${{link:dashboard_link}} page", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "links": { "type": "array", "description": "Links that will be presented to the user.", "title": "links", "items": { "$ref": "#/components/schemas/commonLink" }, "x-displayname": "Links", "x-f5xc-description-short": "Links that will be presented to the user.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "summary": { "type": "string", "description": "Events summary.", "title": "summary", "x-displayname": "Summary", "x-ves-example": "135 events matching your query were found.", "x-f5xc-example": "135 events matching your query were found", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for gen_dashboard_filterGenDashboardFilterResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "listItem": { "type": "object", "x-ves-proto-message": "ves.io.schema.ai_assistant.list.Item", "properties": { "link": { "allOf": [ { "$ref": "#/components/schemas/commonLink" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for listItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "listList": { "type": "object", "x-ves-proto-message": "ves.io.schema.ai_assistant.list.List", "properties": { "item": { "type": "array", "description": "List of item.", "title": "item", "items": { "$ref": "#/components/schemas/listItem" }, "x-displayname": "Item", "x-ves-example": "Entries for each item.", "x-f5xc-example": "Entries for each item", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 26, "minLength": 15, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "title": { "type": "string", "description": "Human-readable title for the resource", "title": "Title", "x-displayname": "Title", "x-ves-example": "Cloud Sites.", "x-f5xc-example": "Cloud Sites", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for listList", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "listListResponse": { "type": "object", "description": "List response.", "title": "List Response", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.ai_assistant.list.ListResponse", "properties": { "external_links": { "type": "array", "description": "External doc links, that will be presented to the user.", "title": "external links", "items": { "$ref": "#/components/schemas/commonLink" }, "x-displayname": "External Links.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "6" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "6" }, "x-f5xc-description-short": "External doc links, that will be presented to the user.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Response will have set of lists.", "title": "Items", "items": { "$ref": "#/components/schemas/listList" }, "x-displayname": "List View", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "summary": { "type": "string", "description": "Configuration parameter for summary", "title": "summary", "x-displayname": "Summary", "x-ves-example": "This is summary of List response.", "x-f5xc-example": "This is summary of List response", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for listListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "policyIPThreatCategory": { "type": "string", "description": "The IP threat categories to use when a policy based IP threat category is configured.\n\n- SPAM_SOURCES: SPAM_SOURCES\n\n- WINDOWS_EXPLOITS: WINDOWS_EXPLOITS\n\n- WEB_ATTACKS: WEB_ATTACKS\n\n- BOTNETS: BOTNETS\n\n- SCANNERS: SCANNERS\n\n- REPUTATION: REPUTATION\n\n- PHISHING: PHISHING\n\n- PROXY: PROXY\n\n- MOBILE_THREATS: MOBILE_THREATS\n\n- TOR_PROXY: TOR_PROXY\n\n- DENIAL_OF_SERVICE: DENIAL_OF_SERVICE\n\n- NETWORK: NETWORK.", "title": "IP Threat Category", "enum": [ "SPAM_SOURCES", "WINDOWS_EXPLOITS", "WEB_ATTACKS", "BOTNETS", "SCANNERS", "REPUTATION", "PHISHING", "PROXY", "MOBILE_THREATS", "TOR_PROXY", "DENIAL_OF_SERVICE", "NETWORK" ], "default": "SPAM_SOURCES", "x-displayname": "IP Threat Category.", "x-ves-proto-enum": "ves.io.schema.policy.IPThreatCategory", "x-f5xc-description-short": "The IP threat categories to use when a policy based IP threat category is configured. - SPAM_SOURCES: SPAM_SOURCES - WINDOWS_EXPLOITS...", "x-f5xc-description-medium": "The IP threat categories to use when a policy based IP threat category is configured. - SPAM_SOURCES: SPAM_SOURCES - WINDOWS_EXPLOITS: WINDOWS_EXPLOITS - WEB_ATTACKS: WEB_ATTACKS - BOTNETS: BOTNETS - SCANNERS: SCANNERS - REPUTATION: REPUTATION - PHISHING: PHISHING - PROXY: PROXY ...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for policyIPThreatCategory", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"SPAM_SOURCES\"", "example_yaml": "SPAM_SOURCES\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "protobufAny": { "type": "object", "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\nFoo foo = ...;\nAny any;\nany.packfrom(foo);\n...\nIf (any.unpackto(&foo)) {\n...\n}\n\nExample 2: Pack and unpack a message in Java.\n\nFoo foo = ...;\nAny any = any.pack(foo);\n...\nIf (any.is(foo.class)) {\nfoo = any.unpack(foo.class);\n}\n\nExample 3: Pack and unpack a message in Python.\n\nFoo = Foo(...)\nany = Any()\nany.pack(foo)\n...\nIf any.is(foo.descriptor):\nany.unpack(foo)\n...\n\nExample 4: Pack and unpack a message in Go\n\nfoo := &pb.foo{...}\nany, err := ptypes.marshalany(foo)\n...\nFoo := &pb.foo{}\nif err := ptypes.unmarshalany(any, foo); err != nil {\n...\n}\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.example.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\npackage google.profile;\nmessage Person {\nstring first_name = 1;\nstring last_name = 2;\n}\n\n{\n\"@type\": \"type.googleapis.com/google.profile.person\",\n\"firstName\": ,\n\"lastName\": \n}\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.duration][]):\n\n{\n\"@type\": \"type.googleapis.com/google.protobuf.duration\",\n\"value\": \"1.212s\"\n}", "properties": { "type_url": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `HTTP`, `HTTPS`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `HTTPS` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.type][]\nvalue in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\nURL, or have them precompiled into a binary to avoid any\nlookup. Therefore, binary compatibility needs to be preserved\non changes to types. (Use versioned type names to manage\nbreaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `HTTP`, `HTTPS` (or the empty scheme) might be\nused with implementation specific semantics.", "x-f5xc-description-short": "URL identifying the protocol buffer message type.", "x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Must be a valid serialized protocol buffer of the above specified type.", "format": "byte", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.", "x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protobufAny", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaEmpty": { "type": "object", "description": "This can be used for messages where no values are needed.", "title": "Empty", "x-displayname": "Empty", "x-ves-proto-message": "ves.io.schema.Empty", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaEmpty", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaErrorCode": { "type": "string", "description": "Union of all possible error-codes from system\n\n- EOK: No error\n- EPERMS: Permissions error\n- EBADINPUT: Input is not correct\n- ENOTFOUND: Not found\n- EEXISTS: Already exists\n- EUNKNOWN: Unknown/catchall error\n- ESERIALIZE: Error in serializing/de-serializing\n- EINTERNAL: Server error\n- EPARTIAL: Partial error.", "title": "ErrorCode", "enum": [ "EOK", "EPERMS", "EBADINPUT", "ENOTFOUND", "EEXISTS", "EUNKNOWN", "ESERIALIZE", "EINTERNAL", "EPARTIAL" ], "default": "EOK", "x-displayname": "Error Code.", "x-ves-proto-enum": "ves.io.schema.ErrorCode", "x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...", "x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EOK\"", "example_yaml": "EOK\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "schemaErrorType__ves_io_schema_ai_assistant": { "type": "object", "description": "Information about a error in API operation.", "title": "ErrorType", "x-displayname": "Error Type.", "x-ves-proto-message": "ves.io.schema.ErrorType", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/schemaErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_obj": { "allOf": [ { "$ref": "#/components/schemas/protobufAny" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "description": "A human readable string of the error.", "title": "message", "x-displayname": "Message", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Information about a error in API operation.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "site_analysisSiteAnalysisResponse": { "type": "object", "description": "Site analysis response.", "title": "Site Analysis Response", "x-displayname": "Site Analysis Response.", "x-ves-proto-message": "ves.io.schema.ai_assistant.site_analysis.SiteAnalysisResponse", "properties": { "external_links": { "type": "array", "description": "External doc links, that will be presented to the user.", "title": "external links", "items": { "$ref": "#/components/schemas/commonLink" }, "x-displayname": "External Links.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "6" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "6" }, "x-f5xc-description-short": "External doc links, that will be presented to the user.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "internal_links": { "type": "array", "description": "Internal Link like dashboard links, that will be presented to the user.", "title": "internal links", "items": { "$ref": "#/components/schemas/commonLink" }, "x-displayname": "Internal Links.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "6" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true", "ves.io.schema.rules.string.max_len": "6" }, "x-f5xc-description-short": "Internal Link like dashboard links, that will be presented to the user.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "overlay_content": { "allOf": [ { "$ref": "#/components/schemas/commonOverlayContent" } ], "x-f5xc-description-short": "Configuration parameter for overlay content.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "summary": { "type": "string", "description": "Configuration parameter for summary", "title": "summary", "x-displayname": "Summary", "x-ves-example": "This site analysis response provides status of sites.", "x-f5xc-example": "This site analysis response provides status of sites.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "table_view": { "allOf": [ { "$ref": "#/components/schemas/widgetWidgetView" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for site_analysisSiteAnalysisResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Sites are platform-level infrastructure" }, "classification": { "category": "infrastructure", "multi_tenant_pattern": "none" } } }, "widgetCell": { "type": "object", "x-ves-proto-message": "ves.io.schema.ai_assistant.widget.Cell", "properties": { "link": { "allOf": [ { "$ref": "#/components/schemas/commonLink" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "properties": { "allOf": [ { "$ref": "#/components/schemas/commonCellProperties" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Configuration parameter for value", "title": "Value", "x-displayname": "Value", "x-ves-example": "Site1", "x-f5xc-example": "site1", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for widgetCell", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "widgetRow": { "type": "object", "description": "Contains the value for each rows of table.", "title": "Row", "x-displayname": "Table Rows.", "x-ves-proto-message": "ves.io.schema.ai_assistant.widget.Row", "properties": { "cells": { "type": "array", "description": "Configuration parameter for cells", "title": "Values", "items": { "$ref": "#/components/schemas/widgetCell" }, "x-displayname": "Values", "x-ves-example": "Site Name:\"site-1.", "x-f5xc-example": "\"Site Name:\"site-1\"", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Contains the value for each rows of table.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for widgetRow", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "widgetTable": { "type": "object", "x-ves-proto-message": "ves.io.schema.ai_assistant.widget.Table", "properties": { "field_properties": { "type": "array", "description": "Lists the name of the field & corresponding properties.", "title": "Field Properties\nx-displayName: \"Field Properties\"\nLists the name of the field & corresponding properties", "items": { "$ref": "#/components/schemas/commonFieldProperties" }, "x-displayname": "Field Properties.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-validation-rules": { "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Lists the name of the field & corresponding properties.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "rows": { "type": "array", "description": "List of table rows.", "title": "rows", "items": { "$ref": "#/components/schemas/widgetRow" }, "x-displayname": "Row", "x-ves-example": "Entries for each rows.", "x-f5xc-example": "Entries for each rows", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "widget_type": { "allOf": [ { "$ref": "#/components/schemas/commonWidgetType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for widgetTable", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "widgetWidgetResponse": { "type": "object", "description": "Widget response.", "title": "Widget Response", "x-displayname": "Widget Response.", "x-ves-proto-message": "ves.io.schema.ai_assistant.widget.WidgetResponse", "properties": { "item_links": { "type": "array", "description": "Links that will be presented to the user.", "title": "item_links", "items": { "$ref": "#/components/schemas/commonLink" }, "x-displayname": "Links", "x-f5xc-description-short": "Links that will be presented to the user.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "items": { "type": "array", "description": "Response will have different types of widgets.", "title": "Items", "items": { "$ref": "#/components/schemas/widgetWidgetView" }, "x-displayname": "Widget View.", "x-f5xc-example": "[\"item1\", \"item2\", \"item3\"]", "x-f5xc-description-short": "Response will have different types of widgets.", "x-f5xc-constraints": { "constraintType": "array", "category": "general", "minItems": 0, "maxItems": 256, "uniqueItems": false, "metadata": { "source": "inferred", "confidence": 0.7, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "summary": { "type": "string", "description": "Configuration parameter for summary", "title": "summary", "x-displayname": "Summary", "x-ves-example": "This is summary of widget response.", "x-f5xc-example": "This is summary of widget response", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for widgetWidgetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "widgetWidgetView": { "type": "object", "x-ves-proto-message": "ves.io.schema.ai_assistant.widget.WidgetView", "properties": { "item": { "allOf": [ { "$ref": "#/components/schemas/widgetTable" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "maxLength": 26, "minLength": 15, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for widgetWidgetView", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bfdpEnableFeatureRequest": { "type": "object", "description": "Any payload to be passed on the GET Provision API.", "title": "EnableFeatureRequest", "x-displayname": "EnableFeature Request.", "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.EnableFeatureRequest", "x-f5xc-description-short": "Any payload to be passed on the GET Provision API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bfdpEnableFeatureRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bfdpEnableFeatureResponse": { "type": "object", "description": "Any payload to be passed on the GET Provision API.", "title": "EnableFeatureResponse", "x-displayname": "EnableFeature Response.", "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.EnableFeatureResponse", "x-f5xc-description-short": "Any payload to be passed on the GET Provision API.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bfdpEnableFeatureResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bfdpRefreshTokenRequest": { "type": "object", "description": "API to refresh token for a given pipeline.", "title": "RefreshTokenRequest", "x-displayname": "Refresh Token Request.", "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.RefreshTokenRequest", "properties": { "product_name": { "type": "string", "description": "Product_name is a pipeline name for which token to be generated.", "title": "product_name", "x-displayname": "Product_name.", "x-ves-example": "Product_name.", "x-f5xc-example": "product_name", "x-f5xc-description-short": "Product_name is a pipeline name for which token to be generated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "API to refresh token for a given pipeline.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bfdpRefreshTokenRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "users", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "bfdpRefreshTokenResponse": { "type": "object", "description": "Refresh token result.", "title": "RefreshTokenResponse", "x-displayname": "Refresh Token Response.", "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.RefreshTokenResponse", "properties": { "result": { "type": "string", "description": "Result will be in JSON format having token in it.", "title": "result", "x-displayname": "Result", "x-ves-example": "Result", "x-f5xc-example": "result", "x-f5xc-description-short": "Result will be in JSON format having token in it.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for bfdpRefreshTokenResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "users", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "subscriptionSubscribeRequest__ves_io_schema_ai_data_bfdp_subscription": { "type": "object", "description": "Request to subscribe to BFDP CMS.", "title": "SubscribeRequest", "x-displayname": "Subscribe Request.", "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.subscription.SubscribeRequest", "properties": { "product_name": { "type": "string", "description": "F5 product's pipeline object name .", "title": "product_name", "x-displayname": "Product_name.", "x-ves-example": "Product name.", "x-f5xc-example": "product name", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionSubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionSubscribeResponse__ves_io_schema_ai_data_bfdp_subscription": { "type": "object", "description": "Response of subscribe to BFDP CMS.", "title": "SubscribeResponse", "x-displayname": "Subscribe Response.", "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.subscription.SubscribeResponse", "properties": { "configured_tenant_id": { "type": "string", "description": "F5 product's pipeline configured tenant .", "title": "configured_tenant_id", "x-displayname": "Configured_tenant_id.", "x-ves-example": "Configured Tenant.", "x-f5xc-example": "Configured Tenant", "x-f5xc-description-short": "F5 product's pipeline configured tenant .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "pipeline_id": { "type": "string", "description": "F5 product's pipeline ID for which this tenant is configured.", "title": "pipleine_id", "x-displayname": "Pipleine_id.", "x-ves-example": "Pipleine_id.", "x-f5xc-example": "pipleine_id", "x-f5xc-description-short": "F5 product's pipeline ID for which this tenant is configured.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "pipeline_name": { "type": "string", "description": "F5 product's pipeline name for which this tenant is configured.", "title": "pipeline_name", "x-displayname": "Pipeline_name.", "x-ves-example": "Pipeline_name.", "x-f5xc-example": "pipeline_name", "x-f5xc-description-short": "F5 product's pipeline name for which this tenant is configured.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "token": { "type": "string", "description": "F5 product's pipeline token to ingest data .", "title": "token", "x-displayname": "Token", "x-ves-example": "Token name.", "x-f5xc-example": "example", "x-f5xc-description-short": "F5 product's pipeline token to ingest data .", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "security", "maxLength": 1024, "minLength": 20, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionSubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionTokenRequest": { "type": "object", "description": "Request to subscribe to BFDP CMS.", "title": "TokenRequest", "x-displayname": "Token Request.", "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.subscription.TokenRequest", "properties": { "product_name": { "type": "string", "description": "F5 product's pipeline object name .", "title": "product_name", "x-displayname": "Product_name.", "x-ves-example": "Product name.", "x-f5xc-example": "product name", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionTokenRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "users", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionTokenResponse": { "type": "object", "description": "Request to subscribe to BFDP CMS.", "title": "TokenResponse", "x-displayname": "Token Response.", "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.subscription.TokenResponse", "properties": { "token": { "type": "string", "description": "F5 product's pipeline object name .", "title": "product_name", "x-displayname": "Token", "x-ves-example": "Workload identity JSON string or oauth2 token.", "x-f5xc-example": "example", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "security", "maxLength": 1024, "minLength": 20, "metadata": { "source": "inferred", "confidence": 0.75, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionTokenResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "users", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionUnsubscribeRequest__ves_io_schema_ai_data_bfdp_subscription": { "type": "object", "description": "Request to unsubscribe to BFDP CMS.", "title": "UnsubscribeRequest", "x-displayname": "Unsubscribe Request.", "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.subscription.UnsubscribeRequest", "properties": { "product_name": { "type": "string", "description": "F5 product's pipeline object name .", "title": "product_name", "x-displayname": "Product_name.", "x-ves-example": "Product name.", "x-f5xc-example": "product name", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionUnsubscribeRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "subscriptionUnsubscribeResponse__ves_io_schema_ai_data_bfdp_subscription": { "type": "object", "description": "Response of unsubscribe to BFDP CMS.", "title": "UnsubscribeResponse", "x-displayname": "Unsubscribe Response.", "x-ves-proto-message": "ves.io.schema.ai_data.bfdp.subscription.UnsubscribeResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for subscriptionUnsubscribeResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "billing_and_usage", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Subscriptions are platform-level billing" }, "classification": { "category": "application", "multi_tenant_pattern": "none" } } }, "giaAllocateIPRequest": { "type": "object", "description": "This is the input message of the 'AllocateIP' RPC.", "title": "AllocateIP Request", "x-displayname": "AllocateIP Request.", "x-ves-proto-message": "ves.io.schema.gia.AllocateIPRequest", "properties": { "context": { "type": "string", "description": "This is the global IP allocator context from which IP allocation will happen\nOptional: If not specified, gia will try to allocate IP from default IP range.", "title": "context", "x-displayname": "Context", "x-ves-example": "App-VIP-pool-1.", "x-f5xc-example": "app-vip-pool-1", "x-f5xc-description-short": "Global IP allocator context from which IP allocation will happen Optional: If not specified, gia will try to allocate IP from default IP range.", "x-f5xc-description-medium": "Global IP allocator context from which IP allocation will happen Optional: If not specified, gia will try to allocate IP from default IP range.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "use_v6_range": { "type": "boolean", "description": "Optional: If not specified, v4 range for this tenant will be used.", "title": "use_v6_range", "format": "boolean", "x-displayname": "Use IPv6 Range.", "x-f5xc-example": "false", "x-f5xc-description-short": "Optional: If not specified, v4 range for this tenant will be used.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for giaAllocateIPRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "giaAllocateIPResponse": { "type": "object", "description": "This is the output message of the 'AllocateIP' RPC.", "title": "AllocateIP Response", "x-displayname": "AllocateIP Response.", "x-ves-proto-message": "ves.io.schema.gia.AllocateIPResponse", "properties": { "error_message": { "type": "string", "description": "Error message from global IP allocator.", "title": "error_message", "x-displayname": "Error message.", "x-ves-example": "GIA Internal Error.", "x-f5xc-example": "GIA Internal Error", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip": { "type": "string", "description": "IPv4 address in dotted decimal notation (e.g., 192.0.2.1)", "title": "ip address", "x-displayname": "IP Address allocated.", "x-ves-example": "192.0.2.56.", "x-f5xc-example": "192.0.2.56", "x-f5xc-description-short": "IPv4 address in dotted decimal notation (e.g., 192.0.2.1).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for giaAllocateIPResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "giaDeallocateIPRequest": { "type": "object", "description": "This is the input message of the 'DeAllocateIP' RPC.", "title": "DeAllocateIPRequest is used to deallocate an ip", "x-displayname": "DeAllocateIP Request.", "x-ves-proto-message": "ves.io.schema.gia.DeallocateIPRequest", "properties": { "context": { "type": "string", "description": "This is the global IP allocator context from which IP deallocation will happen\nOptional: If not specified, gia will try to deallocate given IP from default IP range.", "title": "context", "x-displayname": "Context", "x-ves-example": "App-VIP-pool-1.", "x-f5xc-example": "app-vip-pool-1", "x-f5xc-description-short": "Global IP allocator context from which IP deallocation will happen Optional: If not specified, gia will try to deallocate given IP from default IP...", "x-f5xc-description-medium": "Global IP allocator context from which IP deallocation will happen Optional: If not specified, gia will try to deallocate given IP from default IP range.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "ip": { "type": "string", "description": "IP which needs to de-allocated.", "title": "ip address", "x-displayname": "IP Address.", "x-ves-example": "192.0.2.56.", "x-ves-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "x-f5xc-example": "192.0.2.56", "x-validation-rules": { "ves.io.schema.rules.string.ip": "true" }, "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1024, "format": "ip", "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Input message of the 'DeAllocateIP' RPC.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for giaDeallocateIPRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } }, "giaDeallocateIPResponse": { "type": "object", "description": "This is the output message of the 'DeAllocateIP' RPC.", "title": "DeallocateIP Response", "x-displayname": "DeAllocateIP Response.", "x-ves-proto-message": "ves.io.schema.gia.DeallocateIPResponse", "properties": { "message": { "type": "string", "description": "Message from global IP allocator.", "title": "message", "x-displayname": "Message", "x-ves-example": "IP de-allocated successfully.", "x-f5xc-example": "IP de-allocated successfully", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Output message of the 'DeAllocateIP' RPC.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for giaDeallocateIPResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "application", "multi_tenant_pattern": "per-tenant" } } } }, "responses": {}, "parameters": {}, "requestBodies": {} } }