Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Organization API

7 actions 7 updates phrasing extends openapi/clerk-com-organization-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/organizations'].post
$.paths['/v1/organizations/{organization_id}'].get
$.paths['/v1/organizations/{organization_id}'].delete
$.paths['/v1/organizations/{organization_id}'].patch
$.paths['/v1/organizations/{organization_id}/logo'].put
$.paths['/v1/organizations/{organization_id}/logo'].delete

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 Organization API
  version: 1.0.0
extends: openapi/clerk-com-organization-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/organizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization as the signed-in user
      effect: write
      questions:
      - How can a signed-in user create their own organization from the frontend?
      - Does the user who creates an organization become its admin?
      instructions:
      - text: Create an organization called {name} and make me its admin.
        slots:
          name: requestBody.name
      - text: Start a new organization {name} with slug {slug} for me.
        slots:
          name: requestBody.name
          slug: requestBody.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization I belong to
      effect: read
      questions:
      - How does the frontend load the details of an organization the user is a member of?
      - Can I read an organization's properties only if I'm a member?
      instructions:
      - text: Get my organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show the properties of organization {organization_id} that I belong to.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization I administer
      effect: destructive
      questions:
      - How can an organization admin delete their organization from the app?
      - Do I need to be an admin to delete my organization?
      instructions:
      - text: Delete my organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: As its admin, remove organization {organization_id} for good.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename an organization I administer
      effect: write
      questions:
      - How does an organization admin rename their organization from the frontend?
      - Can I change my organization's slug as its admin?
      instructions:
      - text: Rename my organization {organization_id} to {name}.
        slots:
          organization_id: path.organization_id
          name: requestBody.name
      - text: Change the slug of my organization {organization_id} to {slug}.
        slots:
          organization_id: path.organization_id
          slug: requestBody.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/logo'].put
  update:
    x-apievangelist-phrasing:
      intent: Change my organization's logo
      effect: write
      questions:
      - How does an admin upload a new logo for their organization from the app?
      - Who is allowed to change an organization's logo in the frontend?
      instructions:
      - text: Upload {file} as the logo for my organization {organization_id}.
        slots:
          file: requestBody.file
          organization_id: path.organization_id
      - text: As admin, set a new logo on organization {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organization_id}/logo'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove my organization's logo
      effect: destructive
      questions:
      - How does an admin remove their organization's logo in the app?
      - Can I clear the logo of an organization I manage?
      instructions:
      - text: Remove the logo from my organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: As admin, delete the logo image of organization {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'