Synadia Communications · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Session API
14 actions
14 updates
phrasing
extends
openapi/synadia-communications-session-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.
What the actions change
x-apievangelist-phrasing
Targets 14
$.info
$.paths['/core/beta/alerts'].get
$.paths['/core/beta/app-users'].get
$.paths['/core/beta/app-users'].post
$.paths['/core/beta/invitations'].get
$.paths['/core/beta/invitations/{teamId}'].post
$.paths['/core/beta/personal-access-tokens'].get
$.paths['/core/beta/personal-access-tokens'].post
$.paths['/core/beta/service-accounts/app'].get
$.paths['/core/beta/service-accounts/app'].post
$.paths['/core/beta/teams'].get
$.paths['/core/beta/teams'].post
$.paths['/core/beta/terms/accept'].post
$.paths['/core/beta/version'].get
OpenAPI Overlay
# 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 Session API
version: 1.0.0
extends: openapi/synadia-communications-session-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: 13
- target: $.paths['/core/beta/alerts'].get
update:
x-apievangelist-phrasing:
intent: List alerts
effect: read
questions:
- What alerts have fired across my Synadia Control Plane?
- Can I filter alerts by status to see only open ones?
instructions:
- text: List all alerts.
- text: List alerts with status {status}.
slots:
status: query.status
method: generated
generated: '2026-10-01'
- target: $.paths['/core/beta/app-users'].get
update:
x-apievangelist-phrasing:
intent: List application users
effect: read
questions:
- Who are all the users of the Control Plane application?
- Where can I see every app user that has been invited?
instructions:
- text: List all app users.
- text: Show me everyone with an application login.
method: generated
generated: '2026-10-01'
- target: $.paths['/core/beta/app-users'].post
update:
x-apievangelist-phrasing:
intent: Invite a user to the application
effect: write
questions:
- How do I invite a new person to the Control Plane with a role?
- What do I need to provide to add an application user?
instructions:
- text: Invite {name} with identifier {identifier} as role {role}.
slots:
name: requestBody.name
identifier: requestBody.identifier
role: requestBody.role_id
- text: Create an app user {name} ({identifier}) with role {role}.
slots:
name: requestBody.name
identifier: requestBody.identifier
role: requestBody.role_id
method: generated
generated: '2026-10-01'
- target: $.paths['/core/beta/invitations'].get
update:
x-apievangelist-phrasing:
intent: List my pending team invitations
effect: read
questions:
- Which team invitations are waiting for me to answer?
- Do I have any pending invites to join a team?
instructions:
- text: List my pending invitations.
- text: Show the team invites I haven't answered.
method: generated
generated: '2026-10-01'
- target: $.paths['/core/beta/invitations/{teamId}'].post
update:
x-apievangelist-phrasing:
intent: Accept or decline a team invitation
effect: write
questions:
- How do I accept an invitation to join a team?
- Can I reject a team invite I don't want?
instructions:
- text: Accept the invitation to team {team} by setting accept to {accept}.
slots:
team: path.teamId
accept: requestBody.accept
- text: Respond to the invite from team {team} with accept={accept}.
slots:
team: path.teamId
accept: requestBody.accept
method: generated
generated: '2026-10-01'
- target: $.paths['/core/beta/personal-access-tokens'].get
update:
x-apievangelist-phrasing:
intent: List my personal access tokens
effect: read
questions:
- Which personal access tokens have I created?
- Where can I review all my personal API tokens?
instructions:
- text: List my personal access tokens.
- text: Show all the personal access tokens on my user.
method: generated
generated: '2026-10-01'
- target: $.paths['/core/beta/personal-access-tokens'].post
update:
x-apievangelist-phrasing:
intent: Create a personal access token
effect: write
questions:
- How do I create a personal access token to call the Control Plane API?
- Can I make a personal access token that never expires?
instructions:
- text: Create a personal access token named {name}.
slots:
name: requestBody.name
- text: Create personal access token {name} expiring on {expires}.
slots:
name: requestBody.name
expires: requestBody.expires
- text: Create personal access token {name} with never-expires set to {never_expires}.
slots:
name: requestBody.name
never_expires: requestBody.never_expires
method: generated
generated: '2026-10-01'
- target: $.paths['/core/beta/service-accounts/app'].get
update:
x-apievangelist-phrasing:
intent: List app service accounts
effect: read
questions:
- Which service accounts exist for automation against the application?
- Where do I see all app service accounts?
instructions:
- text: List all app service accounts.
- text: Show me every service account in the app.
method: generated
generated: '2026-10-01'
- target: $.paths['/core/beta/service-accounts/app'].post
update:
x-apievangelist-phrasing:
intent: Create an app service account
effect: write
questions:
- How do I create a service account for CI to use the Control Plane?
- Can I limit a service account to specific resources with a role?
instructions:
- text: Create app service account {name} with role {role} on resources {resources}.
slots:
name: requestBody.name
role: requestBody.role_id
resources: requestBody.resources
- text: Make a service account {name} scoped to {resources} as {role}.
slots:
name: requestBody.name
role: requestBody.role_id
resources: requestBody.resources
method: generated
generated: '2026-10-01'
- target: $.paths['/core/beta/teams'].get
update:
x-apievangelist-phrasing:
intent: List teams
effect: read
questions:
- Which teams exist in the Control Plane?
- Can I list only the teams I'm assigned to?
instructions:
- text: List all teams.
- text: List teams filtered by assigned={assigned}.
slots:
assigned: query.assigned
method: generated
generated: '2026-10-01'
- target: $.paths['/core/beta/teams'].post
update:
x-apievangelist-phrasing:
intent: Create a team
effect: write
questions:
- How do I create a new team in Synadia Control Plane?
- What's needed to start a team for my group?
instructions:
- text: Create a team named {name}.
slots:
name: requestBody.name
- text: Start a new team called {name}.
slots:
name: requestBody.name
method: generated
generated: '2026-10-01'
- target: $.paths['/core/beta/terms/accept'].post
update:
x-apievangelist-phrasing:
intent: Accept the terms of service
effect: write
questions:
- How do I accept the terms so I can keep using the application?
- Where do I agree to the platform terms?
instructions:
- text: Accept the terms of service for me.
- text: Record my acceptance of the terms.
method: generated
generated: '2026-10-01'
- target: $.paths['/core/beta/version'].get
update:
x-apievangelist-phrasing:
intent: Get the Control Plane version
effect: read
questions:
- Which version of Synadia Control Plane am I running?
- Can I check the server version via the API?
instructions:
- text: Show the Control Plane version.
- text: Tell me what version the control plane reports.
method: generated
generated: '2026-10-01'