nuts-foundation/nuts-node

View on GitHub
docs/_static/common/error_response.yaml

Summary

Maintainability
Test Coverage
description: |
  Default return values follow Problem Details for HTTP APIs as specified in [RFC7807](https://tools.ietf.org/html/rfc7807).

  Currently, return values contain the following members of a problem details object:
  - "title" (string) - A short, human-readable summary of the problem type.
  - "status" (number) - The HTTP status code generated by the origin server for this occurrence of the problem.
  - "detail" (string) - A human-readable explanation specific to this occurrence of the problem.
content:
  application/problem+json:  # https://tools.ietf.org/html/rfc7807#section-6.1
    schema:
      type: object
      required:
        - title
        - status
        - detail
      properties:
        title:
          type: string
          description: A short, human-readable summary of the problem type.
        status:
          type: number
          description: HTTP statuscode
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.