application-headers-asyncapi.yml

asyncapi: 3.1.0
info:
  title: Application Headers example
  version: 1.0.0
  description: A cut of the Streetlights API to test application header changes supporting
  license:
    name: Apache 2.0
    url: 'https://www.apache.org/licenses/LICENSE-2.0'
defaultContentType: application/json
servers:
  production:
    host: 'test.mosquitto.org:{port}'
    protocol: mqtt
    description: Test broker
    variables:
      port:
        description: Secure connection (TLS) is available through port 8883.
        default: '1883'
        enum:
          - '1883'
          - '8883'
channels:
  lightingMeasured:
    address: 'smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured'
    messages:
      lightMeasured:
        $ref: '#/components/messages/lightMeasured'
    parameters:
      streetlightId:
        $ref: '#/components/parameters/streetlightId'
operations:
  receiveLightMeasurement:
    action: receive
    channel:
      $ref: '#/channels/lightingMeasured'
    summary: >-
      Inform about environmental lighting conditions of a particular
      streetlight.
    messages:
      - $ref: '#/channels/lightingMeasured/messages/lightMeasured'
components:
  messages:
    lightMeasured:
      name: lightMeasured
      title: Light measured
      summary: >-
        Inform about environmental lighting conditions of a particular
        streetlight.
      correlationId:
        location: $message.header#/MQMD/CorrelId
      contentType: application/json
      headers:
        type: object
        properties:
          MQMD:
            type: object
            properties:
              CorrelId:
                type: string
                minLength: 24
                maxLength: 24
                format: binary
          applicationInstanceId:
            $ref: '#/components/schemas/applicationInstanceId'
      payload:
        $ref: '#/components/schemas/lightMeasuredPayload'
  schemas:
    lightMeasuredPayload:
      type: object
      properties:
        lumens:
          type: integer
          minimum: 0
          description: Light intensity measured in lumens.
        sentAt:
          $ref: '#/components/schemas/sentAt'
    sentAt:
      type: string
      format: date-time
      description: Date and time when the message was sent.
    applicationInstanceId:
      description: Unique identifier for a given instance of the publishing application
      type: string
  parameters:
    streetlightId:
      description: The ID of the streetlight.