akamai-api-security/json-schema/api-security-problem-details-schema.json at main · api-evangelist/akamai-api-security · 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
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akamai-api-security/refs/heads/main/json-schema/api-security-problem-details-schema.json",
  "title": "problem-details",
  "description": "Details the errors you can receive.",
  "type": "object",
  "properties": {
    "detail": {
      "description": "The detailed error message.",
      "type": "string"
    },
    "fieldErrors": {
      "additionalProperties": {
        "description": "Fields that provide additional details about the problem.",
        "type": "string"
      },
      "description": "Pointers to fields for which invalid input was provided, whose values are messages detailing the reason this input was invalid for this field.",
      "type": "object"
    },
    "instance": {
      "description": "The non-referenceable URI that indicates the error instance.",
      "example": "https://problems.luna.akamaiapis.net/api-definitions/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
      "type": "string"
    },
    "status": {
      "description": "The HTTP status code.",
      "example": 404,
      "type": "integer"
    },
    "title": {
      "description": "The error title.",
      "example": "Not Found",
      "type": "string"
    },
    "type": {
      "description": "The URL for the error type.",
      "example": "https://problems.luna.akamaiapis.net/api-definitions/error-types/NOT-FOUND",
      "type": "string"
    }
  },
  "required": [
    "title",
    "type",
    "detail",
    "instance",
    "status"
  ],
  "additionalProperties": true
}