Problem JSON | Schema-register

Problem JSON schema representing errors and status code

dialect2020-12

typeobject

health78%

Schema gebruiken

JSON Schema

schema.json Download bundled

SourceMeta

SourceMeta name: problemjson
Base dialect: https://json-schema.org/draft/2020-12/schema
SourceMeta dialect: https://json-schema.org/draft/2020-12/schema
Bytes: 1.698 bytes
Bytes bundled: 1.698 bytes
Health: 78%
Dependencies: -

Health issues

Name: top_level_examples
Message: Set a non-empty examples array at the top level of the schema to illustrate the expected data
Pointers

Name: enum_with_type
Message: Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types
Pointers: /properties/errors/items/properties/in/enum - /properties/errors/items/properties/in/type

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-design-rules/problemjson",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Problem JSON schema representing errors and status code",
  "properties": {
    "errors": {
      "items": {
        "description": "List of errors encountered during processing",
        "properties": {
          "code": {
            "description": "A code representing the type of error",
            "examples": [
              "date.format"
            ],
            "type": "string"
          },
          "detail": {
            "description": "A detailed message describing the error",
            "examples": [
              "must be ISO 8601"
            ],
            "type": "string"
          },
          "in": {
            "description": "Location of the error (e.g., body, query, header)",
            "enum": [
              "body",
              "query"
            ],
            "type": "string"
          },
          "location": {
            "description": "Location in the document where the error occurred (JSON Pointer)",
            "examples": [
              "#/foo[0]/bar"
            ],
            "type": "string"
          }
        },
        "required": [
          "in",
          "location",
          "code",
          "detail"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "status": {
      "description": "The HTTP status code generated by the origin server for this occurrence of the problem",
      "examples": [
        400
      ],
      "type": "integer"
    },
    "title": {
      "description": "A short, human-readable summary of the problem type",
      "examples": [
        "Request validation failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "status",
    "title"
  ],
  "title": "Problem JSON",
  "type": "object"
}

Metadata

Aangemaakt op: 21-7-2026
Laatst gecrawld op: 4-8-2026
ID: yVEBGnEDg

Schema-register: Problem JSON

Details van JSON Schema: Problem JSON

Details van JSON Schema: Problem JSON

Beschrijving