openapi: 3.0.3
info:
  title: TM Next-Gen - Beacon (APIGEE)
  description: |
    OpenAPI APIGEE mirror of `next-gen-swagger/beacon/next-gen-beacon-api.yaml` — the real-time
    notification stream. Paths resolve from that file via `$ref`.

    **APIGEE-only:** send `api_key` (API key) in addition to `X-reflexis-csrf-token-X` (session token).

    Companion specs: `mywork/next-gen-mywork-apigee-api.yaml` (application config, broadcasts,
    notes, recent tabs), `task-execution/next-gen-task-execution-apigee-api.yaml` (remaining task
    execution routes), `walk-execution/next-gen-walk-execution-apigee-api.yaml` (walk execution).
  version: 1.0.0
  contact:
    name: API Support
    email: noreply@zebra.com

servers:
  - url: https://dev-api.zebra.com
    description: Dev APIGEE
  - url: https://stage-api.zebra.com
    description: Stage APIGEE
  - url: https://test-api.zebra.com
    description: Test APIGEE
  - url: https://api.zebra.com
    description: Prod APIGEE

tags:
  - name: BeaconNotifications
    description: Real-time SSE notification stream proxied from the external Beacon microservice

security:
  - ApiKeyHeader: []
    AuthTokenHeader: []

components:
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: api_key
      description: APIGEE API key header validated by VerifyAPIKey policy.
    AuthTokenHeader:
      $ref: ./next-gen-beacon-api.yaml#/components/securitySchemes/AuthTokenHeader
  schemas:
    JsonObject:
      $ref: ./next-gen-beacon-api.yaml#/components/schemas/JsonObject
    JsonResponse:
      $ref: ./next-gen-beacon-api.yaml#/components/schemas/JsonResponse
    ErrorResponse:
      $ref: ./next-gen-beacon-api.yaml#/components/schemas/ErrorResponse
    SseMessage:
      $ref: ./next-gen-beacon-api.yaml#/components/schemas/SseMessage

paths:
  /beacon/v1/notifications:
    $ref: ./next-gen-beacon-api.yaml#/paths/~1beacon~1v1~1notifications
