Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Membership Requests API

4 actions 4 updates phrasing extends openapi/clerk-com-membership-requests-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 4

$.info

$.paths['/v1/organizations/{organization_id}/membership_requests'].get

$.paths['/v1/organizations/{organization_id}/membership_requests/{request_id}/accept'].post

$.paths['/v1/organizations/{organization_id}/membership_requests/{request_id}/reject'].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 Membership Requests API
  version: 1.0.0
extends: openapi/clerk-com-membership-requests-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: 3
- target: $.paths['/v1/organizations/{organization_id}/membership_requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List requests to join an organization
      effect: read
      questions:
      - Who has asked to join my organization?
      - Can I filter an organization's membership requests by status?
      instructions:
      - text: List membership requests for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show {status} join requests for {organization_id}.
        slots:
          organization_id: path.organization_id
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/membership_requests/{request_id}/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a request to join an organization
      effect: write
      questions:
      - How do I approve someone who asked to join my organization?
      - Who is allowed to accept membership requests?
      instructions:
      - text: Accept membership request {request_id} for organization {organization_id}.
        slots:
          organization_id: path.organization_id
          request_id: path.request_id
      - text: Approve join request {request_id} in {organization_id}.
        slots:
          organization_id: path.organization_id
          request_id: path.request_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/membership_requests/{request_id}/reject'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a request to join an organization
      effect: destructive
      questions:
      - How do I turn down a request to join my organization?
      - Can I decline someone's membership request?
      instructions:
      - text: Reject membership request {request_id} for organization {organization_id}.
        slots:
          organization_id: path.organization_id
          request_id: path.request_id
      - text: Decline join request {request_id} in {organization_id}.
        slots:
          organization_id: path.organization_id
          request_id: path.request_id
      method: generated
      generated: '2026-09-26'