Skip to content

docs: add List Threads, Subscribe & Unsubscribe Thread REST APIs [ENG…#429

Open
pranavkamble-cometchat wants to merge 5 commits into
mainfrom
docs/restapi-chat-api-ENG-37141
Open

docs: add List Threads, Subscribe & Unsubscribe Thread REST APIs [ENG…#429
pranavkamble-cometchat wants to merge 5 commits into
mainfrom
docs/restapi-chat-api-ENG-37141

Conversation

@pranavkamble-cometchat

@pranavkamble-cometchat pranavkamble-cometchat commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

…-37141]

Add nav entries and OpenAPI-backed MDX pages for three thread endpoints under Chat & Messaging → Messages:

  • GET /threads (List Threads)
  • POST /messages/{id}/thread/subscription (Subscribe Thread)
  • DELETE /messages/{id}/thread/subscription (Unsubscribe Thread)

Description

Related Issue(s)

Type of Change

  • Documentation correction/update
  • New documentation
  • Improvement to existing documentation
  • Typo fix
  • Other (please specify)

Checklist

  • I have read the CONTRIBUTING document
  • My branch name follows the naming convention
  • My changes follow the documentation style guide
  • I have checked for spelling and grammar errors
  • All links in my changes are valid and working
  • My changes are accurately described in this pull request

Additional Information

Screenshots (if applicable)

…-37141]

Add nav entries and OpenAPI-backed MDX pages for three thread endpoints
under Chat & Messaging → Messages:
- GET  /threads                              (List Threads)
- POST /messages/{id}/thread/subscription    (Subscribe Thread)
- DELETE /messages/{id}/thread/subscription  (Unsubscribe Thread)
@mintlify

mintlify Bot commented Jul 14, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cometchat 🟢 Ready View Preview Jul 14, 2026, 8:42 AM

siva-cometchat
siva-cometchat previously approved these changes Jul 15, 2026
@ketanyekale

Copy link
Copy Markdown
Member

Docs PR review

Verdict: request changes — the three new thread pages are in good shape, but the accompanying regeneration of chat-apis.json / calls.json / data-import-apis.json (109 of 153 existing chat operations modified) introduces regressions alongside its improvements.

P0 — wrong content that misleads integration

  • mentionsWithTagInfo renamed to mentionswithTagInfo (lowercase w) on GET /messages, GET /users/{uid}/messages, and GET /groups/{guid}/messages in chat-apis.json. The base spec had it camelCase, and the SDK docs (sdk/react-native/mentions.mdx, sdk/ios/mentions.mdx) confirm mentionsWithTagInfo. Anyone copying the documented param will have it silently ignored by the server.

P1 — should fix before merge

  • Path parameters deleted: GET /roles/{role}/permissions lost its role param; GET /groups/{guid}/scopes/{scope}/permissions lost both guid and scope (present in base, now absent at both operation and path level). This is invalid OpenAPI (template variables with no matching parameter definition) and the API playground loses those input fields.
  • Pagination params silently removed from GET /users/{uid}/blockedusers, GET /roles, and GET /messages/{id}/thread — all three had page + perPage in base and now document no pagination at all (nor the newer limit/affix style). Please confirm this is intentional.
  • Spec scope creep: beyond the three thread endpoints, the regen adds six more operations (5× /moderation/messages CRUD, PATCH /messages/{id}/interacted) with no MDX pages, no nav entries, and no mention in the PR description. Harmless to readers (unreferenced ops don't render), but please confirm they're meant to land now.

P2 / nits

  • Three /users/{uid}/blockedusers operations lost their operationIds (were block-users / unblock-users / list-blocked-users) — every other operation in the spec has one; hurts SDK generation and tooling.
  • calls.json: operationId renamed get-callretreive-call-details (misspelled "retrieve").
  • Page-title casing regressions in summaries: "Mark Group Conversation As unread", "Mark conversation messages as unread" (were Title Case).
  • Server variable renamed {appId}{appid} in chat/calls/data-import while management-apis.json, campaigns-apis.json, and ai-agent-service.json still use {appId} — inconsistent across playgrounds.
  • GET /threads limit param: "type": "integer" but "default": "100" is a string.

What passed

  • Build is safe: 0 unresolved nav refs; the 3 new docs.json entries resolve to the new files.
  • No 404 risk: 0 files removed/renamed (no redirects needed); 0 chained 404s; 0 orphans; 0 broken in-content links in changed files.
  • No page breaks from the spec churn: no paths were removed from any spec, and pages bind by method /path, so all MDX openapi: refs still resolve (the 34 operationId renames don't affect rendering). The only unresolved refs are 29 pre-existing ai-agents/apis/* pages tied to ai-agent-service.json, which this PR doesn't touch.
  • Real improvements in the regen: all 162 chat operations now declare explicit apiKey security (23 were missing it), broken $ref: #/components/parameters/apikey references were cleaned up, and GET /users / GET /groups / GET /messages gained genuine filter params (createdAt[from/to], senders, membersCount[…], …).
  • New thread endpoints: documented query params with descriptions and defaults, realistic 200 example payloads, explicit auth; single-200-response matches house style.

🤖 Generated with Claude Code

…} + operationId typo fixes [ENG-37141]

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants