Synadia Communications · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/core/beta/account-sks/{keyId}'].get
$.paths['/core/beta/account-sks/{keyId}'].delete
$.paths['/core/beta/account-sks/{keyId}'].patch

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 API
  version: 1.0.0
extends: openapi/synadia-communications-sig-key-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: 3
- target: $.paths['/core/beta/account-sks/{keyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account signing key
      effect: read
      questions:
      - Can I view one account signing key by ID?
      - Is a given signing key disabled?
      instructions:
      - text: Show account signing key {keyId}.
        slots:
          keyId: path.keyId
      - text: Get signing key {keyId}.
        slots:
          keyId: path.keyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/account-sks/{keyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account signing key
      effect: destructive
      questions:
      - Can I delete an old account signing key?
      - What's the way to remove a signing key?
      instructions:
      - text: Delete account signing key {keyId}.
        slots:
          keyId: path.keyId
      - text: Remove signing key {keyId}.
        slots:
          keyId: path.keyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/account-sks/{keyId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Disable a signing key or set its seed
      effect: write
      questions:
      - Can I disable one signing key without deleting it?
      - Is it possible to supply the seed for a signing key?
      instructions:
      - text: Set signing key {keyId} to disabled={disabled}.
        slots:
          keyId: path.keyId
          disabled: requestBody.disabled
      - text: Store seed {seed} on signing key {keyId}.
        slots:
          seed: requestBody.seed
          keyId: path.keyId
      method: generated
      generated: '2026-10-01'