Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Account API

46 actions 46 updates phrasing extends openapi/synadia-communications-account-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 46 · first 16 shown; the file carries all of them

$.info
$.paths['/core/beta/accounts/{accountId}'].get
$.paths['/core/beta/accounts/{accountId}'].delete
$.paths['/core/beta/accounts/{accountId}'].patch
$.paths['/core/beta/accounts/{accountId}/account-sk-groups'].get
$.paths['/core/beta/accounts/{accountId}/account-sk-groups'].post
$.paths['/core/beta/accounts/{accountId}/alert-rules'].get
$.paths['/core/beta/accounts/{accountId}/alert-rules'].post
$.paths['/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}'].get
$.paths['/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}'].delete
$.paths['/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}'].patch
$.paths['/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}/run'].get
$.paths['/core/beta/accounts/{accountId}/app-users'].get
$.paths['/core/beta/accounts/{accountId}/app-users/{teamAppUserId}'].post
$.paths['/core/beta/accounts/{accountId}/app-users/{teamAppUserId}'].delete
$.paths['/core/beta/accounts/{accountId}/connections'].get

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 Account API
  version: 1.0.0
extends: openapi/synadia-communications-account-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: 45
- target: $.paths['/core/beta/accounts/{accountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a NATS account
      effect: read
      questions:
      - How do I fetch the details of one Synadia account by its ID?
      - What settings does a single NATS account record hold, like its auth type and JWT settings?
      instructions:
      - text: Show me account {account}.
        slots:
          account: path.accountId
      - text: Get the configuration of NATS account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a NATS account
      effect: destructive
      questions:
      - Can I permanently delete a NATS account from a system in Synadia Control Plane?
      - How do I remove an account I no longer need from its system?
      instructions:
      - text: Delete account {account}.
        slots:
          account: path.accountId
      - text: Remove NATS account {account} from its system for good.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a NATS account's settings
      effect: write
      questions:
      - How do I rename an account or change its auth type?
      - Can I change how long user JWTs issued for an account stay valid?
      - Is it possible to turn on connectors or workloads for an existing account?
      instructions:
      - text: Rename account {account} to {name}.
        slots:
          account: path.accountId
          name: requestBody.name
      - text: Set user JWTs on account {account} to expire after {seconds} seconds.
        slots:
          account: path.accountId
          seconds: requestBody.user_jwt_expires_in_secs
      - text: Switch account {account} to auth type {auth_type}.
        slots:
          account: path.accountId
          auth_type: requestBody.auth_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/account-sk-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's signing key groups
      effect: read
      questions:
      - Which signing key groups exist on a NATS account?
      - Where can I see every signing key group I've set up for an account?
      instructions:
      - text: List the signing key groups on account {account}.
        slots:
          account: path.accountId
      - text: Show me all signing key groups for account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/account-sk-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account signing key group
      effect: write
      questions:
      - How do I add a new signing key group to an account so users get scoped permissions?
      - Can I bring my own seed when creating a signing key group?
      - What does marking a signing key group as programmatic mean when I create it?
      instructions:
      - text: Create a signing key group named {name} on account {account}.
        slots:
          account: path.accountId
          name: requestBody.name
      - text: Add a programmatic={programmatic} signing key group {name} to account {account}.
        slots:
          account: path.accountId
          name: requestBody.name
          programmatic: requestBody.programmatic
      - text: Create signing key group {name} on account {account} using seed {seed}.
        slots:
          account: path.accountId
          name: requestBody.name
          seed: requestBody.seed
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/alert-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's alert rules
      effect: read
      questions:
      - What alert rules are configured on my NATS account?
      - Where do I see every alerting rule defined for an account?
      instructions:
      - text: List the alert rules on account {account}.
        slots:
          account: path.accountId
      - text: Show all alert rules configured for account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/alert-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account alert rule
      effect: write
      questions:
      - How do I get alerted when a stream or consumer metric crosses a threshold?
      - Can an alert rule fire only after the condition holds for a certain number of seconds?
      - Which severity levels and comparison operators can a new alert rule use?
      instructions:
      - text: Create an alert on account {account} when {metric} is {operator} {value} for {seconds} seconds, severity {severity}, message {message}.
        slots:
          account: path.accountId
          metric: requestBody.metric
          operator: requestBody.threshold_operator
          value: requestBody.threshold_fixed_value
          seconds: requestBody.duration_in_secs
          severity: requestBody.severity
          message: requestBody.message
      - text: Add an alert rule on account {account} watching stream {stream} with severity {severity}.
        slots:
          account: path.accountId
          stream: requestBody.stream_name
          severity: requestBody.severity
      - text: Set up an alert for consumer {consumer} on stream {stream} in account {account}.
        slots:
          account: path.accountId
          consumer: requestBody.consumer_name
          stream: requestBody.stream_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one account alert rule
      effect: read
      questions:
      - How can I view the threshold and severity of a specific alert rule?
      - What metric is a given alert rule watching?
      instructions:
      - text: Show alert rule {rule} on account {account}.
        slots:
          account: path.accountId
          rule: path.alertRuleId
      - text: Get the definition of alert rule {rule} in account {account}.
        slots:
          account: path.accountId
          rule: path.alertRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account alert rule
      effect: destructive
      questions:
      - Can I remove an alert rule I no longer need from an account?
      - Is deleting an alert rule different from just disabling it?
      instructions:
      - text: Delete alert rule {rule} from account {account}.
        slots:
          account: path.accountId
          rule: path.alertRuleId
      - text: Remove the alert rule {rule} on account {account}.
        slots:
          account: path.accountId
          rule: path.alertRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an account alert rule
      effect: write
      questions:
      - How do I disable an existing alert rule without deleting it?
      - Can I change the threshold or severity on an alert rule I already created?
      instructions:
      - text: Disable alert rule {rule} on account {account} by setting enabled to {enabled}.
        slots:
          account: path.accountId
          rule: path.alertRuleId
          enabled: requestBody.is_enabled
      - text: Change the severity of alert rule {rule} on account {account} to {severity}.
        slots:
          account: path.accountId
          rule: path.alertRuleId
          severity: requestBody.severity
      - text: Raise the fixed threshold of alert rule {rule} on account {account} to {value}.
        slots:
          account: path.accountId
          rule: path.alertRuleId
          value: requestBody.threshold_fixed_value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/alert-rules/{alertRuleId}/run'].get
  update:
    x-apievangelist-phrasing:
      intent: Test-run an account alert rule now
      effect: read
      questions:
      - Can I evaluate an alert rule on demand to see whether it would fire right now?
      - What comes back when I run an alert rule and its condition is met?
      instructions:
      - text: Run alert rule {rule} on account {account} and tell me if it triggers.
        slots:
          account: path.accountId
          rule: path.alertRuleId
      - text: Evaluate alert rule {rule} for account {account} right now.
        slots:
          account: path.accountId
          rule: path.alertRuleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/app-users'].get
  update:
    x-apievangelist-phrasing:
      intent: List app users with access to an account
      effect: read
      questions:
      - Which team members have been given access to a particular NATS account?
      - Who are the app users assigned to an account and what roles do they hold?
      instructions:
      - text: List the app users assigned to account {account}.
        slots:
          account: path.accountId
      - text: Show who has access to account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/app-users/{teamAppUserId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a team member a role on an account
      effect: write
      questions:
      - How do I give a teammate access to a specific NATS account with a role?
      - If a user is already assigned to an account, can I just change their role?
      instructions:
      - text: Assign app user {user} to account {account} with role {role}.
        slots:
          account: path.accountId
          user: path.teamAppUserId
          role: requestBody.role_id
      - text: Change app user {user}'s role on account {account} to {role}.
        slots:
          account: path.accountId
          user: path.teamAppUserId
          role: requestBody.role_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/app-users/{teamAppUserId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a team member from an account
      effect: destructive
      questions:
      - How do I revoke a teammate's access to one NATS account?
      - Can I unassign an app user from an account without removing them from the team?
      instructions:
      - text: Unassign app user {user} from account {account}.
        slots:
          account: path.accountId
          user: path.teamAppUserId
      - text: Take away app user {user}'s access to account {account}.
        slots:
          account: path.accountId
          user: path.teamAppUserId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List live client connections on an account
      effect: read
      questions:
      - Which clients are connected to my NATS account right now?
      - Can I filter an account's connections by state, subject or NATS user?
      - Is there a limit on how many connections come back, and can I sort them?
      instructions:
      - text: List connections on account {account}.
        slots:
          account: path.accountId
      - text: Show connections on account {account} in state {state}, up to {limit}.
        slots:
          account: path.accountId
          state: query.state
          limit: query.limit
      - text: Find connections on account {account} for NATS user {user} subscribed to {subject}.
        slots:
          account: path.accountId
          user: query.user
          subject: query.subject
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export an account's seeds
      effect: read
      questions:
      - How can I export the signing seeds for a NATS account as a backup?
      - Is there a way to download an account's seed material?
      instructions:
      - text: Export the seeds for account {account}.
        slots:
          account: path.accountId
      - text: Download account {account}'s seed export.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get server-side info for an account
      effect: read
      questions:
      - What runtime info does the server report about a NATS account?
      - Where can I see an account's info as the NATS system sees it, beyond its settings?
      instructions:
      - text: Get account info for {account}.
        slots:
          account: path.accountId
      - text: Show the server-reported info for account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/jetstream'].get
  update:
    x-apievangelist-phrasing:
      intent: List all JetStream assets on an account
      effect: read
      questions:
      - What JetStream assets, of every kind, does an account have?
      - Can I get one overview of all streams, KV and object buckets in an account?
      instructions:
      - text: List every JetStream asset in account {account}.
        slots:
          account: path.accountId
      - text: Give me an overview of the JetStream assets on account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/jetstream/kv-buckets'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's KV buckets
      effect: read
      questions:
      - Which key-value buckets exist in a NATS account?
      - Where do I see all KV buckets set up under one account?
      instructions:
      - text: List the KV buckets in account {account}.
        slots:
          account: path.accountId
      - text: Show me all key-value buckets on account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/jetstream/kv-buckets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a KV bucket in an account
      effect: write
      questions:
      - How do I create a new key-value bucket under a NATS account?
      - Can I set how many historical values per key a KV bucket keeps when I create it?
      - What storage choices and replica counts are allowed for a new KV bucket?
      instructions:
      - text: Create KV bucket {bucket} in account {account} with {storage} storage.
        slots:
          account: path.accountId
          bucket: requestBody.bucket
          storage: requestBody.storage
      - text: Create KV bucket {bucket} on account {account} keeping {history} revisions per key.
        slots:
          account: path.accountId
          bucket: requestBody.bucket
          history: requestBody.history
      - text: Make a {replicas}-replica KV bucket {bucket} in account {account}.
        slots:
          account: path.accountId
          bucket: requestBody.bucket
          replicas: requestBody.num_replicas
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/jetstream/mirrors'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's stream mirrors
      effect: read
      questions:
      - Which mirror streams exist in my NATS account?
      - Where can I see all the stream mirrors configured under an account?
      instructions:
      - text: List the mirrors in account {account}.
        slots:
          account: path.accountId
      - text: Show all mirror streams on account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/jetstream/mirrors'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a mirror of a stream
      effect: write
      questions:
      - How do I create a mirror that copies another stream's messages?
      - Can a mirror use a different storage type or replica count than its origin stream?
      - What retention and discard settings does a new mirror require?
      instructions:
      - text: Create mirror {name} in account {account} mirroring {mirror}.
        slots:
          account: path.accountId
          name: requestBody.name
          mirror: requestBody.mirror
      - text: Create mirror {name} on account {account} with {storage} storage and {replicas} replicas.
        slots:
          account: path.accountId
          name: requestBody.name
          storage: requestBody.storage
          replicas: requestBody.num_replicas
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/jetstream/object-buckets'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's object store buckets
      effect: read
      questions:
      - Which object store buckets exist under a NATS account?
      - Where do I see every object bucket in an account?
      instructions:
      - text: List the object buckets in account {account}.
        slots:
          account: path.accountId
      - text: Show all object store buckets on account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/jetstream/object-buckets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an object store bucket
      effect: write
      questions:
      - How do I create an object store bucket for large files in a NATS account?
      - Can I cap the total size or age of objects when creating an object bucket?
      instructions:
      - text: Create object bucket {bucket} in account {account}.
        slots:
          account: path.accountId
          bucket: requestBody.bucket
      - text: Create object bucket {bucket} on account {account} limited to {max_bytes} bytes.
        slots:
          account: path.accountId
          bucket: requestBody.bucket
          max_bytes: requestBody.max_bytes
      - text: Create a compressed object bucket {bucket} on account {account} with compression {compression}.
        slots:
          account: path.accountId
          bucket: requestBody.bucket
          compression: requestBody.compression
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/jetstream/placement-options'].get
  update:
    x-apievangelist-phrasing:
      intent: See where JetStream assets can be placed
      effect: read
      questions:
      - Which clusters or tags can I place a new stream on for an account?
      - What placement options are available before I create a JetStream asset?
      instructions:
      - text: Get the JetStream placement options for account {account}.
        slots:
          account: path.accountId
      - text: Show where account {account} can place streams and buckets.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/jetstream/streams'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's JetStream streams
      effect: read
      questions:
      - What JetStream streams exist in a NATS account?
      - Where can I list every stream under one account?
      instructions:
      - text: List the streams in account {account}.
        slots:
          account: path.accountId
      - text: Show me all JetStream streams on account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/jetstream/streams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a JetStream stream
      effect: write
      questions:
      - How do I create a JetStream stream that captures a set of subjects?
      - Can I limit a new stream by message count, bytes and age at the same time?
      - Which retention policies can a stream use when I create it?
      instructions:
      - text: Create stream {name} in account {account} capturing subjects {subjects}.
        slots:
          account: path.accountId
          name: requestBody.name
          subjects: requestBody.subjects
      - text: Create stream {name} on account {account} with {retention} retention and max age {max_age}.
        slots:
          account: path.accountId
          name: requestBody.name
          retention: requestBody.retention
          max_age: requestBody.max_age
      - text: Create a {replicas}-replica {storage} stream {name} in account {account}.
        slots:
          account: path.accountId
          name: requestBody.name
          replicas: requestBody.num_replicas
          storage: requestBody.storage
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage metrics for an account
      effect: read
      questions:
      - Where do I see message and connection metrics for one NATS account?
      - Can I pull an account's metrics to check how much it is being used?
      instructions:
      - text: Get the metrics for account {account}.
        slots:
          account: path.accountId
      - text: Show usage metrics for account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/nats-core/websocket/view'].get
  update:
    x-apievangelist-phrasing:
      intent: Watch a NATS subject live over WebSocket
      effect: read
      questions:
      - Can I subscribe to a NATS Core subject from a browser over WebSocket?
      - How do I tail the live messages on a subject in an account without setting up a client?
      instructions:
      - text: Open a WebSocket view of subject {subject} on account {account}.
        slots:
          account: path.accountId
          subject: query.subject
      - text: Stream live messages on {subject} in account {account} to me.
        slots:
          account: path.accountId
          subject: query.subject
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a NATS user NKey's revocation
      effect: read
      questions:
      - How can I tell whether a NATS user's NKey has been revoked on an account?
      - What cutoff time is set on an existing user revocation?
      instructions:
      - text: Check whether user NKey {nkey} is revoked on account {account}.
        slots:
          account: path.accountId
          nkey: path.userNkeyPublic
      - text: Show the revocation for user NKey {nkey} in account {account}.
        slots:
          account: path.accountId
          nkey: path.userNkeyPublic
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic}'].put
  update:
    x-apievangelist-phrasing:
      intent: Revoke credentials for a NATS user NKey
      effect: destructive
      questions:
      - How do I revoke every credential issued to a NATS user before a certain time?
      - What happens if I set the revocation cutoff to 0?
      instructions:
      - text: Revoke user NKey {nkey} on account {account} for credentials issued before {before}.
        slots:
          account: path.accountId
          nkey: path.userNkeyPublic
          before: requestBody.before
      - text: Revoke all current credentials for user NKey {nkey} in account {account} as of now, using cutoff {before}.
        slots:
          account: path.accountId
          nkey: path.userNkeyPublic
          before: requestBody.before
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/nats-user-revocations/{userNkeyPublic}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Lift a NATS user NKey revocation
      effect: destructive
      questions:
      - Can I undo a revocation so a NATS user's older credentials work again?
      - How do I remove a revocation entry from an account?
      instructions:
      - text: Remove the revocation for user NKey {nkey} on account {account}.
        slots:
          account: path.accountId
          nkey: path.userNkeyPublic
      - text: Lift the revocation on user NKey {nkey} in account {account}.
        slots:
          account: path.accountId
          nkey: path.userNkeyPublic
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/nats-users'].get
  update:
    x-apievangelist-phrasing:
      intent: List NATS users in an account
      effect: read
      questions:
      - Which NATS users belong to an account?
      - Where can I see every NATS user created under one account?
      instructions:
      - text: List the NATS users in account {account}.
        slots:
          account: path.accountId
      - text: Show me all NATS users on account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/nats-users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a NATS user in an account
      effect: write
      questions:
      - How do I create a new NATS user tied to a signing key group?
      - Can I make a NATS user whose JWT expires after a set number of seconds?
      instructions:
      - text: Create NATS user {name} in account {account} under signing key group {sk_group}.
        slots:
          account: path.accountId
          name: requestBody.name
          sk_group: requestBody.sk_group_id
      - text: Create NATS user {name} on account {account} in group {sk_group} with a JWT lasting {seconds} seconds.
        slots:
          account: path.accountId
          name: requestBody.name
          sk_group: requestBody.sk_group_id
          seconds: requestBody.jwt_expires_in_secs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/stream-exports'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's stream exports
      effect: read
      questions:
      - Which streams has my account exported for other accounts to use?
      - Where can I see the stream exports an account publishes?
      instructions:
      - text: List the stream exports of account {account}.
        slots:
          account: path.accountId
      - text: Show which streams account {account} exports.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/stream-exports'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a stream to other accounts
      effect: write
      questions:
      - How do I share a JetStream stream from one account so others can import it?
      - Can a stream export be public rather than shared with specific accounts?
      instructions:
      - text: Export stream {stream} from account {account}.
        slots:
          account: path.accountId
          stream: requestBody.stream_name
      - text: Export stream {stream} from account {account} with public set to {is_public}.
        slots:
          account: path.accountId
          stream: requestBody.stream_name
          is_public: requestBody.is_public
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/stream-imports'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's stream imports
      effect: read
      questions:
      - Which streams has my account imported from other accounts?
      - Where do I see the stream imports configured on an account?
      instructions:
      - text: List the stream imports on account {account}.
        slots:
          account: path.accountId
      - text: Show the streams account {account} imports.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/stream-imports'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a stream from another account
      effect: write
      questions:
      - How do I import a stream another account exported to me?
      - What subject prefixes do I need to set when importing a remote stream?
      instructions:
      - text: Import stream {stream} from account NKey {remote} into account {account} with deliver prefix {deliver_prefix} and JS prefix {js_prefix}.
        slots:
          account: path.accountId
          stream: requestBody.stream_name
          remote: requestBody.remote_account_nkey_public
          deliver_prefix: requestBody.deliver_subject_prefix
          js_prefix: requestBody.js_subject_prefix
      - text: Import public stream {stream} from {remote} into account {account}.
        slots:
          account: path.accountId
          stream: requestBody.stream_name
          remote: requestBody.remote_account_nkey_public
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/stream-imports/shared'].get
  update:
    x-apievangelist-phrasing:
      intent: List stream exports shared with an account
      effect: read
      questions:
      - Which streams have other accounts shared with mine that I could import?
      - Where can I discover stream exports available to my account?
      instructions:
      - text: List the stream exports shared with account {account}.
        slots:
          account: path.accountId
      - text: Show which other accounts' streams account {account} is allowed to import.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/accounts/{accountId}/subject-exports'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's subject exports
      effect: read
      questions:
      - Which subjects or services does my account export?
      - Where do I see the subject exports defined on an account?
      instructions:
      - text: List the subject exports of account {account}.
        slots:
          account: path.accountId
      - text: Show which subjects account {account} exports.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'


# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/synadia-communications/refs/heads/main/overlays/synadia-communications-account-api-phrasing-overlay.yaml