LCORE-2755: Ability to dump common models

[tisnik]

Description

LCORE-2755: Ability to dump common models

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

Summary by CodeRabbit

• New Features

  • Expanded OpenAPI schema output to include additional conversation, transcript, moderation, tool, and vector search data models.

• Bug Fixes

  • Improved schema completeness so newly supported data types appear in generated API documentation.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: c79b618f-79a5-4d53-92f4-f59bb8566ded

📥 Commits

Reviewing files that changed from the base of the PR and between 0a018ba and cdc8cce.

📒 Files selected for processing (2)

• src/utils/models_dumper.py
• tests/unit/utils/test_models_dumper.py

📜 Recent review details

⏰ Context from checks skipped due to timeout. (17)

• GitHub Check: mypy
• GitHub Check: build-pr
• GitHub Check: black
• GitHub Check: spectral
• GitHub Check: unit_tests (3.13)
• GitHub Check: unit_tests (3.12)
• GitHub Check: Pylinter
• GitHub Check: integration_tests (3.12)
• GitHub Check: integration_tests (3.13)
• GitHub Check: E2E: server mode / ci / group 1
• GitHub Check: E2E: library mode / ci / group 2
• GitHub Check: E2E: library mode / ci / group 1
• GitHub Check: E2E: server mode / ci / group 3
• GitHub Check: E2E: library mode / ci / group 3
• GitHub Check: E2E: server mode / ci / group 2
• GitHub Check: E2E Tests for Lightspeed Evaluation job
• GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-0-7-on-pull-request

🧰 Additional context used

📓 Path-based instructions (6)

**/*

📄 CodeRabbit inference engine (Custom checks)

**/*: Flag meaningful O(n^2)+ algorithms on non-trivial inputs, including handlers and Kubernetes list operations.
Flag N+1 patterns that list items and then query once per item, including Kubernetes API and database access.
Flag expensive work inside loops, including API calls, JSON parsing, and regex compilation.
Flag unbounded growth in caches, watchers, or buffers when eviction or limits are missing.
Flag missing pagination or limits on list operations and API endpoints.
Flag secrets or tokens logged in plaintext or hardcoded in source.
Flag API endpoints missing authentication or authorization.
Flag injection vulnerabilities, including SQL injection, command injection, and path traversal.
Flag sensitive data leaked in API responses, WebSocket messages, or logs.
Flag Kubernetes Secrets and Red Hat secrets missing OwnerReferences.

Files:

• src/utils/models_dumper.py
• tests/unit/utils/test_models_dumper.py

**/*.py

📄 CodeRabbit inference engine (AGENTS.md)

**/*.py: Use absolute imports for internal Python modules.
Start every module with a descriptive docstring and use logger = get_logger(__name__) for module logging.
Define shared constants in the central constants.py module, use descriptive comments, and annotate constants with Final[type].
Use complete type annotations for function parameters and return values, modern union syntax, and typing_extensions.Self for model validators.
Document all modules, classes, and functions using Google-style Python docstrings, including applicable Parameters, Returns, Raises, and Attributes sections.
Use descriptive snake_case, action-oriented function names such as get_, validate_, and check_.
Avoid modifying input parameters in place; return a newly created data structure instead.
Use async def for I/O operations and external API calls.
Use standard logger levels appropriately: debug for diagnostics, info for normal execution, warning for unexpected conditions, and error for serious failures.
Name classes with PascalCase and use descriptive suffixes such as Configuration, Error/Exception, Resolver, and Interface where applicable.
Use ABC and @abstractmethod for abstract interfaces; provide complete, specific type annotations for class attributes and avoid Any.

Files:

• src/utils/models_dumper.py
• tests/unit/utils/test_models_dumper.py

src/**/*.py

📄 CodeRabbit inference engine (AGENTS.md)

Configuration models must extend ConfigurationBase, whose extra="forbid" behavior rejects unknown fields; use types such as Optional[FilePath], PositiveInt, and SecretStr where appropriate.

Files:

• src/utils/models_dumper.py

**/*.{py,yaml,yml,json,toml}

📄 CodeRabbit inference engine (AGENTS.md)

Never commit secrets or keys; use environment variables for sensitive data.

Files:

• src/utils/models_dumper.py
• tests/unit/utils/test_models_dumper.py

tests/unit/**/*.py

📄 CodeRabbit inference engine (AGENTS.md)

Use pytest for unit tests, shared fixtures in conftest.py, pytest-mock for mocks, and pytest.mark.asyncio for asynchronous tests; do not use unittest.

Files:

• tests/unit/utils/test_models_dumper.py

tests/**/*.py

📄 CodeRabbit inference engine (AGENTS.md)

Maintain at least 60% unit-test coverage and 10% integration-test coverage.

Files:

• tests/unit/utils/test_models_dumper.py

🧠 Learnings (2)

📚 Learning: 2026-06-24T13:45:37.249Z

Learnt from: Jdubrick
Repo: lightspeed-core/lightspeed-stack PR: 1971
File: src/utils/markdown_repair.py:31-36
Timestamp: 2026-06-24T13:45:37.249Z
Learning: In the lightspeed-stack repository, docstrings must use the section header name "Parameters:" (not "Args:") for function arguments, even if the project references Google Python docstring conventions. Ensure docstrings follow the project’s established "Parameters:" header format for any documented function parameters.

Applied to files:

• src/utils/models_dumper.py
• tests/unit/utils/test_models_dumper.py

📚 Learning: 2026-07-06T15:26:18.398Z

Learnt from: Jdubrick
Repo: lightspeed-core/lightspeed-stack PR: 2071
File: src/models/config.py:2416-2422
Timestamp: 2026-07-06T15:26:18.398Z
Learning: In this repo’s Python code under src/**, don’t treat differences in string concatenation style as a style inconsistency when Black has effectively forced (or made clearer) use of explicit `+` string concatenation in multi-line logger/string expressions. If adjacent-literal implicit concatenation is avoided/changed specifically to accommodate Black’s formatting in these call sites, accept the `+` usage and don’t recommend converting it solely for consistency with nearby blocks that use implicit concatenation.

Applied to files:

• src/utils/models_dumper.py

🔇 Additional comments (3)

src/utils/models_dumper.py (2)

6-6: LGTM!

---

102-122: 🎯 Functional Correctness

No additional common-model exports need to be added here.

tests/unit/utils/test_models_dumper.py (1)

2542-2564: LGTM!

Also applies to: 5549-5577, 6990-7031, 7340-7366, 7400-7428, 7510-7621, 7665-7769, 8682-8682, 8753-8753, 8779-8780, 8790-8799

---

Walkthrough

The OpenAPI model dumper now includes common model classes, and its unit test fixture and expected schema list cover the resulting MCP, RAG, moderation, token, tool, transcript, and turn-summary schemas.

Changes

Common model schema export

Layer / File(s)	Summary
Register common models src/utils/models_dumper.py	Imports models.common and adds its schema classes to the OpenAPI dump model collection.
Validate generated schemas tests/unit/utils/test_models_dumper.py	Adds serialized schemas and expected names for the newly exported common models and related tool, proxy, transcript, and turn schemas.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

• lightspeed-core/lightspeed-stack#2096: Introduces the model dumper utility and its test setup.
• lightspeed-core/lightspeed-stack#2109: Refactors the same OpenAPI schema dumping path.
• lightspeed-core/lightspeed-stack#2130: Expands dumped schemas and corresponding test expectations.

🚥 Pre-merge checks | ✅ 7

✅ Passed checks (7 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the main change: dumping common models, and is concise and specific.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Performance And Algorithmic Complexity	✅ Passed	dump_models only adds a fixed set of model classes to a one-time schema-generation list; no new loops, queries, caches, or unbounded structures.
Security And Secret Handling	✅ Passed	PASS: src/utils/models_dumper.py only adds common models to OpenAPI schema output; no hardcoded secrets, auth changes, injections, or sensitive-data leaks found.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

✨ Simplify code

• Create PR with simplified code

---

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