SystemMaintenanceEvent

  • eventId
    Type: string Format: uuid
    required
  • eventType
    enum
    const:  
    system.maintenance
    required
    values
    • system.maintenance
  • maintenance
    Type: object
    required
    • duration
      Type: string Format: duration
      required

      Expected duration in ISO 8601 format

    • status
      Type: string enum
      required
      values
      • scheduled
      • starting
      • in_progress
      • completed
      • failed
    • type
      Type: string enum
      required
      values
      • scheduled
      • emergency
      • hotfix
    • affectedServices
      Type: array string[]
    • description
      Type: string
  • timestamp
    Type: string Format: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • metadata
    Type: object · EventMetadata
    • correlationId
      Type: string

      Correlation ID for tracing related events

    • requestId
      Type: string

      ID of the request that triggered the event

    • severity
      Type: string enum

      Event severity level

      values
      • info
      • warning
      • error
      • critical
    • source
      Type: string

      Source system that generated the event

    • userId
      Type: integer Format: int64

      ID of the user who triggered the event (if applicable)

  • schedule
    Type: object
    • endTime
      Type: string Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • startTime
      Type: string Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z