LCORE-304: Sync docs

[tisnik]

Description

Sync docs

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-304

Summary by CodeRabbit

• New Features

  • Added a new endpoint for authorization checks, providing detailed authorized, unauthorized, and forbidden responses.
  • Introduced enhanced configuration options for authentication, customization, and data collection, including new settings for system prompts and data collector behavior.

• Improvements

  • Updated error responses for several endpoints to provide clearer feedback on authorization and access issues.
  • Expanded configuration schemas to support more customization and control over system behavior.

• Other Changes

  • Health check endpoints were restructured for improved clarity and consistency.

[coderabbitai]

Walkthrough

The configuration UML diagram and OpenAPI specification were updated to introduce new classes and schemas for authentication, customization, and data collection. Several endpoints were restructured, with health check endpoints moved and an authorization endpoint added. Error response schemas were expanded, and configuration options for customization and data collection were enhanced.

Changes

File(s)	Change Summary
docs/config.puml	Added AuthenticationConfiguration, Customization, and DataCollectorConfiguration classes; updated relationships and attributes in configuration-related classes.
docs/openapi.json	Revised endpoints (added /authorized, restructured health checks), introduced new response and configuration schemas, expanded error handling, and extended customization/data collection options.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant AuthService

    Client->>API: POST /authorized (credentials)
    API->>AuthService: Validate credentials
    AuthService-->>API: AuthorizedResponse / UnauthorizedResponse / ForbiddenResponse
    API-->>Client: Response (Authorized/Unauthorized/Forbidden)

Loading

sequenceDiagram
    participant Client
    participant API

    Client->>API: GET /readiness or /liveness
    API-->>Client: ReadinessResponse / LivenessResponse

Loading

Poem

A bunny with specs and a UML chart,
Hopped through configs with a clever heart.
New endpoints for health, and auth checks too,
Custom prompts and data—so much to do!
With schemas extended and docs all anew,
This rabbit’s delighted to share it with you!
🐇✨

---

📜 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 cb329b7 and d17c81f.

⛔ Files ignored due to path filters (1)

• docs/config.png is excluded by !**/*.png

📒 Files selected for processing (2)

• docs/config.puml (2 hunks)
• docs/openapi.json (9 hunks)

🔇 Additional comments (16)

docs/config.puml (5)

3-9: New AuthenticationConfiguration class looks well-structured.

The class definition includes appropriate fields for Kubernetes authentication (certificate path, cluster API URL) and TLS configuration. The validation method check_authentication_model() follows the established pattern.

---

11-12: Configuration class properly extended with new optional fields.

The addition of authentication and customization as optional fields maintains backward compatibility while enabling new functionality.

---

20-25: Customization class implementation looks correct.

The class includes system prompt configuration options and the new disable_query_system_prompt boolean field, which aligns with the OpenAPI schema additions.

---

26-35: DataCollectorConfiguration class comprehensive and well-designed.

The class covers all necessary aspects of data collection configuration including ingress server details, collection intervals, cleanup settings, and connection timeouts. The field types and validation method follow the established patterns.

---

65-65: UserDataCollection properly extended with data collector integration.

The addition of the data_collector field and corresponding composition relationship correctly integrates the new DataCollectorConfiguration into the existing structure.

Also applies to: 72-72

docs/openapi.json (11)

137-156: Query endpoint error responses updated for authentication flow.

The changes from 503/422 errors to 400/403 errors with proper authentication response schemas (UnauthorizedResponse/ForbiddenResponse) correctly reflect the new authentication requirements.

---

177-216: Streaming query endpoint properly restructured.

The endpoint now has a proper POST method with QueryRequest body requirement and appropriate response schemas, which is more consistent with the regular query endpoint.

---

315-334: Feedback endpoint enhanced with authentication error responses.

The addition of 400/403 error responses with proper authentication schemas ensures consistency across all protected endpoints.

---

370-433: Health check endpoints correctly moved to root paths.

The migration from /v1/readiness and /v1/liveness to /readiness and /liveness follows standard Kubernetes health check conventions. The response schemas are properly defined.

---

434-475: New authorization endpoint well-defined.

The /authorized POST endpoint provides proper authentication checking functionality with comprehensive response schemas for success, unauthorized, and forbidden states.

---

562-586: AuthorizedResponse schema properly structured.

The schema includes required user identification fields (user_id, username) with appropriate examples and documentation.

---

647-651: Customization schema enhanced with disable_query_system_prompt field.

The addition of the boolean field with default value false aligns with the UML diagram and provides proper system prompt control functionality.

---

680-741: DataCollectorConfiguration schema comprehensive and well-defined.

The schema covers all aspects of data collection configuration with proper type definitions, constraints, and default values. The structure matches the UML diagram perfectly.

---

821-839: ForbiddenResponse schema appropriately defined.

Simple but effective schema for forbidden access responses with proper documentation and examples.

---

1296-1314: UnauthorizedResponse schema properly structured.

Clear schema for unauthorized access responses with appropriate documentation and examples.

---

1349-1357: UserDataCollection schema properly extended.

The addition of the data_collector field with default configuration values maintains backward compatibility while enabling new data collection functionality. The structure aligns with the UML diagram.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.