Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Platform Components API

2 actions 2 updates phrasing extends openapi/synadia-communications-platform-components-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 2

$.info

$.paths['/core/beta/platform-components/connect'].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 Platform Components API
  version: 1.0.0
extends: openapi/synadia-communications-platform-components-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: 1
- target: $.paths['/core/beta/platform-components/connect'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect a platform component
      effect: write
      questions:
      - How does a platform component register its connection with the Control Plane?
      - What does a platform component need to send when it connects?
      instructions:
      - text: Connect platform component {id} with public NKey {nkey}.
        slots:
          id: path.id
          nkey: requestBody.nkey_public
      - text: Register component {id} using NKey {nkey} and data {data}.
        slots:
          id: path.id
          nkey: requestBody.nkey_public
          data: requestBody.data
      method: generated
      generated: '2026-10-01'