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

# 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 System API
  version: 1.0.0
extends: openapi/synadia-communications-system-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: 44
- target: $.paths['/core/beta/systems/{systemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a NATS system's details
      effect: read
      questions:
      - What connection settings and JetStream domain does my NATS system have?
      - Can I look up a single system by its ID to see its URL and name?
      instructions:
      - text: Show me the details of system {systemId}.
        slots:
          systemId: path.systemId
      - text: Fetch the configuration for NATS system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a system
      effect: destructive
      questions:
      - What happens to the accounts when I delete a whole system?
      - Can I permanently remove a NATS system and purge it from the servers?
      instructions:
      - text: Delete system {systemId} and purge it from NATS.
        slots:
          systemId: path.systemId
      - text: Remove system {systemId} entirely.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a system's settings
      effect: write
      questions:
      - Can I change a system's server URL and test the connection before saving?
      - Is it possible to turn on JetStream or set the JetStream domain on an existing system?
      - Where do I configure log forwarding or NATS alerting for a system?
      instructions:
      - text: Rename system {systemId} to {name}.
        slots:
          systemId: path.systemId
          name: requestBody.name
      - text: Point system {systemId} at {url}.
        slots:
          systemId: path.systemId
          url: requestBody.url
      - text: Set the JetStream domain on system {systemId} to {jetstream_domain}.
        slots:
          systemId: path.systemId
          jetstream_domain: requestBody.jetstream_domain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts in a system
      effect: read
      questions:
      - Which NATS accounts exist in my system?
      - Can I see every account that belongs to one system?
      instructions:
      - text: List the accounts in system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show all NATS accounts under system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account in a system
      effect: write
      questions:
      - How do I add a new NATS account to my system?
      - Can I set how long user JWTs last when creating an account?
      - Is it possible to enable workloads or connectors when I create an account?
      instructions:
      - text: Create an account named {name} in system {systemId}.
        slots:
          name: requestBody.name
          systemId: path.systemId
      - text: Add account {name} to system {systemId} with user JWTs expiring after {user_jwt_expires_in_secs} seconds.
        slots:
          name: requestBody.name
          systemId: path.systemId
          user_jwt_expires_in_secs: requestBody.user_jwt_expires_in_secs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/accounts-overview-metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get overview metrics for a system's accounts
      effect: read
      questions:
      - What are the usage metrics across all accounts in my system?
      - Is there a dashboard-style summary of account activity for one system?
      instructions:
      - text: Show the accounts overview metrics for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Pull per-account summary metrics for system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/agent-tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List dataplane agent tokens
      effect: read
      questions:
      - Which agent tokens have been issued for my system's dataplane agent?
      - Can I see the history of agent tokens for a system?
      instructions:
      - text: List the agent tokens for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show all dataplane agent tokens issued for system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/agent-tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate the dataplane agent token
      effect: write
      questions:
      - How do I rotate the token my dataplane agent uses to connect?
      - Can I issue a fresh agent token if the old one leaked?
      instructions:
      - text: Rotate the agent token for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Generate a new dataplane agent connection token for system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/agent-tokens/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current agent token
      effect: read
      questions:
      - Which agent token is currently active for my system?
      - Where can I copy the live token for connecting the dataplane agent?
      instructions:
      - text: Get the current agent token for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show me the active dataplane agent token on system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/alert-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a system's alert rules
      effect: read
      questions:
      - What alert rules are configured on my system?
      - Can I see every metric threshold alert set up for one system?
      instructions:
      - text: List the alert rules for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show all configured alerts on system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/alert-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alert rule on a system
      effect: write
      questions:
      - Can I get alerted when a metric crosses a threshold for a set duration?
      - What severity levels and threshold operators can a new system alert use?
      - Is it possible to compare a metric against another metric times a multiplier?
      instructions:
      - text: Alert {severity} on system {systemId} when {metric} {threshold_operator} {threshold_fixed_value} for {duration_in_secs}s, saying {message}.
        slots:
          systemId: path.systemId
          metric: requestBody.metric
          threshold_operator: requestBody.threshold_operator
          threshold_fixed_value: requestBody.threshold_fixed_value
          duration_in_secs: requestBody.duration_in_secs
          severity: requestBody.severity
          message: requestBody.message
      - text: Add a {severity} alert rule to system {systemId} watching {metric}.
        slots:
          severity: requestBody.severity
          systemId: path.systemId
          metric: requestBody.metric
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/alert-rules/{alertRuleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a system alert rule
      effect: read
      questions:
      - What threshold and severity does a specific alert rule use?
      - Can I view one alert rule's configuration by its ID?
      instructions:
      - text: Show alert rule {alertRuleId} on system {systemId}.
        slots:
          alertRuleId: path.alertRuleId
          systemId: path.systemId
      - text: Get the settings of alert rule {alertRuleId} in system {systemId}.
        slots:
          alertRuleId: path.alertRuleId
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/alert-rules/{alertRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a system alert rule
      effect: destructive
      questions:
      - Can I remove an alert rule I no longer need?
      - What's the way to stop and delete one system alert permanently?
      instructions:
      - text: Delete alert rule {alertRuleId} from system {systemId}.
        slots:
          alertRuleId: path.alertRuleId
          systemId: path.systemId
      - text: Remove the alert {alertRuleId} on system {systemId}.
        slots:
          alertRuleId: path.alertRuleId
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/alert-rules/{alertRuleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or disable a system alert rule
      effect: write
      questions:
      - Can I temporarily disable an alert rule without deleting it?
      - Is it possible to change an existing alert's threshold or severity?
      instructions:
      - text: Set alert rule {alertRuleId} on system {systemId} to enabled={is_enabled}.
        slots:
          alertRuleId: path.alertRuleId
          systemId: path.systemId
          is_enabled: requestBody.is_enabled
      - text: Change the severity of alert rule {alertRuleId} in system {systemId} to {severity}.
        slots:
          alertRuleId: path.alertRuleId
          systemId: path.systemId
          severity: requestBody.severity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/alert-rules/{alertRuleId}/run'].get
  update:
    x-apievangelist-phrasing:
      intent: Evaluate an alert rule now
      effect: read
      questions:
      - Can I test whether an alert rule's condition is met right now?
      - Does evaluating an alert rule on demand return the alert it would fire?
      instructions:
      - text: Run alert rule {alertRuleId} on system {systemId} and tell me if it fires.
        slots:
          alertRuleId: path.alertRuleId
          systemId: path.systemId
      - text: Evaluate alert {alertRuleId} for system {systemId} now.
        slots:
          alertRuleId: path.alertRuleId
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/app-users'].get
  update:
    x-apievangelist-phrasing:
      intent: List app users with access to a system
      effect: read
      questions:
      - Which team members have been given access to this system?
      - Can I see the app users assigned to a system and their roles?
      instructions:
      - text: List the app users assigned to system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show who has access to system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/app-users/{teamAppUserId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a team app user a role on a system
      effect: write
      questions:
      - How do I give a teammate access to a specific system?
      - Will reassigning someone already on the system just update their role?
      instructions:
      - text: Assign app user {teamAppUserId} to system {systemId} with role {role_id}.
        slots:
          teamAppUserId: path.teamAppUserId
          systemId: path.systemId
          role_id: requestBody.role_id
      - text: Change {teamAppUserId}'s role on system {systemId} to {role_id}.
        slots:
          teamAppUserId: path.teamAppUserId
          systemId: path.systemId
          role_id: requestBody.role_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/app-users/{teamAppUserId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an app user's access to a system
      effect: destructive
      questions:
      - Can I revoke one person's access to a system but keep them on the team?
      - What's the way to unassign an app user from a system?
      instructions:
      - text: Unassign app user {teamAppUserId} from system {systemId}.
        slots:
          teamAppUserId: path.teamAppUserId
          systemId: path.systemId
      - text: Revoke {teamAppUserId}'s access to system {systemId}.
        slots:
          teamAppUserId: path.teamAppUserId
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/audit/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent audit jobs for a system
      effect: read
      questions:
      - What audit checks have been run on my system recently?
      - Can I see past audit jobs newest first?
      instructions:
      - text: List recent audit jobs for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show the audit job history on system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/audit/jobs/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an audit job's status
      effect: read
      questions:
      - Is my system audit still running or has it finished?
      - Can I poll the progress of an asynchronous audit job?
      instructions:
      - text: Check the status of audit job {jobId} on system {systemId}.
        slots:
          jobId: path.jobId
          systemId: path.systemId
      - text: Tell me whether audit job {jobId} for system {systemId} is done.
        slots:
          jobId: path.jobId
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/audit/jobs/{jobId}/result'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of a completed audit
      effect: read
      questions:
      - Where can I read the findings of a finished system audit?
      - What did the audit check report about my servers and accounts?
      instructions:
      - text: Get the results of audit job {jobId} on system {systemId}.
        slots:
          jobId: path.jobId
          systemId: path.systemId
      - text: Show the analyzed audit findings for job {jobId} in system {systemId}.
        slots:
          jobId: path.jobId
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/audit/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a system audit check
      effect: write
      questions:
      - Can I run an audit of my NATS servers and accounts against check profiles?
      - Does starting an audit return a job I can track?
      instructions:
      - text: Start an audit on system {systemId} using profiles {profiles} against servers {server_endpoints} and accounts {account_endpoints}.
        slots:
          systemId: path.systemId
          profiles: requestBody.profiles
          server_endpoints: requestBody.server_endpoints
          account_endpoints: requestBody.account_endpoints
      - text: Run a system audit check on {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/auth-callout'].get
  update:
    x-apievangelist-phrasing:
      intent: List a system's auth callout configs
      effect: read
      questions:
      - Which auth callout configurations exist for my system?
      - Has auth callout already been enabled on this system?
      instructions:
      - text: List the auth callout configs for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show auth callout setups on system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/auth-callout'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable auth callout on a system
      effect: write
      questions:
      - How do I turn on auth callout so an external service authenticates users?
      - Which control account should handle auth callout for my system?
      instructions:
      - text: Enable auth callout on system {systemId} using control account {control_account}.
        slots:
          systemId: path.systemId
          control_account: requestBody.control_account
      - text: Set {control_account} as the auth callout control account for system {systemId}.
        slots:
          control_account: requestBody.control_account
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/auth-callout/authenticators'].get
  update:
    x-apievangelist-phrasing:
      intent: List available auth callout authenticators
      effect: read
      questions:
      - What authenticators can I plug into auth callout?
      - Which authentication backends are available for a system's auth callout?
      instructions:
      - text: List the available authenticators for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show which auth callout authenticators system {systemId} can use.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/bulk/shares'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a stream or export with many accounts
      effect: write
      questions:
      - Can I share one stream with several accounts at once?
      - Is there a bulk way to share an export across accounts instead of one by one?
      instructions:
      - text: Share {type} {id} in system {systemId} with accounts {target_accounts}.
        slots:
          type: requestBody.type
          id: requestBody.id
          systemId: path.systemId
          target_accounts: requestBody.target_accounts
      - text: Bulk-share asset {id} of type {type} to accounts {target_accounts} on system {systemId}.
        slots:
          id: requestBody.id
          type: requestBody.type
          target_accounts: requestBody.target_accounts
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List client connections in a system
      effect: read
      questions:
      - Which clients are connected to my NATS system right now?
      - Can I filter connections by account, user, subject or state?
      - Is there a limit on how many connections are returned?
      instructions:
      - text: List connections on system {systemId} for account {account}.
        slots:
          systemId: path.systemId
          account: query.account
      - text: Show the {limit} connections on system {systemId} for user {user}, sorted by {sort}.
        slots:
          limit: query.limit
          systemId: path.systemId
          user: query.user
          sort: query.sort
      - text: Find connection {cid} in system {systemId}.
        slots:
          cid: query.cid
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a system's seeds
      effect: read
      questions:
      - Can I export the operator and account seeds for a system as a backup?
      - Where do I download a system's seed export?
      instructions:
      - text: Export the seeds for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Download system {systemId}'s seed backup.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/health/check'].get
  update:
    x-apievangelist-phrasing:
      intent: Check overall server health in a system
      effect: read
      questions:
      - Are all the servers in my system healthy?
      - Is there an equivalent of 'nats server report health' over the API?
      instructions:
      - text: Run a health check on system {systemId}.
        slots:
          systemId: path.systemId
      - text: Report the overall server health for system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/health/clusters'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cluster-level health overview
      effect: read
      questions:
      - What's the aggregated status of each cluster in my system?
      - Can I see cluster-level metrics rather than per-server stats?
      instructions:
      - text: Show the cluster health overview for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Summarize cluster status and metrics in system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/health/jetstream'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the JetStream health report
      effect: read
      questions:
      - How much JetStream storage and memory is in use across my servers?
      - Is there an API version of 'nats server report jetstream'?
      instructions:
      - text: Get the JetStream health report for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show JetStream usage per server in system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/health/servers'].get
  update:
    x-apievangelist-phrasing:
      intent: List servers with their health status
      effect: read
      questions:
      - Which NATS servers in my system are up, and what's their current status?
      - Can I get the 'nats server ls' view through the API?
      instructions:
      - text: List servers with health status for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show the server status list for system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/import-account'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an existing account
      effect: write
      questions:
      - Can I bring an existing NATS account into a system using its JWT and seed?
      - Is it possible to include signing keys when importing an account?
      instructions:
      - text: Import the account with JWT {jwt} and seed {seed} into system {systemId}.
        slots:
          jwt: requestBody.jwt
          seed: requestBody.seed
          systemId: path.systemId
      - text: Import an existing account into system {systemId} along with signing keys {signing_keys}.
        slots:
          systemId: path.systemId
          signing_keys: requestBody.signing_keys
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/import-user'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an existing NATS user
      effect: write
      questions:
      - Can I import a NATS user I created outside the platform?
      - Is a creds file enough to import a user, or do I need the JWT and seed?
      instructions:
      - text: Import a NATS user into system {systemId} from credential {credential}.
        slots:
          systemId: path.systemId
          credential: requestBody.credential
      - text: Import the user with JWT {jwt} and seed {seed} into system {systemId}.
        slots:
          jwt: requestBody.jwt
          seed: requestBody.seed
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/info/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List basic info for all accounts in a system
      effect: read
      questions:
      - If I only have access to one account, can I still see info about the others in the system?
      - Where do I get the names and IDs of every account in a system?
      instructions:
      - text: List account info for all accounts in system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show summary info for every account in system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/info/servers'].get
  update:
    x-apievangelist-phrasing:
      intent: List basic info for a system's servers
      effect: read
      questions:
      - What server info is visible for the NATS servers in my system?
      - Can I get a lightweight info list of servers in a system?
      instructions:
      - text: List server info for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show the info records for NATS servers in system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/jwt-sync'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-issue all account JWTs in a system
      effect: write
      questions:
      - Can I force every account JWT in a system to be re-issued?
      - How long does a system-wide JWT resync take to finish?
      instructions:
      - text: Re-sync all account JWTs in system {systemId}.
        slots:
          systemId: path.systemId
      - text: Mark every account JWT in system {systemId} for renewal.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/limits'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a system's total and allocated limits
      effect: read
      questions:
      - How much of my system's limits have I already allocated to accounts?
      - What are the total resource limits for a system?
      instructions:
      - text: Show the limits for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show how much capacity is unallocated in system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/nats-clusters'].get
  update:
    x-apievangelist-phrasing:
      intent: List NATS clusters in a system
      effect: read
      questions:
      - Which NATS clusters make up my system?
      - Can I list cluster information for one system?
      instructions:
      - text: List the NATS clusters in system {systemId}.
        slots:
          systemId: path.systemId
      - text: Show cluster information for system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/platform-components'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable or configure a platform component
      effect: write
      questions:
      - Can I enable or disable a platform component on my system?
      - Where do I change the config for a system's platform components?
      instructions:
      - text: Set platform component {type} on system {systemId} to enabled={enabled}.
        slots:
          type: requestBody.type
          systemId: path.systemId
          enabled: requestBody.enabled
      - text: Update the {type} component config on system {systemId} to {config}.
        slots:
          type: requestBody.type
          systemId: path.systemId
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/platform-components/{id}/tokens'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an access token for a platform component
      effect: read
      questions:
      - How does a platform component get the token it needs to connect?
      - Can I retrieve the access token for one of my system's components?
      instructions:
      - text: Get the access token for platform component {id} on system {systemId}.
        slots:
          id: path.id
          systemId: path.systemId
      - text: Retrieve component {id}'s token in system {systemId}.
        slots:
          id: path.id
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/prometheus-metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Prometheus metrics for a system
      effect: read
      questions:
      - Can I scrape my system's metrics in Prometheus format?
      - Where do I get Prometheus metrics for a NATS system?
      instructions:
      - text: Get the Prometheus metrics for system {systemId}.
        slots:
          systemId: path.systemId
      - text: Pull system {systemId}'s metrics in Prometheus exposition format.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/servers'].get
  update:
    x-apievangelist-phrasing:
      intent: List servers in a system
      effect: read
      questions:
      - What server information is recorded for each server in my system?
      - Can I list the raw server records for a system?
      instructions:
      - text: List the servers in system {systemId}.
        slots:
          systemId: path.systemId
      - text: Give me the server information records for system {systemId}.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/systems/{systemId}/unmanage'].delete
  update:
    x-apievangelist-phrasing:
      intent: Stop managing a system without purging NATS
      effect: destructive
      questions:
      - Can I remove a system from management but leave its accounts running in NATS?
      - What's the difference between unmanaging a system and deleting it?
      instructions:
      - text: Unmanage system {systemId} without purging its accounts.
        slots:
          systemId: path.systemId
      - text: Detach system {systemId} from the control plane but keep it in NATS.
        slots:
          systemId: path.systemId
      method: generated
      generated: '2026-10-01'