Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Personal Access Token API

4 actions 4 updates phrasing extends openapi/synadia-communications-personal-access-token-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Synadia Communications's API. It is a proposal applied on top of the contract, not a document Synadia Communications publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/core/beta/personal-access-tokens/{tokenId}'].get

$.paths['/core/beta/personal-access-tokens/{tokenId}'].delete

$.paths['/core/beta/personal-access-tokens/{tokenId}'].patch

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 Synadia Control Plane / Synadia Cloud Personal Access Token API
  version: 1.0.0
extends: openapi/synadia-communications-personal-access-token-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/core/beta/personal-access-tokens/{tokenId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a personal access token
      effect: read
      questions:
      - How can I see when one of my personal access tokens expires?
      - What details are kept for a personal access token?
      instructions:
      - text: Show personal access token {token}.
        slots:
          token: path.tokenId
      - text: Get details for my personal token {token}.
        slots:
          token: path.tokenId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/personal-access-tokens/{tokenId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a personal access token
      effect: destructive
      questions:
      - How do I revoke a personal access token I no longer use?
      - Can I delete a personal token that may be compromised?
      instructions:
      - text: Delete personal access token {token}.
        slots:
          token: path.tokenId
      - text: Revoke my personal token {token}.
        slots:
          token: path.tokenId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/personal-access-tokens/{tokenId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a personal access token
      effect: write
      questions:
      - Can I extend the expiry of a personal access token?
      - How do I rename one of my personal tokens?
      instructions:
      - text: Set personal access token {token} to expire {expires}.
        slots:
          token: path.tokenId
          expires: requestBody.expires
      - text: Rename personal token {token} to {name}.
        slots:
          token: path.tokenId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'