Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Backend Organization Permissions API

6 actions 6 updates phrasing extends openapi/clerk-com-organization-permissions-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 6

$.info
$.paths['/organization_permissions'].get
$.paths['/organization_permissions'].post
$.paths['/organization_permissions/{permission_id}'].get
$.paths['/organization_permissions/{permission_id}'].delete
$.paths['/organization_permissions/{permission_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 Backend Organization Permissions API
  version: 1.0.0
extends: openapi/clerk-com-organization-permissions-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: 5
- target: $.paths['/organization_permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization permissions
      effect: read
      questions:
      - Which custom organization permissions are defined in my instance?
      - Can I search organization permissions by name or key?
      instructions:
      - text: List all organization permissions.
      - text: Search organization permissions for {query}.
        slots:
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization_permissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization permission
      effect: write
      questions:
      - How do I define a new permission like org:invoices:read for organization roles?
      - What name and key does a new organization permission need?
      instructions:
      - text: Create organization permission {name} with key {key}.
        slots:
          name: requestBody.name
          key: requestBody.key
      - text: Add permission {key} named {name} described as {description}.
        slots:
          key: requestBody.key
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization_permissions/{permission_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an organization permission
      effect: read
      questions:
      - How do I see the details of one organization permission?
      - What key and description does a given permission ID have?
      instructions:
      - text: Show organization permission {permission_id}.
        slots:
          permission_id: path.permission_id
      - text: Get the key of permission {permission_id}.
        slots:
          permission_id: path.permission_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization_permissions/{permission_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization permission
      effect: destructive
      questions:
      - How do I delete a custom organization permission I no longer need?
      - Can system permissions be deleted?
      instructions:
      - text: Delete organization permission {permission_id}.
        slots:
          permission_id: path.permission_id
      - text: Remove custom permission {permission_id} from the instance.
        slots:
          permission_id: path.permission_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization_permissions/{permission_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an organization permission
      effect: write
      questions:
      - How do I rename an organization permission or change its key?
      - Can I edit the description of a system permission?
      instructions:
      - text: Rename organization permission {permission_id} to {name}.
        slots:
          permission_id: path.permission_id
          name: requestBody.name
      - text: Change the key of permission {permission_id} to {key}.
        slots:
          permission_id: path.permission_id
          key: requestBody.key
      method: generated
      generated: '2026-09-26'