Skip to content

docs(fundamentals): link the GDPR entry to the relevant REST APIs - #491

Open
ketanyekale wants to merge 1 commit into
mainfrom
docs/gdpr-compliance-api-references
Open

docs(fundamentals): link the GDPR entry to the relevant REST APIs#491
ketanyekale wants to merge 1 commit into
mainfrom
docs/gdpr-compliance-api-references

Conversation

@ketanyekale

Copy link
Copy Markdown
Member

What

Expands the GDPR entry in the Compliances section of fundamentals/overview.mdx so it points readers to the specific REST APIs used when servicing data subject requests, plus three small consistency fixes on the same page.

Why

The GDPR bullet previously described our API support in general terms. Naming the endpoints and linking them directly saves readers a search and makes the compliance story concrete and actionable at the point where they're evaluating it.

Changes

Line Change
57 Section intro now reads "security and privacy standards", since GDPR and PIPEDA are privacy regulations
61 GDPR bullet now names and links the relevant endpoints, deep-linking the delete API to its permanent body parameter
100 Feature-table entry aligned with the compliance standards listed alongside it (ISO 27001, SOC 2, HIPAA)
101 Typo: HIPPAHIPAA

Endpoints referenced

For reviewers, the APIs available to a controller servicing a data subject request:

  • GET /users/{uid} — profile, status, role, metadata, tags
  • GET /conversations with onBehalfOf: uid — conversations
  • GET /messages?sender={uid} — messages, with attachments included inline
  • GET /calls?uid={uid} — call logs

For this use case the /messages call is made as admin without onBehalfOf, since setting it scopes results to common conversations.

Note on the anchor

#body-permanent is verified against the rendered page. It's the first #body-* anchor in the repo — every other /rest-api/...#... link targets a normal heading slug — and it resolves because Mintlify generates ids for OpenAPI body parameters.

Possible follow-up

A short guide showing those four calls composed into a single walkthrough, which the GDPR bullet could then link to instead of individual endpoints.

🤖 Generated with Claude Code

Expands the GDPR bullet in the Compliances section so it points to the specific endpoints customers use when servicing data subject requests: retrieving a user's data, and permanently deleting a user along with their messages and conversations. The delete link is deep-linked to the permanent body parameter.

Also aligns the feature-table entry with the compliance standards listed alongside it, updates the section intro to cover privacy standards as well as security standards, and fixes a HIPAA typo.
@mintlify

mintlify Bot commented Sep 3, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
cometchat 🟢 Ready View Preview Sep 3, 2026, 5:17 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

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.

2 participants