Skip to content

MUST use valid problem json schema

Problem schema MUST include this set of minimal required properties and validations:

Valid Example

ProblemDetails:
  type: object
  description: Schema for detailed problem information.
  properties:
    type:
      type: string
      description: A URI reference that identifies the problem type.
      format: uri-reference
      maxLength: 1024
    status:
      type: integer
      description: The HTTP status code generated by the origin server for this occurrence of the problem.
      format: int32
      minimum: 100
      maximum: 599
    title:
      type: string
      description: A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
      maxLength: 1024
    detail:
      type: string
      description: A human-readable explanation specific to this occurrence of the problem.
      maxLength: 4096
    instance:
      type: string
      description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
      maxLength: 1024
required:
  - type
  - status
  - title
  - detail
  - instance

Zalando Guideline 176