LCORE-1348: Updated OpenAPI schema#1508
Merged
tisnik merged 1 commit intolightspeed-core:mainfrom Apr 15, 2026
Merged
Conversation
Contributor
WalkthroughAdded OpenAPI documentation for file upload and vector store operations, including request/response schemas and data models for files, vector stores, and their associated operations. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Warning Review ran into problems🔥 ProblemsTimed out fetching pipeline failures after 30000ms 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/openapi.md`:
- Around line 7275-7283: The OpenAPI docs are missing the model-level length
constraints for VectorStoreCreateRequest.name; update the table row for "name"
to include its min_length=1 and max_length=256 (e.g., in the Type or Description
column: "string (min_length=1, max_length=256)") so the docs match the
VectorStoreCreateRequest.name contract and clients can validate accordingly.
- Around line 4468-4475: The OpenAPI entry Body_create_file_v1_files_post
incorrectly documents the file field as a plain string; update the POST
/v1/files operation to declare it consumes multipart/form-data and document the
file parameter as an UploadFile/binary file (e.g., use content:
multipart/form-data with a schema referencing UploadFile or type: string format:
binary) so clients know to send a binary multipart file rather than a generic
string.
🪄 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: 2673acb9-47e7-416e-907d-ec7f0b358e4b
📒 Files selected for processing (2)
docs/openapi.jsondocs/openapi.md
📜 Review details
⏰ 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). (7)
- GitHub Check: E2E: library mode / ci / group 2
- GitHub Check: E2E: library mode / ci / group 1
- GitHub Check: E2E: server mode / ci / group 1
- GitHub Check: E2E: server mode / ci / group 3
- GitHub Check: E2E: library mode / ci / group 3
- GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request
- GitHub Check: E2E: server mode / ci / group 2
🔇 Additional comments (1)
docs/openapi.md (1)
4959-4993: File response components align with backend models.
FileResponseandFileTooLargeResponsefields are consistent withsrc/models/responses.pyand the 413 behavior insrc/app/endpoints/vector_stores.py.
Comment on lines
+4468
to
+4475
| ## Body_create_file_v1_files_post | ||
|
|
||
|
|
||
|
|
||
| | Field | Type | Description | | ||
| |-------|------|-------------| | ||
| | file | string | | | ||
|
|
Contributor
There was a problem hiding this comment.
Document upload field as binary multipart, not generic string.
POST /v1/files consumes UploadFile (multipart/form-data). Documenting file as plain string is misleading and can cause incorrect client payloads.
🛠️ Proposed doc fix
## Body_create_file_v1_files_post
| Field | Type | Description |
|-------|------|-------------|
-| file | string | |
+| file | string (binary) | File content to upload via multipart/form-data |
+
+Required fields: `file`🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/openapi.md` around lines 4468 - 4475, The OpenAPI entry
Body_create_file_v1_files_post incorrectly documents the file field as a plain
string; update the POST /v1/files operation to declare it consumes
multipart/form-data and document the file parameter as an UploadFile/binary file
(e.g., use content: multipart/form-data with a schema referencing UploadFile or
type: string format: binary) so clients know to send a binary multipart file
rather than a generic string.
Comment on lines
+7275
to
+7283
| | Field | Type | Description | | ||
| |-------|------|-------------| | ||
| | name | string | Name of the vector store | | ||
| | embedding_model | | Embedding model to use for the vector store | | ||
| | embedding_dimension | | Dimension of the embedding vectors | | ||
| | chunking_strategy | | Chunking strategy configuration | | ||
| | provider_id | | Vector store provider identifier | | ||
| | metadata | | Metadata dictionary for storing session information | | ||
|
|
Contributor
There was a problem hiding this comment.
Add name length constraints to match request model contract.
VectorStoreCreateRequest.name is documented, but its model-level constraints (min_length=1, max_length=256) are missing. This creates avoidable client-side validation surprises.
🛠️ Proposed doc fix
| Field | Type | Description |
|-------|------|-------------|
-| name | string | Name of the vector store |
+| name | string | Name of the vector store (1-256 characters) |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| | Field | Type | Description | | |
| |-------|------|-------------| | |
| | name | string | Name of the vector store | | |
| | embedding_model | | Embedding model to use for the vector store | | |
| | embedding_dimension | | Dimension of the embedding vectors | | |
| | chunking_strategy | | Chunking strategy configuration | | |
| | provider_id | | Vector store provider identifier | | |
| | metadata | | Metadata dictionary for storing session information | | |
| | Field | Type | Description | | |
| |-------|------|-------------| | |
| | name | string | Name of the vector store (1-256 characters) | | |
| | embedding_model | | Embedding model to use for the vector store | | |
| | embedding_dimension | | Dimension of the embedding vectors | | |
| | chunking_strategy | | Chunking strategy configuration | | |
| | provider_id | | Vector store provider identifier | | |
| | metadata | | Metadata dictionary for storing session information | |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/openapi.md` around lines 7275 - 7283, The OpenAPI docs are missing the
model-level length constraints for VectorStoreCreateRequest.name; update the
table row for "name" to include its min_length=1 and max_length=256 (e.g., in
the Type or Description column: "string (min_length=1, max_length=256)") so the
docs match the VectorStoreCreateRequest.name contract and clients can validate
accordingly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
LCORE-1348: Updated OpenAPI schema
Type of change
Tools used to create PR
Related Tickets & Documents
Summary by CodeRabbit