Synadia Communications · OpenAPI Overlay 1.0.0

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

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

$.info

$.paths['/core/beta/subject-exports/{subjectExportId}'].get

$.paths['/core/beta/subject-exports/{subjectExportId}'].delete

$.paths['/core/beta/subject-exports/{subjectExportId}'].patch

$.paths['/core/beta/subject-exports/{subjectExportId}/shares'].get

$.paths['/core/beta/subject-exports/{subjectExportId}/shares'].post

$.paths['/core/beta/subject-exports/{subjectExportId}/shares/{targetAccountNKeyPublic}'].delete

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 Subject Export API
  version: 1.0.0
extends: openapi/synadia-communications-subject-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: 6
- target: $.paths['/core/beta/subject-exports/{subjectExportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subject export
      effect: read
      questions:
      - What subject does a given export expose to other accounts?
      - Can I view a subject export's settings?
      instructions:
      - text: Show subject export {subjectExportId}.
        slots:
          subjectExportId: path.subjectExportId
      - text: Get info on subject export {subjectExportId}.
        slots:
          subjectExportId: path.subjectExportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/subject-exports/{subjectExportId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subject export
      effect: destructive
      questions:
      - Can I stop exporting a subject to other accounts?
      - What's the way to delete a subject export?
      instructions:
      - text: Delete subject export {subjectExportId}.
        slots:
          subjectExportId: path.subjectExportId
      - text: Remove subject export {subjectExportId}.
        slots:
          subjectExportId: path.subjectExportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/subject-exports/{subjectExportId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a subject export's settings
      effect: write
      questions:
      - Can I turn on service latency metrics for an exported subject?
      - Is it possible to change the sampling percentage on export metrics?
      instructions:
      - text: Enable metrics on subject export {subjectExportId} with {metrics_sampling_percentage}% sampling.
        slots:
          subjectExportId: path.subjectExportId
          metrics_sampling_percentage: requestBody.metrics_sampling_percentage
      - text: Set metrics_enabled={metrics_enabled} on subject export {subjectExportId}.
        slots:
          metrics_enabled: requestBody.metrics_enabled
          subjectExportId: path.subjectExportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/subject-exports/{subjectExportId}/shares'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts a subject export is shared with
      effect: read
      questions:
      - Which accounts have been granted access to my exported subject?
      - Can I list the shares on a subject export?
      instructions:
      - text: List the shares for subject export {subjectExportId}.
        slots:
          subjectExportId: path.subjectExportId
      - text: Show which accounts subject export {subjectExportId} is shared with.
        slots:
          subjectExportId: path.subjectExportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/subject-exports/{subjectExportId}/shares'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a subject export with an account
      effect: write
      questions:
      - How do I share an exported subject with another account?
      - Do I need the target account's public NKey to share a subject?
      instructions:
      - text: Share subject export {subjectExportId} with account {target_account_nkey_public}.
        slots:
          subjectExportId: path.subjectExportId
          target_account_nkey_public: requestBody.target_account_nkey_public
      - text: Grant account {target_account_nkey_public} access to subject export {subjectExportId}.
        slots:
          target_account_nkey_public: requestBody.target_account_nkey_public
          subjectExportId: path.subjectExportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/subject-exports/{subjectExportId}/shares/{targetAccountNKeyPublic}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an account's share of a subject export
      effect: destructive
      questions:
      - Can I revoke one account's access to my exported subject?
      - What's the way to unshare a subject export from an account?
      instructions:
      - text: Revoke account {targetAccountNKeyPublic}'s share of subject export {subjectExportId}.
        slots:
          targetAccountNKeyPublic: path.targetAccountNKeyPublic
          subjectExportId: path.subjectExportId
      - text: Unshare subject export {subjectExportId} from {targetAccountNKeyPublic}.
        slots:
          subjectExportId: path.subjectExportId
          targetAccountNKeyPublic: path.targetAccountNKeyPublic
      method: generated
      generated: '2026-10-01'