Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Platform Application Transfers API

5 actions 5 updates phrasing extends openapi/clerk-com-application-transfers-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['/platform/application_transfers'].get

$.paths['/platform/applications/{applicationID}/transfers'].post

$.paths['/platform/applications/{applicationID}/transfers/{transferID}'].get

$.paths['/platform/applications/{applicationID}/transfers/{transferID}'].delete

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 Platform Application Transfers API
  version: 1.0.0
extends: openapi/clerk-com-application-transfers-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['/platform/application_transfers'].get
  update:
    x-apievangelist-phrasing:
      intent: List application transfers my workspace created
      effect: read
      questions:
      - Which application ownership transfers has my workspace started?
      - Can I list only pending application transfers?
      instructions:
      - text: List my workspace's application transfers.
      - text: Show application transfers with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/transfers'].post
  update:
    x-apievangelist-phrasing:
      intent: Start transferring an application to another workspace
      effect: write
      questions:
      - How do I hand an application over to another workspace?
      - How long does an application transfer request stay valid?
      instructions:
      - text: Create a transfer request for application {applicationID}.
        slots:
          applicationID: path.applicationID
      - text: Start moving ownership of {applicationID} to another workspace.
        slots:
          applicationID: path.applicationID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/transfers/{transferID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application transfer
      effect: read
      questions:
      - Has the other workspace accepted my application transfer yet?
      - What are the details of one application transfer?
      instructions:
      - text: Get transfer {transferID} for application {applicationID}.
        slots:
          applicationID: path.applicationID
          transferID: path.transferID
      - text: Show the status of transfer {transferID} on {applicationID}.
        slots:
          applicationID: path.applicationID
          transferID: path.transferID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/transfers/{transferID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending application transfer
      effect: destructive
      questions:
      - How do I cancel an application transfer I started by mistake?
      - Can a transfer that's no longer pending be canceled?
      instructions:
      - text: Cancel transfer {transferID} for application {applicationID}.
        slots:
          applicationID: path.applicationID
          transferID: path.transferID
      - text: Withdraw pending transfer {transferID} of {applicationID}.
        slots:
          applicationID: path.applicationID
          transferID: path.transferID
      method: generated
      generated: '2026-09-26'