asyncapi-example.yml

asyncapi: "2.6.0"

id: "https://github.com/nickshoe/asyncapi-php-template/"

info:
  title: Example App
  version: "0.1.0"
  description: |
    An example app to demonstrate the usage of asyncapi-php-template AsyncAPI generator template.
  contact:
    name: Nicolò Scarpa
    url: https://github.com/nickshoe
    email: nicolo.scarpa@gmail.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html

servers:
  rabbitmq-development:
    url: localhost:5672
    protocol: amqp
    protocolVersion: '0.9.1'
    security:
      - user-password: []
  kafka-development:
    url: localhost:9092
    protocol: kafka
    protocolVersion: '1.0.0'

defaultContentType: application/json

channels:
  events:
    description: This is the main channel where all application events are published.
    publish:
      summary: Publish a Domain Event on the channel.
      operationId: publishDomainEvent
      message:
        messageId: PublishDomainEventMessage
        name: PublishDomainEventMessage
        payload:
          $ref: "#/components/schemas/DomainEvent"
    subscribe:
      summary: Subscribe to Domain Events published on the channel.
      operationId: onDomainEvent
      message:
        messageId: OnDomainEventMessage
        name: OnDomainEventMessage
        payload:
          $ref: "#/components/schemas/DomainEvent"
  users/{userId}/notifications:
    description: The channel on which notifications for a specific user are published.
    parameters:
      userId:
        description: The id of the user.
        schema:
          type: string
          examples:
            - '123'
    subscribe:
      operationId: onUserNotification
      message:
        payload:
          $ref: "#/components/schemas/Notification"

components:
  securitySchemes:
    user-password:
      type: userPassword
  schemas:
    DomainEvent:
      type: object
      discriminator: _type
      required:
        - _type
        - id
        - createdAt
      properties:
        _type:
          type: string
          readOnly: true
        id:
          type: string
          readOnly: true
        createdAt:
          type: string
          format: date-time
          example: '2012-04-23T18:25:43.511Z'
          readOnly: true
    UserPasswordResetEvent:
      description: A user password reset event.
      allOf:
        - $ref: "#/components/schemas/DomainEvent"
        - type: object
          required:
            - user
            - tempPassword
          properties:
            user:
              $ref: "#/components/schemas/User"
            tempPassword:
              type: string
    UserLoginEvent:
      description: A user login event.
      allOf:
        - $ref: "#/components/schemas/DomainEvent"
        - type: object
          required:
            - user
          properties:
            user:
              $ref: "#/components/schemas/User"
    User:
      type: object
      required:
        - id
        - firstName
        - lastName
        - email
      properties:
        id:
          type: integer
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        dateOfBirth:
          type: string
          format: date
    DataTypes:
      type: object
      properties:
        double:
          type: number
          format: double
        float:
          type: number
          format: float
        integer:
          type: integer
          format: int32
        long:
          type: integer
          format: int64
    Notification:
      type: object
      discriminator: _type
      required:
        - _type
        - id
        - createdAt
        - status
      properties:
        _type:
          type: string
          readOnly: true
        id:
          type: string
          readOnly: true
        createdAt:
          type: string
          format: date-time
          example: '2012-04-23T18:25:43.511Z'
          readOnly: true
        status:
          type: string
          enum:
            - NEW
            - DELIVERED
            - SEEN
            - READ
            - ARCHIVED
    PasswordResetRequestedNotification:
      description: Somebody has requested the password reset.
      allOf:
        - $ref: "#/components/schemas/Notification"