Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Organizations Memberships API

7 actions 7 updates phrasing extends openapi/clerk-com-organizations-memberships-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Clerk's API. It is a proposal applied on top of the contract, not a document Clerk publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/v1/me/organization_memberships'].get

$.paths['/v1/me/organization_memberships/{organization_id}'].delete

$.paths['/v1/me/organization_invitations'].get

$.paths['/v1/me/organization_invitations/{invitation_id}/accept'].post

$.paths['/v1/me/organization_suggestions'].get

$.paths['/v1/me/organization_suggestions/{suggestion_id}/accept'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clerk Frontend Organizations Memberships API
  version: 1.0.0
extends: openapi/clerk-com-organizations-memberships-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v1/me/organization_memberships'].get
  update:
    x-apievangelist-phrasing:
      intent: List my organization memberships
      effect: read
      questions:
      - Which organizations do I belong to?
      - Can I page through my own organization memberships?
      instructions:
      - text: List my organization memberships.
      - text: Show every organization I'm a member of.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/organization_memberships/{organization_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Leave an organization
      effect: destructive
      questions:
      - How do I leave an organization I'm a member of?
      - Can I remove my own membership from an organization?
      instructions:
      - text: Leave organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Remove my membership in {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/organization_invitations'].get
  update:
    x-apievangelist-phrasing:
      intent: List invitations I've received
      effect: read
      questions:
      - Which organizations have invited me to join?
      - Can I see only my pending organization invitations?
      instructions:
      - text: List organization invitations sent to me.
      - text: Show my {status} organization invitations.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/organization_invitations/{invitation_id}/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept an organization invitation I received
      effect: write
      questions:
      - How do I accept an invitation to join an organization?
      - What happens when I accept an organization invite?
      instructions:
      - text: Accept my organization invitation {invitation_id}.
        slots:
          invitation_id: path.invitation_id
      - text: Join the organization from invite {invitation_id}.
        slots:
          invitation_id: path.invitation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/organization_suggestions'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations suggested for me
      effect: read
      questions:
      - Which organizations are suggested to me based on my email domain?
      - Can I filter my organization suggestions by status?
      instructions:
      - text: List my organization suggestions.
      - text: Show my {status} organization suggestions.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/organization_suggestions/{suggestion_id}/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept an organization suggestion
      effect: write
      questions:
      - How do I act on a suggestion to join my company's organization?
      - What happens when I accept an organization suggestion?
      instructions:
      - text: Accept organization suggestion {suggestion_id}.
        slots:
          suggestion_id: path.suggestion_id
      - text: Request to join via suggestion {suggestion_id}.
        slots:
          suggestion_id: path.suggestion_id
      method: generated
      generated: '2026-09-26'