Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud App Service Account Tokens API

4 actions 4 updates phrasing extends openapi/synadia-communications-app-service-account-tokens-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/service-account-tokens/app/{tokenId}'].get

$.paths['/core/beta/service-account-tokens/app/{tokenId}'].delete

$.paths['/core/beta/service-account-tokens/app/{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 App Service Account Tokens API
  version: 1.0.0
extends: openapi/synadia-communications-app-service-account-tokens-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/service-account-tokens/app/{tokenId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a service account token
      effect: read
      questions:
      - How do I check when a service account token expires?
      - What details are stored for one service account token?
      instructions:
      - text: Show service account token {token}.
        slots:
          token: path.tokenId
      - text: Get details for service account token {token}.
        slots:
          token: path.tokenId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/service-account-tokens/app/{tokenId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a service account token
      effect: destructive
      questions:
      - How do I revoke a service account token that leaked?
      - Can I delete one token without deleting the service account?
      instructions:
      - text: Delete service account token {token}.
        slots:
          token: path.tokenId
      - text: Revoke service account token {token}.
        slots:
          token: path.tokenId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/service-account-tokens/app/{tokenId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a service account token
      effect: write
      questions:
      - Can I extend the expiry on a service account token?
      - How do I rename a token issued to a service account?
      instructions:
      - text: Set service account token {token} to expire {expires}.
        slots:
          token: path.tokenId
          expires: requestBody.expires
      - text: Rename service account token {token} to {name}.
        slots:
          token: path.tokenId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'