LCORE-3473: Updated models doc

[tisnik]

Description

LCORE-3473: Updated models doc

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library [pyproject.toml + uv.lock]
• Bump-up dependent library [requirements.*.txt for Konflux]
• 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-3473

Summary by CodeRabbit

• Documentation
  • Added API documentation for creating saved prompts.
  • Documented required name and content fields, including examples and validation details.

[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 Plus

Run ID: df34fcda-87d6-4d2b-9314-15d48e4856b9

📥 Commits

Reviewing files that changed from the base of the PR and between 033db92 and 4e3c938.

📒 Files selected for processing (2)

• docs/models/requests.json
• docs/models/requests.md

📜 Recent review details

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

• GitHub Check: E2E: library mode / ci / group 1
• GitHub Check: E2E: server mode / ci / group 1
• GitHub Check: E2E: library mode / ci / group 3
• GitHub Check: E2E: server mode / ci / group 3
• GitHub Check: E2E: server mode / ci / group 2
• GitHub Check: E2E Tests for Lightspeed Evaluation job

⚠️ CI failures not shown inline (1)

GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-0-8-on-pull-request: Failed

Conclusion: failure

View job details

Konflux kflux-prd-rh02/lightspeed-stack-0-8-on-pull-request has <b>failed</b>.
<ul>
<li><b>Namespace</b>: <a href="https://konflux-ui.apps.kflux-prd-rh02.0fk9.p1.openshiftapps.com/ns/lightspeed-core-tenant">lightspeed-core-tenant</a></li>
<li><b>PipelineRun:</b> <a href="https://konflux-ui.apps.kflux-prd-rh02.0fk9.p1.openshiftapps.com/ns/lightspeed-core-tenant/pipelinerun/lightspeed-stack-0-8-on-pull-request-dxplj">lightspeed-stack-0-8-on-pull-request-dxplj</a></li>
</ul>
<hr>
<h4>Task Statuses:</h4>
<table>
  <tr><th>Status</th><th>Duration</th><th>Name</th></tr>
<tr>
<td>🟢 Succeeded</td>
<td>4 seconds</td><td>
[init](https://konflux-ui.apps.kflux-prd-rh02.0fk9.p1.openshiftapps.com/ns/lightspeed-core-tenant/pipelinerun/lightspeed-stack-0-8-on-pull-request-dxplj/logs/init)
</td></tr>
<tr>
<td>🟢 Succeeded</td>
<td>14 seconds</td><td>
[clone-repository](https://konflux-ui.apps.kflux-prd-rh02.0fk9.p1.openshiftapps.com/ns/lightspeed-core-tenant/pipelinerun/lightspeed-stack-0-8-on-pull-request-dxplj/logs/clone-repository)
</td></tr>
<tr>
<td>🔴 Failed</td>
<td>22 seconds</td><td>
[prefetch-dependencies](https://konflux-ui.apps.kflux-prd-rh02.0fk9.p1.openshiftapps.com/ns/lightspeed-core-tenant/pipelinerun/lightspeed-stack-0-8-on-pull-request-dxplj/logs/prefetch-dependencies)
</td></tr>
</table>

🧰 Additional context used

📓 Path-based instructions (1)

**/*

📄 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:

• docs/models/requests.json
• docs/models/requests.md

🔇 Additional comments (2)

docs/models/requests.json (1)

2577-2610: LGTM!

docs/models/requests.md (1)

1116-1134: LGTM!

---

Walkthrough

Added the SavedPromptCreateRequest OpenAPI schema and documentation. The model requires name and content string fields for creating user-scoped saved prompts.

Changes

Saved prompt request model

Layer / File(s)	Summary
Request model contract docs/models/requests.json, docs/models/requests.md	Added SavedPromptCreateRequest with required name and content fields, examples, descriptions, endpoint-level validation notes, and disallowed additional properties.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

• lightspeed-core/lightspeed-stack#2214: Adds and uses SavedPromptCreateRequest for the saved-prompts POST API.
• lightspeed-core/lightspeed-stack#2290: Updates the same request-model documentation files with related model changes.

🚥 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 identifies the documentation update and matches the pull request objective.
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	The PR changes only docs/models/requests.json and requests.md. No handlers, list operations, loops, API calls, caches, or pagination logic changed.
Security And Secret Handling	✅ Passed	The patch changes only JSON and Markdown documentation. Added content contains schema metadata and a benign prompt example, with no secrets, endpoints, executable code, injections, or Kubernetes Se...

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Create stacked PR
• Commit on current branch

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