LCORE-1332: update OpenAPI schema and configuration documentation

[tisnik]

Description

LCORE-1332: update OpenAPI schema and configuration documentation

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library
• Bump-up library or tool used for development (does not change the final image)
• CI configuration change
• Konflux configuration change
• Unit tests improvement
• Integration tests improvement
• End to end tests improvement
• Benchmarks improvement

Tools used to create PR

• Assisted-by: N/A
• Generated by: N/A

Related Tickets & Documents

• Related Issue #LCORE-1332

Summary by CodeRabbit

• New Features

  • Added Solr vector search configuration support, allowing users to enable/disable vector operations and configure offline mode for Solr indexing.

• Documentation

  • Updated configuration documentation and API specifications to expose new Solr integration parameters and refine error response handling.

[coderabbitai]

Walkthrough

This PR introduces Solr vector search configuration support by adding a new SolrConfiguration schema with enabled and offline boolean fields across multiple documentation formats (HTML, JSON, Markdown, PlantUML, and OpenAPI). It also removes 413 Payload Too Large error responses from API endpoints and integrates the Solr configuration into the Configuration and QueryRequest schemas.

Changes

Cohort / File(s)	Summary
Configuration Schema Updates docs/config.html, docs/config.json, docs/config.md	Adds new SolrConfiguration section with enabled and offline boolean fields. Extends Configuration schema with optional solr property linking to SolrConfiguration.
Diagram Updates docs/config.puml	Adds SolrConfiguration as a ConfigurationBase subtype with boolean fields and introduces solr property to Configuration and root_path/validation method to ServiceConfiguration.
OpenAPI Specification docs/openapi.json, docs/openapi.md	Adds SolrConfiguration schema component. Extends Configuration and QueryRequest with optional solr field. Removes 413 Payload Too Large error responses from root GET/POST endpoints.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• LCORE-304: OpenAPI documentation in Markdown #259: Establishes the initial OpenAPI and Markdown documentation structure that this PR extends with Solr configuration additions.
• LCORE-248: regenerated OpenAPI schema #338: Modifies the same QueryRequest schema in docs/openapi.json by adding a no_tools property alongside this PR's solr field addition.
• LCORE-293: Updated OpenAPI schema #217: Extends the Configuration schema with new optional fields similar to this PR's approach of adding solr property to Configuration.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly and clearly summarizes the main change: updating OpenAPI schema and configuration documentation, which aligns with all modified files (docs/config., docs/openapi.).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs/openapi.json (1)

7922-7951: ⚠️ Potential issue | 🟡 Minor

Document the new solr field in the QueryRequest description.

The schema adds solr, but the attribute list in the description text doesn’t mention it, which makes the generated docs incomplete.

✍️ Suggested doc update

-    vector_store_ids: The optional list of specific vector store IDs to query for RAG.
+    vector_store_ids: The optional list of specific vector store IDs to query for RAG.
+    solr: Optional Solr query parameters (for example, filter queries).

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/openapi.json` around lines 7922 - 7951, The QueryRequest description
text is missing the newly added solr field; update the QueryRequest
documentation block to include an entry for "solr" describing that it is an
optional Solr-specific parameter (object or null) containing Solr query
parameters such as filter queries (e.g., fq list), its purpose (to pass
Solr-specific query options), and that it is optional in the request; ensure the
attribute list alongside query, conversation_id, provider, etc., mentions solr
and optionally include the example shown in the schema to keep generated docs
consistent with the Solr examples.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/config.puml`:
- Around line 74-75: The UML diagram is missing the composition link for the new
solr field; add a composition relationship from Configuration to
SolrConfiguration (e.g., Configuration *-- SolrConfiguration) similar to the
existing SplunkConfiguration link so the diagram reflects the solr :
Optional[SolrConfiguration] attribute; ensure the link uses the same composition
style used for other config blocks (like SplunkConfiguration) and place it
alongside the existing relationships.

---

Outside diff comments:
In `@docs/openapi.json`:
- Around line 7922-7951: The QueryRequest description text is missing the newly
added solr field; update the QueryRequest documentation block to include an
entry for "solr" describing that it is an optional Solr-specific parameter
(object or null) containing Solr query parameters such as filter queries (e.g.,
fq list), its purpose (to pass Solr-specific query options), and that it is
optional in the request; ensure the attribute list alongside query,
conversation_id, provider, etc., mentions solr and optionally include the
example shown in the schema to keep generated docs consistent with the Solr
examples.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Add the SolrConfiguration composition link to the diagram.

Configuration now exposes solr, but the relationship list doesn’t show the composition link, so the diagram is incomplete compared to other config blocks.

🔧 Proposed UML addition

+src.models.config.SolrConfiguration --* src.models.config.Configuration : solr

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/config.puml` around lines 74 - 75, The UML diagram is missing the
composition link for the new solr field; add a composition relationship from
Configuration to SolrConfiguration (e.g., Configuration *-- SolrConfiguration)
similar to the existing SplunkConfiguration link so the diagram reflects the
solr : Optional[SolrConfiguration] attribute; ensure the link uses the same
composition style used for other config blocks (like SplunkConfiguration) and
place it alongside the existing relationships.