asyncapi.yaml

asyncapi: '2.6.0'
info:
  title: Streetlights MQTT API
  version: '1.0.0'

servers:
  production:
    url: test.mosquitto.org:1883
    protocol: mqtt
    description: Test broker

defaultContentType: application/json

channels:
  smartylighting/streetlights/1/0/action/{streetlightId}/turn/on:
    parameters:
      streetlightId:
        $ref: '#/components/parameters/streetlightId'
    subscribe:
      operationId: sendTurnOnOff
      message:
        $ref: '#/components/messages/turnOnOff'
    publish:
      operationId: recieveTurnOnOff
      message:
        $ref: '#/components/messages/turnOnOff'

components:
  messages:
    turnOnOff:
      name: turnOnOff
      title: Turn on/off
      summary: Command a particular streetlight to turn the lights on or off.
      payload:
        $ref: "#/components/schemas/turnOnOffPayload"

  schemas:
    turnOnOffPayload:
      type: object
      properties:
        command:
          type: string
          enum:
            - on
            - off
          description: Whether to turn on or off the light.
        sentAt:
          $ref: "#/components/schemas/sentAt"
    sentAt:
      type: string
      format: date-time
      description: Date and time when the message was sent.

  parameters:
    streetlightId:
      description: The ID of the streetlight.
      schema:
        type: string