asyncapi: "1.0.0"
info:
  title: AsyncAPI Sample
  version: "1.0.0"
  x-logo: https://avatars0.githubusercontent.com/u/16401334?v=4&s=200
  description: |
    This is a simple example of an _AsyncAPI_ document.
  termsOfService: https://api.company.com/terms
baseTopic: 'hitch'

servers:
  - url: api.company.com:{port}/{app-id}
    description: Allows you to connect using the MQTT protocol.
    scheme: mqtt
    variables:
      app-id:
        default: demo
        description: You can find your `app-id` in our control panel, under the auth tab.
      port:
        enum:
          - '5676'
          - '5677'
        default: '5676'

externalDocs:
  description: See OpenAPI example
  url: https://mermade.github.io/shins/index.html

topics:
  accounts.1.0.action.user.signup:
    publish:
      $ref: "#/components/messages/userSignUp"
  accounts.1.0.event.user.signup:
    subscribe:
      $ref: "#/components/messages/userSignedUp"

components:
  messages:
    userSignUp:
      deprecated: true
      summary: Action to sign a user up.
      description: |
        Multiline description of what this action does. **It allows Markdown.**
      tags:
        - name: user
        - name: signup
      headers:
        type: object
        properties:
          qos:
            $ref: "#/components/schemas/MQTTQoSHeader"
          retainFlag:
            $ref: "#/components/schemas/MQTTRetainHeader"
      payload:
        type: object
        properties:
          user:
            $ref: "#/components/schemas/userCreate"
          signup:
            $ref: "#/components/schemas/signup"

    userSignedUp:
      payload:
        type: object
        properties:
          user:
            $ref: "#/components/schemas/user"
          signup:
            $ref: "#/components/schemas/signup"
  schemas:
    id:
      title: id
      description: Resource identifier
      type: string
    username:
      title: username
      description: User handle
      type: string
    datetime:
      title: datetime
      description: Date and Time of the message
      type: string
      format: date-time
    MQTTQoSHeader:
      title: qos
      description: Quality of Service
      type: integer
      format: int32
      default: 1
      enum:
        - 0
        - 2
    MQTTRetainHeader:
      title: retainFlag
      description: |
        This flag determines if the message will be saved by the broker for the specified
        topic as last known good value. New clients that subscribe to that topic will receive
        the last retained message on that topic instantly after subscribing. More on retained messages
        and best practices in one of the next posts.
      type: boolean
      default: false
    user:
      type: object
      required:
        - id
        - username
      properties:
        id:
          description: User Id
          $ref: "#/components/schemas/id"
        full_name:
          description: User full name
          type: string
        username:
          $ref: "#/components/schemas/username"
    userCreate:
      type: object
      required:
        - username
      properties:
        full_name:
          description: User full name
          type: string
        username:
          $ref: "#/components/schemas/username"
    signup:
      type: object
      required:
        - method
        - datetime
      properties:
        method:
          description: Signup method
          type: string
          enum:
            - email
            - facebook
            - twitter
            - github
            - google
        datetime:
          $ref: "#/components/schemas/datetime"