Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Stream Import API

3 actions 3 updates phrasing extends openapi/synadia-communications-stream-import-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/stream-imports/{streamImportId}'].get
$.paths['/core/beta/stream-imports/{streamImportId}'].delete

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 Stream Import API
  version: 1.0.0
extends: openapi/synadia-communications-stream-import-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/stream-imports/{streamImportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a stream import
      effect: read
      questions:
      - How do I view the details of one stream import?
      - Which remote stream and subject prefixes does a stream import use?
      instructions:
      - text: Show stream import {import}.
        slots:
          import: path.streamImportId
      - text: Get details for stream import {import}.
        slots:
          import: path.streamImportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/stream-imports/{streamImportId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stream import
      effect: destructive
      questions:
      - Can I stop importing a stream from another account?
      - How do I remove a stream import?
      instructions:
      - text: Delete stream import {import}.
        slots:
          import: path.streamImportId
      - text: Remove stream import {import} from my account.
        slots:
          import: path.streamImportId
      method: generated
      generated: '2026-10-01'