github/json-schema/github-gists-validation-error-schema.json at main · api-evangelist/github · 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
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-schema/github-gists-validation-error-schema.json",
  "title": "validation-error",
  "description": "Validation Error",
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Example body text"
    },
    "documentation_url": {
      "type": "string",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "code"
        ],
        "properties": {
          "resource": {
            "type": "string"
          },
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "code": {
            "type": "string"
          },
          "index": {
            "type": "integer"
          },
          "value": {
            "oneOf": [
              {
                "type": "string",
                "nullable": true
              },
              {
                "type": "integer",
                "nullable": true
              },
              {
                "type": "array",
                "nullable": true,
                "items": {
                  "type": "string"
                }
              }
            ]
          }
        }
      }
    }
  },
  "required": [
    "message",
    "documentation_url"
  ]
}