Skip to content

Instantly share code, notes, and snippets.

@DavidBiesack
Last active March 26, 2023 03:32
Show Gist options
  • Select an option

  • Save DavidBiesack/5d8aa88af7ffc34ab38bfbb0cde833c1 to your computer and use it in GitHub Desktop.

Select an option

Save DavidBiesack/5d8aa88af7ffc34ab38bfbb0cde833c1 to your computer and use it in GitHub Desktop.
JSON Schema for application/problem+json responses, as per RFC 7807
title: API Problem
description: 'API problem response, as per [RFC 7807 application/problem+json](https://tools.ietf.org/html/rfc7807).'
type: object
properties:
type:
description: 'A URI reference [RFC3986] that identifies the problem type.'
type: string
format: uri-reference
maxLength: 128
title:
description: 'A short, human-readable summary of the problem type.'
type: string
maxLength: 120
status:
description: 'The [HTTP status code](https://www.rfc-editor.org/rfc/rfc9110#name-status-codes) generated by the origin server for this occurrence of the problem.'
type: integer
format: int32
minimum: 100
maximum: 599
instance:
description: A URI reference that identifies the specific occurrence of the problem.
type: string
format: uri-reference
maxLength: 128
detail:
description: A human-readable explanation specific to this occurrence of the problem.
type: string
maxLength: 2048
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment