API Evangelist enhancements for the Omni Status API

overlay: 1.0.0
info:
  title: API Evangelist enhancements for the Omni Status API
  version: 1.0.0
extends: openapi/optus-status-api-openapi.yml
x-apievangelist:
  generated: '2026-10-21'
  method: generated
  source: openapi/optus-status-api-openapi.yml + overlays carried forward from the 2026-07-25 overlays
    on openapi/_original/ (status)
  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-white-label-operator: Modica Group
    x-apievangelist-note: Title, contact and server in the original document all name Modica Group. The
      API is nonetheless live and callable on the Optus host.
- target: $.paths['/status'].get
  update:
    summary: Get near real-time availability for one or more services
    x-apievangelist-note: Provider spec declares no operationId; this id is an API Evangelist convention.
    x-action-class: connected
    x-consequence: read
    x-authentication: none - deliberately unauthenticated
    x-polling-guidance: Status is refreshed once per minute from an external, geographically distributed
      provider independent of the platform's own infrastructure. Do not poll faster than the 60-second
      cache interval.
    x-empty-response-note: Calling /status without any `service` query parameter returns {"services":{}}
      - the caller must name the services it wants.
- target: $.info
  update:
    x-related-status-surface:
      status_page: https://status.sms.optus.com.au/
      statuspage_api: https://status.sms.optus.com.au/api/v2/summary.json
      components_tracked: 17
      artifact: lifecycle/optus-lifecycle.yml