Twilio · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Twilio - Events Schemas API

4 actions 4 updates phrasing extends openapi/twilio-schemas-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Twilio's API. It is a proposal applied on top of the contract, not a document Twilio publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v1/Schemas/{Id}'].get

$.paths['/v1/Schemas/{Id}/Versions'].get

$.paths['/v1/Schemas/{Id}/Versions/{SchemaVersion}'].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 Twilio - Events Schemas API
  version: 1.0.0
extends: openapi/twilio-schemas-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v1/Schemas/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event schema and its versions
      effect: read
      questions:
      - What does the payload of a given event type look like, and which versions exist?
      - Can I fetch an event schema by its ID?
      instructions:
      - text: Get schema {schema} with its versions.
        slots:
          schema: path.Id
      - text: Show the event schema {schema}.
        slots:
          schema: path.Id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Schemas/{Id}/Versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the versions of an event schema
      effect: read
      questions:
      - How many versions of an event schema have been published?
      - Which schema versions are available for one event type?
      instructions:
      - text: List the versions of schema {schema}.
        slots:
          schema: path.Id
      - text: Page through versions of schema {schema}, {page_size} at a time.
        slots:
          schema: path.Id
          page_size: query.PageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Schemas/{Id}/Versions/{SchemaVersion}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one specific version of an event schema
      effect: read
      questions:
      - Can I pull the exact definition of an older version of an event schema?
      - What did one particular schema version contain?
      instructions:
      - text: Get version {version} of schema {schema}.
        slots:
          version: path.SchemaVersion
          schema: path.Id
      - text: Show the definition of schema {schema} at version {version}.
        slots:
          schema: path.Id
          version: path.SchemaVersion
      method: generated
      generated: '2026-09-26'