Synadia Communications · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Synadia Control Plane / Synadia Cloud Subject Import API

4 actions 4 updates phrasing extends openapi/synadia-communications-subject-import-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/subject-imports/{subjectImportId}'].get
$.paths['/core/beta/subject-imports/{subjectImportId}'].delete
$.paths['/core/beta/subject-imports/{subjectImportId}'].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 Subject Import API
  version: 1.0.0
extends: openapi/synadia-communications-subject-import-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/subject-imports/{subjectImportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a subject import
      effect: read
      questions:
      - How do I view the settings of one subject import?
      - What JWT settings does a given subject import use?
      instructions:
      - text: Show subject import {import}.
        slots:
          import: path.subjectImportId
      - text: Get details for subject import {import}.
        slots:
          import: path.subjectImportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/subject-imports/{subjectImportId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subject import
      effect: destructive
      questions:
      - Can I remove a subject import from my account?
      - How do I stop importing a subject?
      instructions:
      - text: Delete subject import {import}.
        slots:
          import: path.subjectImportId
      - text: Remove subject import {import}.
        slots:
          import: path.subjectImportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/subject-imports/{subjectImportId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a subject import
      effect: write
      questions:
      - How do I change the JWT settings of an existing subject import?
      - Can I edit a subject import after it's created?
      instructions:
      - text: Update subject import {import} with JWT settings {jwt_settings}.
        slots:
          import: path.subjectImportId
          jwt_settings: requestBody.jwt_settings
      - text: Change subject import {import}'s settings to {jwt_settings}.
        slots:
          import: path.subjectImportId
          jwt_settings: requestBody.jwt_settings
      method: generated
      generated: '2026-10-01'