visit-scheduler-event-specification.yaml

asyncapi: 2.2.0
info:
  title: Visit Scheduler Microservice Events
  version: '1'
  description: Events posted by the *Visit Scheduler* microservice
  contact:
    name: Visit Someone in Prison Team
    email: prisonvisitsbooking@digital.justice.gov.uk

servers:
  production:
    url: hmpps-domain-events-prod.live-1.cloud-platform.service.justice.gov.uk
    protocol: sqs
    description: Production Environment
  pre-production:
    url: hmpps-domain-events-preprod.live-1.cloud-platform.service.justice.gov.uk
    protocol: sqs
    description: Pre-production Environment
  test:
    url: hmpps-domain-events-dev.live-1.cloud-platform.service.justice.gov.uk
    protocol: sqs
    description: Test Environment

channels:
  prison-visit.booked:
    description: Prison Visit Booked
    publish:
      message:
        $ref: '#/components/messages/visit-event'
      bindings:
        sns:
          is: notification service
  prison-visit.cancelled:
    description: Prison Visit Cancelled
    publish:
      message:
        $ref: '#/components/messages/visit-event'
      bindings:
        sns:
          is: notification service
components:
  messages:
    visit-event:
      payload:
        $ref: '#/components/schemas/VisitEvent'
  schemas:
    VisitEvent:
      type: object
      description: Visit Event Object
      properties:
          eventType:
            $ref: '#/components/schemas/VisitEventType'
          version:
            type: integer
            description: Event signature version
          detailUrl:
            type: string
            description: Location of further details
          occuredAt:
            type: string
            format: datetime
            description: Timestamp this event occurred
          visitType:
            $ref: '#/components/schemas/VisitType'
          prisonerId:
            type: string
            description: Id of prisoner being visited
          additionalInformation:
            $ref: '#/components/schemas/AdditionalInformation'
    AdditionalInformation:
      type: object
      description: Additional Information for this visit event
      properties:
        visitId:
          type: string
          description: Unique identifier for this visit
        NOMISvisitId:
          type: string
          description: NOMIS's identifier for this visit
    VisitType:
      type: string
      description: Visit Type
      enum:
        - social
        - family
        - official
        - legal
    VisitEventType:
      type: string
      description: Set of possible visit event types
      enum:
        - prison-visit.booked
        - prison-visit.cancelled