Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Component Versions API

3 actions 3 updates phrasing extends openapi/synadia-communications-component-versions-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['/core/beta/component-versions'].get

$.paths['/core/beta/component-versions'].post

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 Component Versions API
  version: 1.0.0
extends: openapi/synadia-communications-component-versions-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['/core/beta/component-versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List available component versions
      effect: read
      questions:
      - Which platform component versions are available?
      - Can I see every available version of the components?
      instructions:
      - text: List all available component versions.
      - text: Show me the component versions I can deploy.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/component-versions'].post
  update:
    x-apievangelist-phrasing:
      intent: Find component versions by type and release
      effect: read
      questions:
      - Which component versions match a given major and minor release?
      - Can I filter available versions by deployment type?
      instructions:
      - text: Find component versions for {major}.{minor}.
        slots:
          major: requestBody.major
          minor: requestBody.minor
      - text: Show {deployment_type} component versions for release {major}.{minor}.
        slots:
          deployment_type: requestBody.deployment_type
          major: requestBody.major
          minor: requestBody.minor
      method: generated
      generated: '2026-10-01'