LCORE-1346: Updated list of REST API endpoints

[tisnik]

Description

LCORE-1346: Updated list of REST API endpoints

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

Summary by CodeRabbit

• Documentation
  • Updated API endpoint documentation with new endpoints for prompt management, vector store lifecycle operations (create, list, retrieve, update, delete), vector store file management, and file uploads.
  • Added documentation for streaming query interruption capability.

[coderabbitai]

Walkthrough

Updated the REST API endpoints table in the OpenAPI documentation to include new endpoint entries for prompt management (/v1/prompts/), vector store lifecycle (/v1/vector-stores), vector store file operations (/v1/vector-stores/{vector_store_id}/files), file creation (/v1/files), and streaming query interruption (/v1/streaming_query/interrupt). Adjusted table formatting and column alignment.

Changes

Cohort / File(s)

Summary

Documentation Update docs/openapi.md

Added multiple new REST API endpoint entries to the "List of REST API endpoints" table: prompt management endpoints (GET list, POST create, GET/PUT/DELETE by prompt_id), vector store lifecycle endpoints (GET list, POST create, GET/PUT/DELETE by vector_store_id), vector store file operations (POST add, GET list, GET/DELETE by file_id), file creation endpoint, and streaming query interruption endpoint. Updated table formatting and column spacing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: updating the list of REST API endpoints in the documentation, which matches the raw summary showing additions of new endpoints to the openapi.md file.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ 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 and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 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 30-31: Update the OpenAPI docs to use the canonical endpoint paths
without trailing slashes: change `/v1/prompts/` to `/v1/prompts` for both GET
and POST entries so they match the implemented route (`/v1/prompts`) in the
prompts endpoint; ensure the table rows are updated to avoid redirect-dependent
client behavior for POST requests.

🪄 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: 888ef2f5-b826-400a-ab2b-ac99d8a4db88

📥 Commits

Reviewing files that changed from the base of the PR and between 52c5453 and 77468c7.

📒 Files selected for processing (1)

• docs/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). (9)

• GitHub Check: list_outdated_dependencies
• GitHub Check: build-pr
• GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request
• GitHub Check: E2E: library mode / ci / group 3
• GitHub Check: E2E: library mode / ci / group 1
• GitHub Check: E2E: server mode / ci / group 2
• GitHub Check: E2E: library mode / ci / group 2
• GitHub Check: E2E: server mode / ci / group 3
• GitHub Check: E2E: server mode / ci / group 1

🔇 Additional comments (1)

docs/openapi.md (1)

37-49: Endpoint additions look consistent with handlers.

The newly listed vector store, file, and streaming interrupt endpoints align with the implemented handlers and improve coverage of the REST endpoint summary.

[coderabbitai]

⚠️ Potential issue | 🟠 Major

Use canonical prompt paths without trailing slash.

The table lists /v1/prompts/, but the implemented endpoint is /v1/prompts (src/app/endpoints/prompts.py:139-165). Please document the canonical path to avoid redirect-dependent client behavior, especially for POST.

Proposed doc fix

-| GET    | `/v1/prompts/`                                        | List prompts                                                                                                                                         |
-| POST   | `/v1/prompts/`                                        | Create prompt                                                                                                                                        |
+| GET    | `/v1/prompts`                                         | List prompts                                                                                                                                         |
+| POST   | `/v1/prompts`                                         | Create prompt                                                                                                                                        |

📝 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

	| GET | `/v1/prompts/` | List prompts |
	| POST | `/v1/prompts/` | Create prompt |
	| GET | `/v1/prompts` | List prompts |
	| POST | `/v1/prompts` | Create prompt |

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/openapi.md` around lines 30 - 31, Update the OpenAPI docs to use the
canonical endpoint paths without trailing slashes: change `/v1/prompts/` to
`/v1/prompts` for both GET and POST entries so they match the implemented route
(`/v1/prompts`) in the prompts endpoint; ensure the table rows are updated to
avoid redirect-dependent client behavior for POST requests.