From 61bdc56892b7fa4dba318a4c51bd48ede6b43a1c Mon Sep 17 00:00:00 2001 From: Pavel Tisnovsky Date: Sun, 12 Apr 2026 09:16:02 +0200 Subject: [PATCH] LCORE-1348: Regenerated OpenAPI doc --- docs/openapi.json | 50 ++++++++++++++++++++++++++++++++++++++++++++++- docs/openapi.md | 21 ++++++++++++++++++-- 2 files changed, 68 insertions(+), 3 deletions(-) diff --git a/docs/openapi.json b/docs/openapi.json index aa6a96455..6460e658d 100644 --- a/docs/openapi.json +++ b/docs/openapi.json @@ -4770,6 +4770,26 @@ } } }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NotFoundResponse" + }, + "examples": { + "model": { + "value": { + "detail": { + "cause": "Model with ID gpt-4-turbo is not configured", + "response": "Model not found" + } + } + } + } + } + } + }, "413": { "description": "Prompt is too long", "content": { @@ -9157,7 +9177,35 @@ "title": "Call Id" }, "output": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/OpenAIResponseInputMessageContentText" + }, + { + "$ref": "#/components/schemas/OpenAIResponseInputMessageContentImage" + }, + { + "$ref": "#/components/schemas/OpenAIResponseInputMessageContentFile" + } + ], + "discriminator": { + "propertyName": "type", + "mapping": { + "input_file": "#/components/schemas/OpenAIResponseInputMessageContentFile", + "input_image": "#/components/schemas/OpenAIResponseInputMessageContentImage", + "input_text": "#/components/schemas/OpenAIResponseInputMessageContentText" + } + } + }, + "type": "array" + } + ], "title": "Output" }, "type": { diff --git a/docs/openapi.md b/docs/openapi.md index cbb633868..d6d77d7db 100644 --- a/docs/openapi.md +++ b/docs/openapi.md @@ -66,6 +66,7 @@ Returns: HTMLResponse: The HTML content of the index page, including a heading, embedded image with the service icon, and links to the API documentation via Swagger UI and ReDoc. +Handle GET requests to the root ("/") endpoint and returns the static HTML index page. @@ -4463,6 +4464,7 @@ Global service configuration. | a2a_state | | Configuration for A2A protocol persistent state storage. | | quota_handlers | | Quota handlers configuration | | azure_entra_id | | | +| rlsapi_v1 | | Configuration for the rlsapi v1 /infer endpoint used by the RHEL Lightspeed Command Line Assistant (CLA). | | splunk | | Splunk HEC configuration for sending telemetry events. | | deployment_environment | string | Deployment environment name (e.g., 'development', 'staging', 'production'). Used in telemetry events. | | rag | | Configuration for all RAG strategies (inline and tool-based). | @@ -4727,7 +4729,6 @@ Service customization. | agent_card_path | | | | agent_card_config | | | | custom_profile | | | -| allow_verbose_infer | boolean | | ## DatabaseConfiguration @@ -5467,7 +5468,7 @@ This represents the output of a function call that gets passed back to the model | Field | Type | Description | |-------|------|-------------| | call_id | string | | -| output | string | | +| output | | | | type | string | | | id | | | | status | | | @@ -6661,6 +6662,22 @@ Attributes: | version | string | Command line assistant version | +## RlsapiV1Configuration + + +Configuration for the rlsapi v1 /infer endpoint. + +Settings specific to the RHEL Lightspeed Command Line Assistant (CLA) +stateless inference endpoint. Kept separate from shared configuration +sections so that CLA-specific options do not affect other endpoints. + + +| Field | Type | Description | +|-------|------|-------------| +| allow_verbose_infer | boolean | Allow /v1/infer to return extended metadata (tool_calls, rag_chunks, token_usage) when the client sends "include_metadata": true. Should NOT be enabled in production. If production use is needed, consider RBAC-based access control via an Action.RLSAPI_V1_INFER authorization rule. | +| quota_subject | | Identity field used as the quota subject for /v1/infer. When set, token quota enforcement is enabled for this endpoint. Requires quota_handlers to be configured. "org_id" and "system_id" require rh-identity authentication; falls back to user_id when rh-identity data is unavailable. | + + ## RlsapiV1Context