Skip to content

Generate Backend docs - Sessions, Client, and Invitations APIs#3454

Merged
alexisintech merged 5 commits into
aa/DOCS-10984from
aa/generate-sessions-client-invitations
Jun 22, 2026
Merged

Generate Backend docs - Sessions, Client, and Invitations APIs#3454
alexisintech merged 5 commits into
aa/DOCS-10984from
aa/generate-sessions-client-invitations

Conversation

@alexisintech

@alexisintech alexisintech commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

What does this solve? What changed?

Replaces the hand-written Backend reference pages for Sessions, Client, and Invitations with <Typedoc /> includes sourced from clerk/javascript#8853, so the reference stays in sync with the SDK going forward.

  • Sessions: get-session-list, get-session, get-token, revoke-session, verify-session
  • Client: get-client, verify-client
  • Invitations: create-invitation, create-invitation-bulk, get-invitation-list, revoke-invitation
  • Renames ExampleUsage sections

Stacked on #3445 (aa/DOCS-10984).

Deadline

  • No rush

Other resources

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@alexisintech
alexisintech requested a review from a team as a code owner June 19, 2026 00:03
@vercel

vercel Bot commented Jun 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-docs Error Error Jun 19, 2026 5:00pm

Request Review

@SarahSoutoul

SarahSoutoul commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

@alexisintech have left a docs review - session, invitation & client doing the following:

  • Fixing the wording of the CAUTION callout for createInvitationBulkI() from minute to hour. This is what's on the live docs + documented in the rate limits page as 25 requests per hour rather than minute.

    Screenshot 2026-06-19 at 10 07 51 am
  • Replaced the wording Retrieves with Gets a in the getInvitationList() page to be consistent with using get rather than retrieve.

And got a docs review - session, invitation & client on javascript repo too.

@SarahSoutoul

Copy link
Copy Markdown
Contributor

Made another pass at replacing the wording Retrieves with **Gets to be consistent with all changes: docs review pt2 - consistency retrieve -> get.

@SarahSoutoul SarahSoutoul self-assigned this Jun 19, 2026
@alexisintech
alexisintech merged commit b43c9a2 into aa/DOCS-10984 Jun 22, 2026
1 of 2 checks passed
@alexisintech
alexisintech deleted the aa/generate-sessions-client-invitations branch June 22, 2026 21:16
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.

2 participants