LCORE-1280: docs update

[tisnik]

Description

LCORE-1280: docs update

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

Tools used to create PR

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

Related Tickets & Documents

• Related Issue #LCORE-1280

Summary by CodeRabbit

Documentation

• Updated configuration documentation with new timeout settings for Llama Stack and MCP server requests (default: 180 seconds for long-running queries)
• Added support for A2A state persistence, Azure Entra ID authentication, and Splunk integration configurations
• Extended service configuration with base URL and agent card customization options
• Updated authentication options for health probe handling

[coderabbitai]

Walkthrough

This PR updates configuration documentation and API specifications to reflect new features including A2A state management, Azure Entra ID authentication, Splunk integration, and timeout configurations for Llama Stack and MCP servers. All changes are documentation-only across schema definitions and OpenAPI specifications.

Changes

Cohort / File(s)	Summary
Configuration Schema Documentation docs/config.json, docs/config.md, docs/config.html, docs/config.puml	Added new configuration schemas: A2AStateConfiguration, AzureEntraIdConfiguration, and SplunkConfiguration. Extended Configuration with a2a_state, azure_entra_id, splunk, and deployment_environment fields. Added timeout field to LlamaStackConfiguration (180s default). Updated Customization and CustomProfile with agent_card_path/agent_card_config fields. Added authorization_headers and timeout to ModelContextProtocolServer. Added skip_for_health_probes to AuthenticationConfiguration and base_url to ServiceConfiguration.
API Documentation docs/openapi.json, docs/openapi.md	Added timeout field to LlamaStackConfiguration and ModelContextProtocolServer in OpenAPI schema. Updated rlsapi/v1 /infer endpoint documentation to reference request object and background_tasks parameters. Updated A2A JSON-RPC endpoint operationId naming conventions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• LCORE-1225: updated documentation after Splunk patch was merged #1054: Adds SplunkConfiguration and deployment_environment fields to configuration documentation
• Add configuration for MCP servers, updated documentation, created man… #972: Updates timeout and ModelContextProtocolServer authorization/timeout-related configuration fields
• LCORE-1170: Updated configuration documentation #981: Adds A2AStateConfiguration, service base_url, and agent_card configuration entries

Suggested labels

ok-to-test

Suggested reviewers

• are-ces
• asimurka

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'LCORE-1280: docs update' is vague and generic, using non-descriptive terms that do not convey meaningful information about the specific documentation changes.	Replace with a more specific title that describes the main changes, such as 'Add A2A configuration and Splunk integration documentation' or 'Document new timeout, A2A state, and Azure Entra ID configurations'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
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

---

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: 0

Caution

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

⚠️ Outside diff range comments (2)

docs/openapi.md (1)

4859-4865: ⚠️ Potential issue | 🟡 Minor

Fix markdownlint MD060 table alignment for the timeout row.

The linter flags this row for column alignment; aligning the table resolves it.

🧹 Suggested alignment fix

-| Field | Type | Description |
-|-------|------|-------------|
-| url |  | URL to Llama Stack service; used when library mode is disabled |
-| api_key |  | API key to access Llama Stack service |
-| use_as_library_client |  | When set to true Llama Stack will be used in library mode, not in server mode (default) |
-| library_client_config_path |  | Path to configuration file used when Llama Stack is run in library mode |
-| timeout | integer | Timeout in seconds for requests to Llama Stack service. Default is 180 seconds (3 minutes) to accommodate long-running RAG queries. |
+| Field                      | Type    | Description |
+|----------------------------|---------|-------------|
+| url                        |         | URL to Llama Stack service; used when library mode is disabled |
+| api_key                    |         | API key to access Llama Stack service |
+| use_as_library_client      |         | When set to true Llama Stack will be used in library mode, not in server mode (default) |
+| library_client_config_path |         | Path to configuration file used when Llama Stack is run in library mode |
+| timeout                    | integer | Timeout in seconds for requests to Llama Stack service. Default is 180 seconds (3 minutes) to accommodate long-running RAG queries. |

docs/openapi.json (1)

4287-4312: ⚠️ Potential issue | 🟠 Major

Fix duplicate operationId on /a2a GET vs POST.

operationId must be unique in OpenAPI; both GET and POST are currently set to handle_a2a_jsonrpc_a2a_post, which will cause generator and client conflicts. Rename the GET operationId to handle_a2a_jsonrpc_a2a_get or remove the GET operation if intentionally deprecated.

🛠️ Suggested fix (rename GET operationId)

-                "operationId": "handle_a2a_jsonrpc_a2a_post",
+                "operationId": "handle_a2a_jsonrpc_a2a_get",

🧹 Nitpick comments (1)

docs/config.json (1)

430-434: Consider consistency: a2a_state uses direct $ref without anyOf/null pattern.

Other optional configuration fields like azure_entra_id and splunk use the anyOf: [$ref, null] pattern with default: null. The a2a_state field uses a direct $ref without this pattern, which could imply it's always required or has an implicit default object.

If a2a_state is intended to be optional with a null default (like other similar fields), consider updating it to match the pattern used for azure_entra_id and splunk.