akamai-api-security/json-schema/api-security-validations-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
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
132
133
134
135
{
  "$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-validations-schema.json",
  "title": "validations",
  "description": "Contains warnings, errors, or notices determined by validating the match target.",
  "type": "object",
  "properties": {
    "errors": {
      "description": "The list of errors.",
      "items": {
        "additionalProperties": false,
        "description": "Contains feedback on validation.",
        "properties": {
          "detail": {
            "description": "The explanation of the error message.",
            "type": "string"
          },
          "fieldName": {
            "description": "The name of the field causing the validation problem.",
            "type": "string"
          },
          "jsonReference": {
            "description": "The JSON reference to the field in the resource.",
            "type": "string"
          },
          "title": {
            "description": "The title for the error.",
            "example": "Not Found",
            "type": "string"
          },
          "type": {
            "description": "The URL for the error type.",
            "example": "/appsec/problem-types/INCOMPATIBLE-FIELD",
            "type": "string"
          }
        },
        "required": [
          "title",
          "type"
        ],
        "type": "object",
        "x-akamai": {
          "file-path": "schemas/validation.yaml"
        }
      },
      "type": "array"
    },
    "notices": {
      "description": "The list of notices.",
      "items": {
        "additionalProperties": false,
        "description": "Contains feedback on validation.",
        "properties": {
          "detail": {
            "description": "The explanation of the error message.",
            "type": "string"
          },
          "fieldName": {
            "description": "The name of the field causing the validation problem.",
            "type": "string"
          },
          "jsonReference": {
            "description": "The JSON reference to the field in the resource.",
            "type": "string"
          },
          "title": {
            "description": "The title for the error.",
            "example": "Not Found",
            "type": "string"
          },
          "type": {
            "description": "The URL for the error type.",
            "example": "/appsec/problem-types/INCOMPATIBLE-FIELD",
            "type": "string"
          }
        },
        "required": [
          "title",
          "type"
        ],
        "type": "object",
        "x-akamai": {
          "file-path": "schemas/validation.yaml"
        }
      },
      "type": "array"
    },
    "warnings": {
      "description": "The list of warnings.",
      "items": {
        "additionalProperties": false,
        "description": "Contains feedback on validation.",
        "properties": {
          "detail": {
            "description": "The explanation of the error message.",
            "type": "string"
          },
          "fieldName": {
            "description": "The name of the field causing the validation problem.",
            "type": "string"
          },
          "jsonReference": {
            "description": "The JSON reference to the field in the resource.",
            "type": "string"
          },
          "title": {
            "description": "The title for the error.",
            "example": "Not Found",
            "type": "string"
          },
          "type": {
            "description": "The URL for the error type.",
            "example": "/appsec/problem-types/INCOMPATIBLE-FIELD",
            "type": "string"
          }
        },
        "required": [
          "title",
          "type"
        ],
        "type": "object",
        "x-akamai": {
          "file-path": "schemas/validation.yaml"
        }
      },
      "type": "array"
    }
  },
  "required": [
    "notices",
    "errors",
    "warnings"
  ],
  "additionalProperties": false
}