API Evangelist enhancements for the SMS Gateway REST APIv2 Documentation API

overlay: 1.0.0
info:
  title: API Evangelist enhancements for the SMS Gateway REST APIv2 Documentation API
  version: 1.0.0
extends: openapi/optus-documentation-api-openapi.yml
x-apievangelist:
  generated: '2026-10-21'
  method: generated
  source: openapi/optus-documentation-api-openapi.yml + overlays carried forward from the 2026-07-25 overlays
    on openapi/_original/ (rest-v2)
  note: Additive only; never mutates the extended document. Actions whose targets no longer exist in the
    split document were dropped, Swagger 2.0 $.definitions targets were rebased to $.components.schemas,
    and operationId updates were removed because the split document already declares its own operationIds.
actions:
- target: $.info
  update:
    x-apievangelist-provider: optus
    x-apievangelist-repo: https://github.com/api-evangelist/optus
    x-apievangelist-recommended: true
    x-white-label-operator: Modica Group
    contact:
      name: The Optus SMS Suite API Support
      url: https://sms.optus.com.au/docs/en/integrations/api-documentation/rest-v2/
      email: optussd@modicagroup.com
    x-artifacts:
      authentication: authentication/optus-authentication.yml
      conventions: conventions/optus-conventions.yml
      errors: errors/optus-error-codes.yml
      lifecycle: lifecycle/optus-lifecycle.yml
      asyncapi: asyncapi/optus-sms-suite-asyncapi.yml
      data_model: data-model/optus-data-model.yml
- target: $.info
  update:
    x-conventions:
      idempotency: none documented - retrying a submit sends another message
      pagination: none
      request_id_header: none
      rate_limits: none published
      timestamps: RFC 3339, not in the past, maximum 60 days ahead
      msisdn_format: E.164 with leading plus
      network_controls: optional per-application IP allowlisting; TLS 1.2 minimum
- target: $.paths['/openapi.yaml'].get
  update:
    x-apievangelist-note: Documented as a live operation but returns HTTP 404 {"message":"Not Found"}
      anonymously - the self-describing copy is credential-gated. The public copy is the docs-hosted file
      at https://sms.optus.com.au/docs/api/mobile-gateway-rest-v2.yaml.
    x-probe:
      url: https://api.sms.optus.com.au/rest/sms/v2/openapi.yaml
      status: 404
      probed: '2026-07-25'
- target: $.components.securitySchemes.GatewayAuthorizer
  update:
    x-actual-scheme: http-basic
    x-apievangelist-note: Modelled as an apiKey in the Authorization header, but the value is a standard
      HTTP Basic credential (base64 of application-name:password). Credentials are issued per application
      at https://sms.optus.com.au/gateway/api_config/restv2.