Skip to content

Commit

Permalink
fix: add missing error properties
Browse files Browse the repository at this point in the history
Add some properties missing from the JSON API specification, which
v3-go-libs supports, which need to match the schema of error responses.

See https://jsonapi.org/format/#error-objects
  • Loading branch information
cmars committed Feb 11, 2022
1 parent 39b0f76 commit c3facf5
Show file tree
Hide file tree
Showing 2 changed files with 16,858 additions and 4,718 deletions.
8 changes: 8 additions & 0 deletions components/errors.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,14 @@ Error:
type: string
description: "A human-readable explanation specific to this occurrence of the problem."
example: "The request was missing these required fields: ..."
code:
type: string
description: "An application-specific error code, expressed as a string value."
example: "entity-not-found"
title:
type: string
description: "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
example: "Bad request"
source:
type: object
properties:
Expand Down
Loading

0 comments on commit c3facf5

Please sign in to comment.