Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Workloads API

3 actions 3 updates phrasing extends openapi/synadia-communications-workloads-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 3

$.info
$.paths['/workloads/alpha/{accountId}/limits'].get
$.paths['/workloads/alpha/{accountId}/tags'].get

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 Synadia Control Plane / Synadia Cloud Workloads API
  version: 1.0.0
extends: openapi/synadia-communications-workloads-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: 2
- target: $.paths['/workloads/alpha/{accountId}/limits'].get
  update:
    x-apievangelist-phrasing:
      intent: Get workload limits for an account
      effect: read
      questions:
      - What workload limits apply to my account?
      - How many workloads can an account run?
      instructions:
      - text: Show workload limits for account {accountId}.
        slots:
          accountId: path.accountId
      - text: Get the workloads quota for account {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workloads/alpha/{accountId}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List workload tags for an account
      effect: read
      questions:
      - Which tags are used on workloads in my account?
      - Can I list the workload tags available in an account?
      instructions:
      - text: List workload tags for account {accountId}.
        slots:
          accountId: path.accountId
      - text: Show the tags on workloads in account {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'