example-documentation.yaml

asyncapi: 3.0.0
info:
  title: Example APP
  version: 2.2.0
  contact:
    name: Anna Bocharova
    url: https://robintail.cz
    email: me@robintail.cz
  license:
    name: MIT
  description: AsyncAPI documentation example
id: urn:example:com:socket.io
defaultContentType: text/plain
servers:
  example:
    host: example.com
    pathname: /socket.io
    protocol: https
channels:
  Root:
    address: /
    title: Namespace /
    bindings:
      ws:
        bindingVersion: 0.1.0
        method: GET
        headers:
          type: object
          properties:
            connection:
              type: string
              const: Upgrade
            upgrade:
              type: string
              const: websocket
        query:
          type: object
          properties:
            EIO:
              type: string
              const: "4"
              description: The version of the protocol
            transport:
              type: string
              enum:
                - polling
                - websocket
              description: The name of the transport
            sid:
              type: string
              description: The session identifier
          required:
            - EIO
            - transport
          externalDocs:
            description: Engine.IO Protocol
            url: https://socket.io/docs/v4/engine-io-protocol/
    messages:
      rootOutgoingTime:
        name: time
        title: time
        payload:
          type: array
          items:
            - type: string
              description: current ISO time
              examples:
                - 2024-03-28T21:13:15.084Z
          additionalItems: false
        examples:
          - payload:
              - 2024-03-28T21:13:15.084Z
      rootOutgoingChat:
        name: chat
        title: chat
        payload:
          type: array
          items:
            - type: string
              description: message
              examples:
                - Hello there!
            - type: object
              properties:
                from:
                  type: string
                  description: the ID of author
              required:
                - from
              description: extra info
              examples:
                - &a1
                  from: 123abc
          additionalItems: false
        examples:
          - payload:
              - Hello there!
              - *a1
      rootOutgoingRooms:
        name: rooms
        title: rooms
        payload:
          type: array
          items:
            - type: array
              items:
                type: string
              description: room IDs
              examples:
                - &a2
                  - room1
                  - room2
                - &a3
                  - room3
                  - room4
                  - room5
          additionalItems: false
        examples:
          - payload:
              - *a2
          - payload:
              - *a3
      rootOutgoingError:
        name: error
        title: error
        payload:
          type: array
          items:
            - type: string
              description: name
              examples:
                - InputValidationError
            - type: string
              description: message
              examples:
                - "1: Required"
          additionalItems: false
        examples:
          - payload:
              - InputValidationError
              - "1: Required"
      rootIncomingChat:
        name: chat
        title: chat
        payload:
          type: array
          items:
            - type: string
              description: message
              examples:
                - Hello there
          additionalItems: false
        examples:
          - payload:
              - Hello there
      rootIncomingPing:
        name: ping
        title: ping
        payload:
          type: array
          additionalItems:
            format: any
            description: Anything
        examples:
          - payload:
              - something
      rootAckForIncomingPing:
        title: Acknowledgement for ping
        payload:
          type: array
          items:
            - type: string
              const: pong
              description: literally
              examples:
                - pong
          additionalItems:
            format: any
            description: echo
        examples:
          - payload:
              - pong
              - something
      rootIncomingSubscribe:
        name: subscribe
        title: subscribe
        payload:
          type: array
          additionalItems:
            format: any
            description: Does not matter
      rootIncomingUnsubscribe:
        name: unsubscribe
        title: unsubscribe
        payload:
          type: array
          additionalItems:
            format: any
            description: Does not matter
components: {}
operations:
  RootSendOperationTime:
    action: send
    channel:
      $ref: "#/channels/Root"
    messages:
      - $ref: "#/channels/Root/messages/rootOutgoingTime"
    title: time
    summary: Outgoing event time
    description: The message produced by the application within the / namespace
  RootSendOperationChat:
    action: send
    channel:
      $ref: "#/channels/Root"
    messages:
      - $ref: "#/channels/Root/messages/rootOutgoingChat"
    title: chat
    summary: Outgoing event chat
    description: The message produced by the application within the / namespace
  RootSendOperationRooms:
    action: send
    channel:
      $ref: "#/channels/Root"
    messages:
      - $ref: "#/channels/Root/messages/rootOutgoingRooms"
    title: rooms
    summary: Outgoing event rooms
    description: The message produced by the application within the / namespace
  RootSendOperationError:
    action: send
    channel:
      $ref: "#/channels/Root"
    messages:
      - $ref: "#/channels/Root/messages/rootOutgoingError"
    title: error
    summary: Outgoing event error
    description: The message produced by the application within the / namespace
  RootRecvOperationChat:
    action: receive
    channel:
      $ref: "#/channels/Root"
    messages:
      - $ref: "#/channels/Root/messages/rootIncomingChat"
    title: chat
    summary: Incoming event chat
    description: The message consumed by the application within the / namespace
  RootRecvOperationPing:
    action: receive
    channel:
      $ref: "#/channels/Root"
    messages:
      - $ref: "#/channels/Root/messages/rootIncomingPing"
    title: ping
    summary: Incoming event ping
    description: The message consumed by the application within the / namespace
    reply:
      address:
        location: $message.payload#
        description: "Last argument: acknowledgement handler"
      channel:
        $ref: "#/channels/Root"
      messages:
        - $ref: "#/channels/Root/messages/rootAckForIncomingPing"
  RootRecvOperationSubscribe:
    action: receive
    channel:
      $ref: "#/channels/Root"
    messages:
      - $ref: "#/channels/Root/messages/rootIncomingSubscribe"
    title: subscribe
    summary: Incoming event subscribe
    description: The message consumed by the application within the / namespace
  RootRecvOperationUnsubscribe:
    action: receive
    channel:
      $ref: "#/channels/Root"
    messages:
      - $ref: "#/channels/Root/messages/rootIncomingUnsubscribe"
    title: unsubscribe
    summary: Incoming event unsubscribe
    description: The message consumed by the application within the / namespace