asyncapi: '2.0.0'
info:
  title: Flightradar on Ably Hub
  version: '1.0.0'
  contact:
    name: Ably
    url: https://www.ably.io/contact
    email: support@ably.io
  description: |
    GTFS-R data on Flightradar's flight data

servers:
  ably:
    url: ws://realtime.ably.io
    description: Endpoint used by Ably's Realtime client libraries
    protocol: ws
    security:
      - apiKey: []
      - jwt: []
      - httpBearerToken: []
  mqtt:
    url: mqtt://mqtt.ably.io:{port}
    description: Ably's MQTT endpoint
    variables:
      port:
        description: Secure connection (TLS) is available through port 8883.
        default: '8883'
        enum:
          - '1883'
          - '8883'
    security:
      - mqttApiKey: []
      - mqttJwt: []
    protocol: mqtt
    protocolVersion: '3.1.1'
  rest:
    url: https://rest.ably.io
    description: Ably REST API
    protocol: https

defaultContentType: application/json

channels:
  '[product:ably-flightradar24/heathrow-flights]flights:plane:{planeId}':
    subscribe:
      summary: Aircraft details
      message:
        payload:
          type: object
          properties:
            aircraftId:
              type: integer
              description: The aircraft ID
            lat:
              type: number
              description: Latitude of the aircraft
            long:
              type: number
              description: Longitude of the aircraft
            track:
              type: integer
              description: Track value
            altitude:
              type: integer
              description: Altitude of the aircraft
            speed:
              type: integer
              description: Speed of the aircraft
            type:
              type: string
              description: Aircraft type
            reg:
              type: string
              description: Aircraft registration
            origin:
              type: string
              description: Where the aircraft is coming from
            destination:
              type: string
              description: Where the aircraft is going to
            iataId:
              type: string
              description: Aircraft's iata ID
            icaoId:
              type: string
              description: Aircraft's icao ID
            airline:
              type: string
              description: Aircraft's airline
    parameters:
      planeId:
        description: Id of the aircaft
        schema:
          type: string

  '[product:ably-flightradar24/heathrow-flights]flights:airport:LHR:arrivals':
    subscribe:
      summary: Arrivals at London Heathrow
      message:
        payload:
          type: array
          items:
            plane:
              type: object
              properties:
                origin:
                  type: string
                  description: Aircraft's origin
                destination:
                  type: string
                  description: Aircraft's destination
                iataId:
                  type: string
                  description: Aircraft's iata ID
  '[product:ably-flightradar24/heathrow-flights]flights:airport:LHR:departures':
    subscribe:
      summary: Departures at London Heathrow
      message:
        payload:
          type: array
          items:
            type: object
            properties:
              origin:
                type: string
                description: Aircraft's origin
              destination:
                type: string
                description: Aircraft's destination
              iataId:
                type: string
                description: Aircraft's iata ID

components:
  securitySchemes:
    mqttApiKey:
      type: apiKey
      in: user
      description: >-
        Provide your API key's public part as the user and the API key's secret
        part as the password. Only usable over a secure connection.
    apiKey:
      type: apiKey
      in: user
      description: Provide your API key
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT generated matching the [Ably JWT
        requirements](https://www.ably.io/documentation/core-features/authentication#ably-jwt)
    mqttJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT generated matching the [Ably JWT
        requirements](https://www.ably.io/documentation/core-features/authentication#ably-jwt).
        Use the token as your user, and keep the password blank
    httpBearerToken:
      type: http
      scheme: bearer