Skip to content

docs(api-reference): add record assignee endpoints - #127

Merged
Yash1hi merged 1 commit into
mainfrom
docs/record-assignees-api
Aug 3, 2026
Merged

docs(api-reference): add record assignee endpoints#127
Yash1hi merged 1 commit into
mainfrom
docs/record-assignees-api

Conversation

@Yash1hi

@Yash1hi Yash1hi commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Documents the public v2 record assignment API in the reference, mirroring the existing record-tags docs. The endpoints are already live on the API (backend #779 / #781); this just adds the docs.

  • openapi.yaml — adds GET/POST /records/{recordId}/assignees and DELETE /records/{recordId}/assignees/{assigneeUserId}, plus the RecordAssignment schema (synced from the backend's generated spec).
  • api-reference/ — 3 new pages: assign / list / unassign.
  • docs.json — new Record Assignees nav group under Records.

Test plan

  • npx mintlify dev renders the three new pages under Records → Record Assignees.
  • npx mintlify broken-links passes.
  • The endpoints' request/response schemas resolve (RecordAssignment).

Documents the public v2 record-assignment API, mirroring the record-tags docs:
GET/POST /records/{recordId}/assignees and DELETE
/records/{recordId}/assignees/{assigneeUserId}, plus the RecordAssignment
schema (synced from the backend's generated OpenAPI spec). Adds the three
api-reference pages and a Record Assignees nav group under Records.

The endpoints are already live on the v2 API (backend #779 / #781).
@github-actions

Copy link
Copy Markdown
Contributor

🖼️ Image Usage Check ✅

All 241 images in the repository are being used! No unused images found.

Great job keeping the repository clean! 🎉

@mintlify

mintlify Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
scorecard 🟢 Ready View Preview Aug 1, 2026, 12:31 AM

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

@Yash1hi
Yash1hi marked this pull request as ready for review August 3, 2026 17:08
@Yash1hi
Yash1hi merged commit 467d67a into main Aug 3, 2026
7 checks passed
@Yash1hi
Yash1hi deleted the docs/record-assignees-api branch August 3, 2026 17:08
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