Sonetel · OpenAPI Overlay 1.0.0

API Evangelist overlay for Sonetel Supporting Data API

6 actions 6 updates documentation extends ../openapi/_original/sonetel-supporting-data-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

tagsx-api-evangelistsecuritySchemes

Targets 6

$.info

$.paths['/globaldata/timezone'].get

$.paths['/globaldata/voiceprompts'].get

$.paths['/globaldata/language'].get

$.components

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist overlay for Sonetel Supporting Data API
  version: 1.0.0
extends: ../openapi/_original/sonetel-supporting-data-openapi.yml
x-generated: '2026-10-09'
x-method: generated
x-source: openapi/sonetel-supporting-data-openapi.yml
actions:
- target: $.info
  description: Record API Evangelist provenance.
  update:
    x-api-evangelist:
      provider: sonetel
      generated: '2026-10-09'
      source: openapi/sonetel-supporting-data-openapi.yml
      upstream: https://github.com/Sonetel/sonetel-api-docs
      documentation: https://docs.sonetel.com/
- target: $
  description: The upstream document declares no tags; add one tag naming this API so operations group
    in renderers.
  update:
    tags:
    - name: Sonetel Supporting Data
      description: Use these APIs to get supporting data such as the available timezones, default language
        for voice messages, etc for use in other APIs.
- target: $.paths['/globaldata/timezone'].get
  description: Tag get-globaldata-timezone.
  update:
    tags:
    - Sonetel Supporting Data
- target: $.paths['/globaldata/voiceprompts'].get
  description: Tag get-globaldata-voiceprompts.
  update:
    tags:
    - Sonetel Supporting Data
- target: $.paths['/globaldata/language'].get
  description: Tag get-globaldata-language.
  update:
    tags:
    - Sonetel Supporting Data
- target: $.components
  description: Upstream declares no securitySchemes although the Sonetel docs (docs/Getting Started/1-Introduction.md)
    require an access token from the Authentication API. Add the same oauth2 password-flow scheme the
    sibling Sonetel specs (e.g. Account) declare. Operation-level `security` values are left untouched.
  update:
    securitySchemes:
      SonetelToken:
        type: oauth2
        description: 'Sonetel access token (JWT) obtained from POST /oauth/token (create-JWT-token) on
          https://api.sonetel.com/SonetelAuth/beta/; sent as `Authorization: Bearer <token>`.'
        flows:
          password:
            tokenUrl: https://api.sonetel.com/SonetelAuth/beta/oauth/token
            refreshUrl: https://api.sonetel.com/SonetelAuth/beta/oauth/token
            scopes: {}