Fields for responses

[tisnik]

Description

Fields for responses

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

Summary by CodeRabbit

• Documentation

  • Enhanced API documentation and schemas with clearer field descriptions and example payloads for query results and common error responses (Unauthorized, Not Available). Improves generated docs and client SDK usability.

• Chores

  • Standardized metadata and defaults for response fields to ensure consistent payload shapes across the API without altering behavior.

[coderabbitai]

Walkthrough

Updates Pydantic Field declarations in response models to add descriptions and examples without changing types or logic: wraps rag_chunks, NotAvailableResponse.detail, and UnauthorizedResponse.detail with Field metadata in src/models/responses.py.

Changes

Cohort / File(s)	Summary of changes
Response models metadata updates src/models/responses.py	Converted plain attributes to Pydantic Field with descriptions/examples: QueryResponse.rag_chunks (list[RAGChunk]), NotAvailableResponse.detail (dict[str,str]), UnauthorizedResponse.detail (str). No logic or signatures changed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A whisk of ears, I tweak the schema’s tune,
Add notes of docs beneath a silver moon.
Fields now speak with clearer, gentle lore—
Same shapes, new labels at the model’s door.
Thump-thump! I hop—metadata in bloom.

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The title “Fields for responses” is overly generic and does not clearly convey that the change adds Pydantic Field metadata and descriptions to specific response model attributes, so it does not clearly summarize the main change.	Please refine the title to explicitly mention that Pydantic Field metadata and descriptions are being added to the response models, for example “Add Pydantic Field metadata to response model attributes.”

✅ 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 changes. Docstring coverage check skipped.

✨ Finishing touches

• 📝 Generate docstrings

🧪 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 145f5e8 and dcf6596.

📒 Files selected for processing (1)

• src/models/responses.py (3 hunks)

🧰 Additional context used

📓 Path-based instructions (4)

src/**/*.py

📄 CodeRabbit inference engine (CLAUDE.md)

Use absolute imports for internal modules (e.g., from auth import get_auth_dependency)

Files:

• src/models/responses.py

**/*.py

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.py: All modules start with descriptive module-level docstrings explaining purpose
Use logger = logging.getLogger(name) for module logging after import logging
Define type aliases at module level for clarity
All functions require docstrings with brief descriptions
Provide complete type annotations for all function parameters and return types
Use typing_extensions.Self in model validators where appropriate
Use modern union syntax (str | int) and Optional[T] or T | None consistently
Function names use snake_case with descriptive, action-oriented prefixes (get_, validate_, check_)
Avoid in-place parameter modification; return new data structures instead of mutating arguments
Use appropriate logging levels: debug, info, warning, error with clear messages
All classes require descriptive docstrings explaining purpose
Class names use PascalCase with conventional suffixes (Configuration, Error/Exception, Resolver, Interface)
Abstract base classes should use abc.ABC and @AbstractMethod for interfaces
Provide complete type annotations for all class attributes
Follow Google Python docstring style for modules, classes, and functions, including Args, Returns, Raises, Attributes sections as needed

Files:

• src/models/responses.py

src/{models/**/*.py,configuration.py}

📄 CodeRabbit inference engine (CLAUDE.md)

src/{models/**/*.py,configuration.py}: Use @field_validator and @model_validator for custom validation in Pydantic models
Use precise type hints in configuration (e.g., Optional[FilePath], PositiveInt, SecretStr)

Files:

• src/models/responses.py

src/models/**/*.py

📄 CodeRabbit inference engine (CLAUDE.md)

src/models/**/*.py: Pydantic models: use BaseModel for data models and extend ConfigurationBase for configuration
Use @model_validator and @field_validator for Pydantic model validation

Files:

• src/models/responses.py

⏰ 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

🔇 Additional comments (3)

src/models/responses.py (3)

99-102: LGTM! Improved API documentation.

The Field wrapper adds a clear description while preserving the default empty list behavior. This change aligns with other fields in the class and improves OpenAPI schema generation.

---

316-329: LGTM! Enhanced error response documentation.

The Field wrapper adds a description and inline examples for better API documentation. The ellipsis correctly preserves the required field status, and the examples align with the model_config.

---

452-456: LGTM! Clearer authorization error documentation.

The Field wrapper adds a description and example for better API clarity. The ellipsis correctly preserves the required field status. Note that the inline example differs slightly from the model_config example, but both are valid representations of authorization issues.

---

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