Synadia Communications · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/synadia-communications-stream-export-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 6

$.info
$.paths['/core/beta/stream-exports/{streamExportId}'].get
$.paths['/core/beta/stream-exports/{streamExportId}'].delete
$.paths['/core/beta/stream-exports/{streamExportId}/shares'].get
$.paths['/core/beta/stream-exports/{streamExportId}/shares'].post
$.paths['/core/beta/stream-exports/{streamExportId}/shares/{targetAccountNKeyPublic}'].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 Export API
  version: 1.0.0
extends: openapi/synadia-communications-stream-export-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: 5
- target: $.paths['/core/beta/stream-exports/{streamExportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a stream export
      effect: read
      questions:
      - How do I see the details of one stream export?
      - Is a given stream export public or shared with specific accounts?
      instructions:
      - text: Show stream export {export}.
        slots:
          export: path.streamExportId
      - text: Get info about stream export {export}.
        slots:
          export: path.streamExportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/stream-exports/{streamExportId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stream export
      effect: destructive
      questions:
      - Can I stop exporting a stream to other accounts?
      - How do I remove a stream export altogether?
      instructions:
      - text: Delete stream export {export}.
        slots:
          export: path.streamExportId
      - text: Stop exporting the stream behind export {export}.
        slots:
          export: path.streamExportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/stream-exports/{streamExportId}/shares'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts a stream export is shared with
      effect: read
      questions:
      - Which accounts can import a stream I've exported?
      - Where do I see the shares on a stream export?
      instructions:
      - text: List the shares for stream export {export}.
        slots:
          export: path.streamExportId
      - text: Show which accounts stream export {export} is shared with.
        slots:
          export: path.streamExportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/stream-exports/{streamExportId}/shares'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a stream export with another account
      effect: write
      questions:
      - How do I let another account import my exported stream?
      - What do I need from the other account to share a stream with it?
      instructions:
      - text: Share stream export {export} with account NKey {target}.
        slots:
          export: path.streamExportId
          target: requestBody.target_account_nkey_public
      - text: Grant account {target} access to stream export {export}.
        slots:
          export: path.streamExportId
          target: requestBody.target_account_nkey_public
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/stream-exports/{streamExportId}/shares/{targetAccountNKeyPublic}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a stream share from an account
      effect: destructive
      questions:
      - How do I revoke one account's access to my exported stream?
      - Can I unshare a stream export from a single account but keep the export?
      instructions:
      - text: Revoke stream export {export}'s share with account NKey {target}.
        slots:
          export: path.streamExportId
          target: path.targetAccountNKeyPublic
      - text: Unshare stream export {export} from account {target}.
        slots:
          export: path.streamExportId
          target: path.targetAccountNKeyPublic
      method: generated
      generated: '2026-10-01'