asyncapi.yaml

# Copyright 2022 Adevinta
asyncapi: 2.4.0
info:
  title: Vulcan
  version: v0.0.2
servers:
  production:
    url: broker.example.com
    protocol: kafka
    description: Dummy server.
defaultContentType: application/json
channels:
  assets:
    description: CDC Events of the assets stored in Vulcan.
    subscribe:
      message:
        $ref: '#/components/messages/asset'

components:
  messages:
    asset:
      name: Asset
      title: Asset state
      summary: |
        Contains the state of an asset as it was stored in a point
        of time in Vulcan.
      headers: 
        $ref: "#/components/schemas/assetMetadata"
      contentType: application/json
      payload:
        $ref: "#/components/schemas/assetPayload"

  schemas:
    assetMetadata:
        type: object
        additionalProperties: false
        properties:
          identifier:
            type: string
          type: 
            $ref: "#/components/schemas/assetType"
          version:
            type: string
            description: The value of this field is equal to the value of the field info.version of this document.
        required:
          - identifier
          - type
          - version
            
    assetPayload:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: uuid
        team:
          $ref: "#/components/schemas/team"
        alias:
          type: string
        rolfp:
          type: string
        scannable:
          type: boolean
        asset_type:
          $ref: "#/components/schemas/assetType"
        identifier:
          type: string
        annotations:
          type: array
          items:
            - $ref: "#/components/schemas/annotation"
      required:
        - id
        - team
        - alias
        - rolfp
        - scannable
        - asset_type
        - identifier
        - annotations

    assetType:
      type: string
      # Update when the assets types accepted by Vulcan are updated.
      enum:
        - IP
        - DomainName
        - Hostname
        - AWSAccount
        - IPRange
        - DockerImage
        - WebAddress
        - GitRepository
        - GCPProject

    annotation:
      type: object
      additionalProperties: false
      properties:
        key:
          type: string
        value:
          type: string
      required:
        - key
        - value

    team:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type: string
        tag:
          type: string
      required:
        - id
        - name
        - description
        - tag