RHIDP-15394: add optional id field for inference providers#2106
RHIDP-15394: add optional id field for inference providers#2106Jdubrick wants to merge 3 commits into
Conversation
Signed-off-by: Jordan Dubrick <[email protected]>
|
Warning Review limit reached
Next review available in: 47 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (4)
WalkthroughAdds an optional ChangesProvider id support
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify 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. Comment |
Match generate_openapi_schema.py output (no trailing newline) so spectral passes, and call setup_logging before library-mode synthesis so INFO replace logs are visible at boot. Co-authored-by: Cursor <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/openapi.json (1)
1-21332: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick winCI failure: regenerate the OpenAPI schema.
Pipeline logs report that this file is out of date relative to the generator script.
Run:
uv run scripts/generate_openapi_schema.py docs/openapi.jsonand commit the full regenerated output to ensure it matches source-of-truth exactly (including any unrelated formatting/ordering the generator produces).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/openapi.json` around lines 1 - 21332, The docs/openapi.json file is stale and does not match the output of the schema generator, causing CI to fail. Regenerate this file by running `uv run scripts/generate_openapi_schema.py docs/openapi.json` from the repository root, then commit the fully regenerated file as-is (including any formatting or ordering changes produced by the generator) so it exactly matches the source-of-truth output.Source: Pipeline failures
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/models/config.py`:
- Line 701: The type annotations in config model use legacy Optional[str] syntax
and should be updated to modern union syntax. Update the field definition for
the id attribute and the related validator signature in the same model to use
str | None instead of Optional[str], keeping the existing behavior unchanged.
Use the config model’s id field and its validator method as the symbols to
locate both spots.
---
Outside diff comments:
In `@docs/openapi.json`:
- Around line 1-21332: The docs/openapi.json file is stale and does not match
the output of the schema generator, causing CI to fail. Regenerate this file by
running `uv run scripts/generate_openapi_schema.py docs/openapi.json` from the
repository root, then commit the fully regenerated file as-is (including any
formatting or ordering changes produced by the generator) so it exactly matches
the source-of-truth output.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 314f34cb-7a62-4038-b1b9-07646386599b
📒 Files selected for processing (10)
docs/config.htmldocs/config.jsondocs/config.mddocs/config.pumldocs/openapi.jsonexamples/profiles/inline-faiss.yamlsrc/llama_stack_configuration.pysrc/models/config.pytests/unit/models/config/test_inference_configuration.pytests/unit/test_llama_stack_synthesize.py
📜 Review details
⏰ Context from checks skipped due to timeout. (13)
- GitHub Check: black
- GitHub Check: radon
- GitHub Check: unit_tests (3.12)
- GitHub Check: unit_tests (3.13)
- GitHub Check: integration_tests (3.12)
- GitHub Check: integration_tests (3.13)
- GitHub Check: build-pr
- GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-0-7-on-pull-request
- 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: server mode / ci / group 1
- GitHub Check: E2E Tests for Lightspeed Evaluation job
⚠️ CI failures not shown inline (1)
GitHub Actions: OpenAPI (Spectral) / 0_spectral.txt: RHIDP-15394: add optional id field for inference providers
Conclusion: failure
##[group]Run set -euo pipefail
�[36;1mset -euo pipefail�[0m
�[36;1muv run python scripts/generate_openapi_schema.py /tmp/openapi-generated.json�[0m
�[36;1mif ! diff -u docs/openapi.json /tmp/openapi-generated.json; then�[0m
�[36;1m echo "::error::docs/openapi.json is out of date. Regenerate with: uv run scripts/generate_openapi_schema.py docs/openapi.json"�[0m
🧰 Additional context used
📓 Path-based instructions (3)
tests/**/*.py
📄 CodeRabbit inference engine (AGENTS.md)
tests/**/*.py: Use pytest for all unit and integration tests; do not use unittest
Usepytest.mark.asynciomarker for async tests
Files:
tests/unit/models/config/test_inference_configuration.pytests/unit/test_llama_stack_synthesize.py
src/**/*.py
📄 CodeRabbit inference engine (AGENTS.md)
src/**/*.py: Use absolute imports for internal modules:from authentication import get_auth_dependency
Llama Stack imports: Usefrom llama_stack_client import AsyncLlamaStackClient
Checkconstants.pyfor shared constants before defining new ones
All modules must start with descriptive docstrings explaining purpose
Uselogger = get_logger(__name__)fromlog.pyfor module logging
All functions must have complete type annotations for parameters and return types, use modern syntax (str | int), and include descriptive docstrings
Use snake_case with descriptive, action-oriented names for functions (get_, validate_, check_)
Avoid in-place parameter modification anti-patterns; return new data structures instead of modifying function parameters
Useasync deffor I/O operations and external API calls
Use standard log levels with clear purposes:debug()for diagnostic info,info()for program execution,warning()for unexpected events,error()for serious problems
All classes must have descriptive docstrings explaining purpose and use PascalCase with standard suffixes:Configuration,Error/Exception,Resolver,Interface
Abstract classes must use ABC with@abstractmethoddecorators
Follow Google Python docstring conventions with required sections: Parameters, Returns, Raises, and Attributes for classes
Files:
src/llama_stack_configuration.pysrc/models/config.py
src/models/**/*.py
📄 CodeRabbit inference engine (AGENTS.md)
Pydantic models must use
@model_validatorand@field_validatorfor validation and complete type annotations for all attributes, avoidingAnytype
Files:
src/models/config.py
🧠 Learnings (5)
📚 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:
tests/unit/models/config/test_inference_configuration.pysrc/llama_stack_configuration.pysrc/models/config.pytests/unit/test_llama_stack_synthesize.py
📚 Learning: 2026-05-20T08:09:30.641Z
Learnt from: max-svistunov
Repo: lightspeed-core/lightspeed-stack PR: 1580
File: docs/design/llama-stack-config-merge/poc-results/library-mode/synthesized-run.yaml:107-110
Timestamp: 2026-05-20T08:09:30.641Z
Learning: In Llama-stack config YAMLs, when defining a Llama Guard safety shield entry, set `provider_shield_id` to the *guard model identifier* (e.g., `meta-llama/Llama-Guard-3-8B`). Do not use a chat/generative model id (e.g., `openai/gpt-4o-mini`): a chat-model id (or `native_override`) indicates only an override landed and does **not** mean the safety shield is actually gating queries. Ensure any E2E coverage for the related implementation (JIRA/E2E tests) exercises a real Llama Guard model to verify that the shield is effective.
Applied to files:
examples/profiles/inline-faiss.yaml
📚 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/llama_stack_configuration.pysrc/models/config.py
📚 Learning: 2026-01-12T10:58:40.230Z
Learnt from: blublinsky
Repo: lightspeed-core/lightspeed-stack PR: 972
File: src/models/config.py:459-513
Timestamp: 2026-01-12T10:58:40.230Z
Learning: In lightspeed-core/lightspeed-stack, for Python files under src/models, when a user claims a fix is done but the issue persists, verify the current code state before accepting the fix. Steps: review the diff, fetch the latest changes, run relevant tests, reproduce the issue, search the codebase for lingering references to the original problem, confirm the fix is applied and not undone by subsequent commits, and validate with local checks to ensure the issue is resolved.
Applied to files:
src/models/config.py
📚 Learning: 2026-02-25T07:46:33.545Z
Learnt from: asimurka
Repo: lightspeed-core/lightspeed-stack PR: 1211
File: src/models/responses.py:8-16
Timestamp: 2026-02-25T07:46:33.545Z
Learning: In the Python codebase, requests.py should use OpenAIResponseInputTool as Tool while responses.py uses OpenAIResponseTool as Tool. This difference is intentional due to differing schemas for input vs output tools in llama-stack-api. Apply this distinction consistently to other models under src/models (e.g., ensure request-related tools use the InputTool variant and response-related tools use the ResponseTool variant). If adding new tools, choose the corresponding InputTool or Tool class based on whether the tool represents input or output, and document the rationale in code comments.
Applied to files:
src/models/config.py
🪛 ast-grep (0.44.1)
tests/unit/test_llama_stack_synthesize.py
[warning] 183-183: Do not make http calls without encryption
Context: "http://prod:8000"
Note: [CWE-319] Cleartext Transmission of Sensitive Information.
(requests-http)
[warning] 189-189: Do not make http calls without encryption
Context: "http://staging:8000"
Note: [CWE-319] Cleartext Transmission of Sensitive Information.
(requests-http)
[warning] 197-197: Do not make http calls without encryption
Context: "http://prod:8000"
Note: [CWE-319] Cleartext Transmission of Sensitive Information.
(requests-http)
[warning] 198-198: Do not make http calls without encryption
Context: "http://staging:8000"
Note: [CWE-319] Cleartext Transmission of Sensitive Information.
(requests-http)
🪛 Checkov (3.3.2)
docs/openapi.json
[high] 1-21332: Ensure that the global security field has rules defined
(CKV_OPENAPI_4)
[high] 1-21332: Ensure that security operations is not empty.
(CKV_OPENAPI_5)
🪛 GitHub Actions: OpenAPI (Spectral) / 0_spectral.txt
docs/openapi.json
[error] 1-1: CI check failed: docs/openapi.json is out of date. Regenerate with: uv run scripts/generate_openapi_schema.py docs/openapi.json
🪛 GitHub Actions: OpenAPI (Spectral) / spectral
docs/openapi.json
[error] 1-1: docs/openapi.json is out of date (diff against generated schema failed). Regenerate with: uv run scripts/generate_openapi_schema.py docs/openapi.json
🔇 Additional comments (11)
src/models/config.py (1)
670-673: Validator and docstring look correct.The
validate_idfield validator correctly handlesNone, strips whitespace, rejects empty values, and enforces the[a-z0-9_-]+character set viare.fullmatch. The docstring uses the "Parameters:" header as required.Also applies to: 731-761
tests/unit/models/config/test_inference_configuration.py (1)
4-6: LGTM!Also applies to: 162-193
src/llama_stack_configuration.py (1)
721-728: LGTM!Also applies to: 748-748, 769-773
tests/unit/test_llama_stack_synthesize.py (1)
131-133: LGTM!Also applies to: 148-155, 157-173, 175-200, 202-227
examples/profiles/inline-faiss.yaml (1)
14-20: LGTM!docs/config.html (1)
2108-2112: LGTM!Also applies to: 2141-2160
docs/config.json (2)
461-461: LGTM!Also applies to: 578-578, 888-888, 1722-1722
1740-1746: 🗄️ Data Integrity & Integration | ⚡ Quick winMirror the
idvalidator in the JSON schema.
idis validated upstream to be trimmed, non-empty, and limited to lowercase letters, digits, underscores, and hyphens, but this schema entry only addstype/nullable/default. If downstream tooling uses this JSON/OpenAPI schema for validation or codegen, invalid ids will still look acceptable until runtime. Please confirm whether the schema generator is expected to surface those rules here; otherwise add the missing machine-readable constraints.docs/config.md (1)
797-800: LGTM!Also applies to: 814-814
docs/config.puml (1)
306-307: LGTM!docs/openapi.json (1)
20358-20369: LGTM!Also applies to: 20410-20410
Signed-off-by: Jordan Dubrick <[email protected]>
Description
Type of change
Tools used to create PR
Identify any AI code assistants used in this PR (for transparency and review context)
Related Tickets & Documents
Checklist before requesting a review
Testing
Summary by CodeRabbit
New Features
Bug Fixes