LCORE-632: regenerated OpenAPI doc

[tisnik]

Description

LCORE-632: regenerated OpenAPI doc

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

Related Tickets & Documents

• Related Issue #LCORE-632

Summary by CodeRabbit

• Documentation
  • Expanded OpenAPI documentation with clearer field descriptions and example payloads across multiple request/response models.
  • Clarified conversation_id (UUID), chat_history structure, response/feedback fields, authorization detail messages, rag_chunks meaning, and status reporting.
  • Enhanced descriptions for health, configuration, and related endpoints to better convey usage and expectations.
  • Improved readability and consistency across reference docs.
  • No changes to API behavior or data structures; request/response formats remain unchanged.

[coderabbitai]

Walkthrough

OpenAPI documentation fields were enriched with titles, descriptions, and examples across schemas. Updates touch conversation_id, chat_history, response, detail, rag_chunks, status, authorization responses, and various health/config endpoints. No schema shapes, behavior, or control flow changed; edits are limited to documentation metadata in JSON and Markdown.

Changes

Cohort / File(s)	Summary of Changes
OpenAPI spec docs docs/openapi.json, docs/openapi.md	Added/expanded titles, descriptions, and examples for fields (conversation_id, chat_history, response, detail, rag_chunks, status) across multiple response/request schemas; clarified authorization-related responses; enhanced health/config/status documentation blocks. No structural or behavioral changes.
Rendered docs output docs/output.md	Synchronized narrative/descriptive field text for the same models and attributes; populated previously generic or blank descriptions; no logic or schema alterations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• LCORE-304: OpenAPI documentation in Markdown #259 — Introduced/modified the same OpenAPI spec files; this PR refines their field descriptions and examples.
• LCORE-336: Regenerate OpenAPI schema #344 — Changed chat_history structure; this PR adds descriptions/examples for that field in related responses.
• LCORE-632: Regenerated OpenAPI specification #590 — Updated QueryResponse (e.g., rag_chunks); this PR documents rag_chunks with clearer descriptions/examples.

Poem

I twitch my ears at fields made clear,
UUIDs hop far, yet land right here.
Rag chunks nibble facts in rows,
Status sprouts where clarity grows.
With docs all tidy, crisp, and bright—
This bunny signs: “Ship it, light!” 🐇✨

Pre-merge checks and finishing touches

✅ 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 references the primary change—regenerating the OpenAPI documentation—and includes the related issue identifier, making it clear and concise for reviewers to understand the scope of the update without extraneous details. It accurately reflects the main content of the pull request, which is limited to documentation metadata updates. The phrasing is succinct and avoids listing files or using vague terminology.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

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

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 65b3026 and 7318e77.

📒 Files selected for processing (3)

• docs/openapi.json (6 hunks)
• docs/openapi.md (6 hunks)
• docs/output.md (6 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: build-pr
• GitHub Check: e2e_tests

---

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.}