Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Sig Key Group API

8 actions 8 updates phrasing extends openapi/synadia-communications-sig-key-group-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 8

$.info
$.paths['/core/beta/account-sk-groups/{groupId}'].get
$.paths['/core/beta/account-sk-groups/{groupId}'].delete
$.paths['/core/beta/account-sk-groups/{groupId}'].patch
$.paths['/core/beta/account-sk-groups/{groupId}/account-sks'].get
$.paths['/core/beta/account-sk-groups/{groupId}/copy'].post
$.paths['/core/beta/account-sk-groups/{groupId}/nats-users'].get
$.paths['/core/beta/account-sk-groups/{groupId}/rotate-sk'].post

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 Sig Key Group API
  version: 1.0.0
extends: openapi/synadia-communications-sig-key-group-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: 7
- target: $.paths['/core/beta/account-sk-groups/{groupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account signing key group
      effect: read
      questions:
      - What scope and status does a signing key group have?
      - Can I view one account signing key group by ID?
      instructions:
      - text: Show signing key group {groupId}.
        slots:
          groupId: path.groupId
      - text: Get account signing key group {groupId}.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/account-sk-groups/{groupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a signing key group
      effect: destructive
      questions:
      - Can I delete an account signing key group?
      - What happens to users signed by a group when I delete it?
      instructions:
      - text: Delete signing key group {groupId}.
        slots:
          groupId: path.groupId
      - text: Remove account signing key group {groupId}.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/account-sk-groups/{groupId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or disable a signing key group
      effect: write
      questions:
      - Can I disable a signing key group temporarily?
      - Is it possible to change the permission scope of a signing key group?
      instructions:
      - text: Rename signing key group {groupId} to {name}.
        slots:
          groupId: path.groupId
          name: requestBody.name
      - text: Set the scope of signing key group {groupId} to {scope}.
        slots:
          groupId: path.groupId
          scope: requestBody.scope
      - text: Mark signing key group {groupId} as disabled={disabled}.
        slots:
          groupId: path.groupId
          disabled: requestBody.disabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/account-sk-groups/{groupId}/account-sks'].get
  update:
    x-apievangelist-phrasing:
      intent: List signing keys in a group
      effect: read
      questions:
      - Which signing keys belong to a signing key group?
      - Can I see the active and old keys in a group?
      instructions:
      - text: List the signing keys in group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show the account signing keys under group {groupId}.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/account-sk-groups/{groupId}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a signing key group with its users
      effect: write
      questions:
      - Can I clone a signing key group, including its users with fresh NKeys?
      - Does copying a group regenerate the users' keys?
      instructions:
      - text: Copy signing key group {groupId} into a new group named {name}.
        slots:
          groupId: path.groupId
          name: requestBody.name
      - text: Duplicate group {groupId} as {name} with new keys for its users.
        slots:
          groupId: path.groupId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/account-sk-groups/{groupId}/nats-users'].get
  update:
    x-apievangelist-phrasing:
      intent: List NATS users in a signing key group
      effect: read
      questions:
      - Which NATS users were issued under a signing key group?
      - Can I list users tied to one signing key group?
      instructions:
      - text: List NATS users in signing key group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show users signed by group {groupId}.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/account-sk-groups/{groupId}/rotate-sk'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a group's active signing key
      effect: write
      questions:
      - How do I rotate the active signing key for a group?
      - Can I replace a compromised signing key in a key group?
      instructions:
      - text: Rotate the active signing key in group {groupId}.
        slots:
          groupId: path.groupId
      - text: Generate a new active key for signing key group {groupId}.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'