Synadia Communications · OpenAPI Overlay 1.0.0

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

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

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

$.paths['/core/beta/service-account-tokens/team/{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 Team Service Account Tokens API
  version: 1.0.0
extends: openapi/synadia-communications-team-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/team/{tokenId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service account token
      effect: read
      questions:
      - When does a service account token expire?
      - Can I look up one service account token by ID?
      instructions:
      - text: Show service account token {tokenId}.
        slots:
          tokenId: path.tokenId
      - text: Get the details of token {tokenId}.
        slots:
          tokenId: path.tokenId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/service-account-tokens/team/{tokenId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a service account token
      effect: destructive
      questions:
      - Can I revoke a leaked service account token?
      - What's the way to delete a service account token?
      instructions:
      - text: Delete service account token {tokenId}.
        slots:
          tokenId: path.tokenId
      - text: Revoke token {tokenId}.
        slots:
          tokenId: path.tokenId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/service-account-tokens/team/{tokenId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or extend a service account token
      effect: write
      questions:
      - Can I change when a service account token expires?
      - Is it possible to rename an existing token?
      instructions:
      - text: Rename token {tokenId} to {name}.
        slots:
          tokenId: path.tokenId
          name: requestBody.name
      - text: Set token {tokenId} to expire on {expires}.
        slots:
          tokenId: path.tokenId
          expires: requestBody.expires
      method: generated
      generated: '2026-10-01'