ApiVersionDeprecatedEvent

  • deprecation
    Type: object
    required
    • deprecatedAt
      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

    • sunsetAt
      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

    • version
      Type: string
      required
    • migrationGuide
      Type: string Format: uri
  • eventId
    Type: string Format: uuid
    required
  • eventType
    enum
    const:  
    api.version_deprecated
    required
    values
    • api.version_deprecated
  • 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

  • impact
    Type: object
    • affectedEndpoints
      Type: array string[]
    • breakingChanges
      Type: boolean
  • 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)