Synadia Communications · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/synadia-communications-alert-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/alerts/{alertId}'].get
$.paths['/core/beta/alerts/{alertId}/acknowledge'].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 Alert API
  version: 1.0.0
extends: openapi/synadia-communications-alert-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/alerts/{alertId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an alert
      effect: read
      questions:
      - How do I see the details of one fired alert?
      - What triggered a specific alert?
      instructions:
      - text: Show alert {alert}.
        slots:
          alert: path.alertId
      - text: Get details of alert {alert}.
        slots:
          alert: path.alertId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/alerts/{alertId}/acknowledge'].patch
  update:
    x-apievangelist-phrasing:
      intent: Acknowledge an alert
      effect: write
      questions:
      - How do I acknowledge an alert so the team knows it's being handled?
      - Can I mark an alert as seen through the API?
      instructions:
      - text: Acknowledge alert {alert}.
        slots:
          alert: path.alertId
      - text: Mark alert {alert} as acknowledged.
        slots:
          alert: path.alertId
      method: generated
      generated: '2026-10-01'