Synadia Communications · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/synadia-communications-admin-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 3

$.info
$.paths['/core/beta/admin/app-user'].get
$.paths['/core/beta/admin/app-user'].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 Admin API
  version: 1.0.0
extends: openapi/synadia-communications-admin-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: 2
- target: $.paths['/core/beta/admin/app-user'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether an admin user exists
      effect: read
      questions:
      - Has an App Admin user been created on this install yet?
      - How can I tell if a fresh install still needs an admin?
      instructions:
      - text: Check whether an App Admin user exists.
      - text: Tell me if this installation has an admin user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/admin/app-user'].post
  update:
    x-apievangelist-phrasing:
      intent: Create the initial admin user
      effect: write
      questions:
      - How do I create the first admin user on a clean install programmatically?
      - Can I generate an API token at the same time I create the admin?
      instructions:
      - text: Create the App Admin user {username} with password {password}.
        slots:
          username: requestBody.username
          password: requestBody.password
      - text: Create admin {username} with password {password} and generate_token={generate}.
        slots:
          username: requestBody.username
          password: requestBody.password
          generate: requestBody.generate_token
      method: generated
      generated: '2026-10-01'