Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Members API

5 actions 5 updates phrasing extends openapi/clerk-com-members-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 5

$.info
$.paths['/v1/organizations/{organization_id}/memberships'].get
$.paths['/v1/organizations/{organization_id}/memberships'].post
$.paths['/v1/organizations/{organization_id}/memberships/{user_id}'].delete
$.paths['/v1/organizations/{organization_id}/memberships/{user_id}'].patch

OpenAPI Overlay

Raw ↑
# 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 Members API
  version: 1.0.0
extends: openapi/clerk-com-members-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: 4
- target: $.paths['/v1/organizations/{organization_id}/memberships'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's members
      effect: read
      questions:
      - Who are the members of my organization?
      - Can I list only the admins of an organization?
      - How do I search an organization's members by name?
      instructions:
      - text: List the members of organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show members of organization {organization_id} with role {role}.
        slots:
          organization_id: path.organization_id
          role: query.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/memberships'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to an organization
      effect: write
      questions:
      - How do I add an existing user straight into my organization without an invite?
      - Can I pick the role when adding someone as a member?
      instructions:
      - text: Add user {user_id} to organization {organization_id} as {role}.
        slots:
          user_id: requestBody.user_id
          organization_id: path.organization_id
          role: requestBody.role
      - text: Make user {user_id} a {role} member of {organization_id}.
        slots:
          user_id: requestBody.user_id
          role: requestBody.role
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/memberships/{user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from an organization
      effect: destructive
      questions:
      - How do I kick a user out of my organization?
      - Who is allowed to remove organization members?
      instructions:
      - text: Remove user {user_id} from organization {organization_id}.
        slots:
          user_id: path.user_id
          organization_id: path.organization_id
      - text: Take member {user_id} out of {organization_id}.
        slots:
          user_id: path.user_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/memberships/{user_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a member's organization role
      effect: write
      questions:
      - How do I promote an organization member to admin?
      - Can I change an existing member's role?
      instructions:
      - text: Change user {user_id}'s role in organization {organization_id} to {role}.
        slots:
          user_id: path.user_id
          organization_id: path.organization_id
          role: requestBody.role
      - text: Promote member {user_id} of {organization_id} to {role}.
        slots:
          user_id: path.user_id
          organization_id: path.organization_id
          role: requestBody.role
      method: generated
      generated: '2026-09-26'