Skip to content

docs: add DELETE /api/chats reference#87

Closed
arpitgupta1214 wants to merge 2 commits intorecoupable:mainfrom
arpitgupta1214:codex/arpit-docs-delete-chats-endpoint
Closed

docs: add DELETE /api/chats reference#87
arpitgupta1214 wants to merge 2 commits intorecoupable:mainfrom
arpitgupta1214:codex/arpit-docs-delete-chats-endpoint

Conversation

@arpitgupta1214
Copy link
Copy Markdown
Collaborator

@arpitgupta1214 arpitgupta1214 commented Mar 30, 2026

Summary

  • document DELETE /api/chats in OpenAPI
  • add Chat Delete endpoint page in docs navigation
  • add api-reference/chat/delete.mdx
  • align delete chat schema to use id in request/response

Summary by CodeRabbit

  • Documentation
    • Added API documentation for the Delete Chat endpoint, including request and response specifications, error handling guidance, and HTTP status codes. The documentation is now integrated into the API reference guide for developer access.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 30, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Introduces a new DELETE endpoint for chats to the API. The changes add OpenAPI schema definitions for DeleteChatRequest, DeleteChatResponse, and DeleteChatErrorResponse, a documentation page for the endpoint, and update the navigation configuration to surface it in the docs.

Changes

Cohort / File(s) Summary
API Documentation & Navigation
api-reference/chat/delete.mdx, docs.json
Added new delete chat documentation page and registered it in the docs sidebar under the Chat group.
OpenAPI Schema Definition
api-reference/openapi.json
Added DELETE /api/chats operation with request body (DeleteChatRequest with UUID id) and success/error response schemas (DeleteChatResponse, DeleteChatErrorResponse) across HTTP status codes 200, 400, 401, 403, 404, 500.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Hops with glee, a deletion so clean,
New schemas defined, endpoint pristine,
Chats can now vanish without a trace,
Documentation guides users through the pace!

🚥 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 'docs: add DELETE /api/chats reference' directly summarizes the main changes—adding API documentation for the DELETE endpoint and updating the docs navigation.
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

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@arpitgupta1214
Copy link
Copy Markdown
Collaborator Author

Superseded by #88 from branch codex/arpit-docs-delete-chats-endpoint in recoupable/docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant