Synadia Communications · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/synadia-communications-authz-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/authz/check'].post
$.paths['/core/beta/authz/policies'].get
$.paths['/core/beta/authz/roles'].get

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 Authz API
  version: 1.0.0
extends: openapi/synadia-communications-authz-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/authz/check'].post
  update:
    x-apievangelist-phrasing:
      intent: Check my authorization for a resource
      effect: read
      questions:
      - Which policies apply to my session for a given service or resource?
      - Can I check whether I'm allowed to act on a resource before trying?
      instructions:
      - text: Check my authorization decisions for the current session.
      - text: Show which policies apply to me for this resource.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/authz/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List authorization policies
      effect: read
      questions:
      - What app policies are configured?
      - Can I see all the authorization policies in the platform?
      instructions:
      - text: List the configured app policies.
      - text: Show all authorization policies.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/beta/authz/roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List available roles
      effect: read
      questions:
      - Which roles can I assign to users and service accounts?
      - What app roles are defined?
      instructions:
      - text: List the available app roles.
      - text: Show me every role I can assign.
      method: generated
      generated: '2026-10-01'