Synadia Communications · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/synadia-communications-license-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/license'].get
$.paths['/core/beta/license'].put
$.paths['/core/beta/license'].delete

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 License API
  version: 1.0.0
extends: openapi/synadia-communications-license-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/license'].get
  update:
    x-apievangelist-phrasing:
      intent: Check license status and entitlements
      effect: read
      questions:
      - Is my Synadia Control Plane license valid, and what does it entitle me to?
      - Where can I see license entitlements?
      instructions:
      - text: Show the current license status.
      - text: List my license entitlements.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/license'].put
  update:
    x-apievangelist-phrasing:
      intent: Install a new license key
      effect: write
      questions:
      - How do I apply a new license key to the Control Plane?
      - Can I replace an expiring license with a renewed one?
      instructions:
      - text: Install license key {license_key}.
        slots:
          license_key: requestBody.license_key
      - text: Replace the current license with {license_key}.
        slots:
          license_key: requestBody.license_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/license'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the stored license
      effect: destructive
      questions:
      - Can I remove the license stored on this installation?
      - How do I clear the license from the Control Plane?
      instructions:
      - text: Delete the stored license.
      - text: Remove the license from this installation.
      method: generated
      generated: '2026-10-01'