Merge pull request #1158 from tisnik/lcore-1332-update-openapi-schema-and-configuration-documentation

LCORE-1332: update OpenAPI schema and configuration documentation

Author: tisnik

docs/config.html

@@ -602,6 +602,11 @@ <h2 id="configuration">Configuration</h2>
           <td>Deployment environment name (e.g., &#x2018;development&#x2019;, &#x2018;staging&#x2019;,
 &#x2018;production&#x2019;). Used in telemetry events.</td>
         </tr>
+        <tr class="even">
+          <td>solr</td>
+          <td/>
+          <td>Configuration for Solr vector search operations.</td>
+        </tr>
       </tbody>
     </table>
     <h2 id="conversationhistoryconfiguration">ConversationHistoryConfiguration</h2>
@@ -1406,6 +1411,39 @@ <h2 id="serviceconfiguration">ServiceConfiguration</h2>
         </tr>
       </tbody>
     </table>
+    <h2 id="solrconfiguration">SolrConfiguration</h2>
+    <p>Solr configuration for vector search queries.</p>
+    <p>Controls whether to use offline or online mode when building document
+URLs from vector search results, and enables/disables Solr vector IO
+functionality.</p>
+    <table>
+      <colgroup>
+        <col style="width: 26%"/>
+        <col style="width: 23%"/>
+        <col style="width: 50%"/>
+      </colgroup>
+      <thead>
+        <tr class="header">
+          <th>Field</th>
+          <th>Type</th>
+          <th>Description</th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr class="odd">
+          <td>enabled</td>
+          <td>boolean</td>
+          <td>When True, enables Solr vector IO functionality for vector search
+queries. When False, disables Solr vector search processing.</td>
+        </tr>
+        <tr class="even">
+          <td>offline</td>
+          <td>boolean</td>
+          <td>When True, use parent_id for chunk source URLs. When False, use
+reference_url for chunk source URLs.</td>
+        </tr>
+      </tbody>
+    </table>
     <h2 id="splunkconfiguration">SplunkConfiguration</h2>
     <p>Splunk HEC (HTTP Event Collector) configuration.</p>
     <p>Splunk HEC allows sending events directly to Splunk over HTTP/HTTPS.

docs/config.json

@@ -466,6 +466,19 @@
             "description": "Deployment environment name (e.g., 'development', 'staging', 'production'). Used in telemetry events.",
             "title": "Deployment environment",
             "type": "string"
+          },
+          "solr": {
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/SolrConfiguration"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "default": null,
+            "description": "Configuration for Solr vector search operations.",
+            "title": "Solr configuration"
           }
         },
         "required": [
@@ -1169,6 +1182,26 @@
         "title": "ServiceConfiguration",
         "type": "object"
       },
+      "SolrConfiguration": {
+        "additionalProperties": false,
+        "description": "Solr configuration for vector search queries.\n\nControls whether to use offline or online mode when building document URLs\nfrom vector search results, and enables/disables Solr vector IO functionality.",
+        "properties": {
+          "enabled": {
+            "default": false,
+            "description": "When True, enables Solr vector IO functionality for vector search queries. When False, disables Solr vector search processing.",
+            "title": "Solr enabled",
+            "type": "boolean"
+          },
+          "offline": {
+            "default": true,
+            "description": "When True, use parent_id for chunk source URLs. When False, use reference_url for chunk source URLs.",
+            "title": "Offline mode",
+            "type": "boolean"
+          }
+        },
+        "title": "SolrConfiguration",
+        "type": "object"
+      },
       "SplunkConfiguration": {
         "additionalProperties": false,
         "description": "Splunk HEC (HTTP Event Collector) configuration.\n\nSplunk HEC allows sending events directly to Splunk over HTTP/HTTPS.\nThis configuration is used to send telemetry events for inference\nrequests to the corporate Splunk deployment.\n\nUseful resources:\n\n  - [Splunk HEC Docs](https://docs.splunk.com/Documentation/SplunkCloud)\n  - [About HEC](https://docs.splunk.com/Documentation/Splunk/latest/Data)",

docs/config.md

@@ -170,6 +170,7 @@ Global service configuration.
 | azure_entra_id |  |  |
 | splunk |  | Splunk HEC configuration for sending telemetry events. |
 | deployment_environment | string | Deployment environment name (e.g., 'development', 'staging', 'production'). Used in telemetry events. |
+| solr |  | Configuration for Solr vector search operations. |
 
 
 ## ConversationHistoryConfiguration
@@ -517,6 +518,21 @@ the service can handle requests concurrently.
 | cors |  | Cross-Origin Resource Sharing configuration for cross-domain requests |
 
 
+## SolrConfiguration
+
+
+Solr configuration for vector search queries.
+
+Controls whether to use offline or online mode when building document URLs
+from vector search results, and enables/disables Solr vector IO functionality.
+
+
+| Field | Type | Description |
+|-------|------|-------------|
+| enabled | boolean | When True, enables Solr vector IO functionality for vector search queries. When False, disables Solr vector search processing. |
+| offline | boolean | When True, use parent_id for chunk source URLs. When False, use reference_url for chunk source URLs. |
+
+
 ## SplunkConfiguration
 
 

docs/config.png

@@ -71,6 +71,7 @@ class "Configuration" as src.models.config.Configuration {
   name : str
   quota_handlers
   service
+  solr : Optional[SolrConfiguration]
   splunk : Optional[SplunkConfiguration]
   user_data_collection
   dump(filename: str | Path) -> None
@@ -201,9 +202,15 @@ class "ServiceConfiguration" as src.models.config.ServiceConfiguration {
   cors
   host : str
   port
+  root_path : str
   tls_config
   workers
   check_service_configuration() -> Self
+  validate_root_path(value: str) -> str
+}
+class "SolrConfiguration" as src.models.config.SolrConfiguration {
+  enabled : bool
+  offline : bool
 }
 class "SplunkConfiguration" as src.models.config.SplunkConfiguration {
   enabled : bool
@@ -254,6 +261,7 @@ src.models.config.QuotaSchedulerConfiguration --|> src.models.config.Configurati
 src.models.config.RHIdentityConfiguration --|> src.models.config.ConfigurationBase
 src.models.config.SQLiteDatabaseConfiguration --|> src.models.config.ConfigurationBase
 src.models.config.ServiceConfiguration --|> src.models.config.ConfigurationBase
+src.models.config.SolrConfiguration --|> src.models.config.ConfigurationBase
 src.models.config.SplunkConfiguration --|> src.models.config.ConfigurationBase
 src.models.config.TLSConfiguration --|> src.models.config.ConfigurationBase
 src.models.config.UserDataCollection --|> src.models.config.ConfigurationBase