squarewise/contracts/errors/problem.schema.json at master · ohbus/squarewise · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://squarewise.example/schemas/problem.json",
  "title": "Squarewise API Problem Details",
  "description": "RFC 9457 Problem Details with additive Squarewise error identity and bounded validation metadata.",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "numericCode",
    "errorName",
    "source",
    "requestId",
    "detail",
    "timestamp"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri-reference",
      "maxLength": 256
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    },
    "status": {
      "type": "integer",
      "minimum": 400,
      "maximum": 599
    },
    "code": {
      "type": "string",
      "enum": [
        "MALFORMED_REQUEST",
        "AUTHENTICATION_ERROR",
        "AUTHORIZATION_ERROR",
        "NOT_FOUND",
        "STATE_CONFLICT",
        "RESOURCE_GONE",
        "VALIDATION_ERROR",
        "BUSINESS_RULE_VIOLATION",
        "RATE_LIMIT_EXCEEDED",
        "INTERNAL_ERROR"
      ],
      "description": "High-level error category and family for coarse client routing."
    },
    "numericCode": {
      "type": "string",
      "pattern": "^[1-9]{4}(0[1-9]|[1-9][0-9])$",
      "description": "Canonical six-digit machine error code (DMLCEE)."
    },
    "errorName": {
      "type": "string",
      "pattern": "^[A-Z0-9_]{3,64}$",
      "description": "Immutable SCREAMING_SNAKE_CASE error identity."
    },
    "messageKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "description": "Hierarchical internationalization key for frontend translation."
    },
    "source": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "requestId": {
      "type": "string",
      "format": "uuid"
    },
    "detail": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512
    },
    "instance": {
      "type": "string",
      "format": "uri-reference",
      "maxLength": 256
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "violations": {
      "type": "array",
      "maxItems": 50,
      "items": {
        "$ref": "#/$defs/violation"
      }
    }
  },
  "$defs": {
    "violation": {
      "type": "object",
      "required": [
        "field",
        "message"
      ],
      "properties": {
        "field": {
          "type": "string",
          "minLength": 1,
          "maxLength": 256,
          "description": "Bounded JSON Pointer or request-field path."
        },
        "message": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        },
        "messageKey": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "description": "Hierarchical validation constraint key for frontend translation."
        },
        "rejectedValue": {
          "description": "Sanitized representation of the rejected parameter value."
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}