code-guide/code-guide.schema.json at main · Axiweave/code-guide · 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
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://example.invalid/code-guide.schema.json",
  "title": "code-guide document",
  "type": "object",
  "required": [
    "version",
    "title",
    "nodes"
  ],
  "additionalProperties": false,
  "properties": {
    "version": {
      "const": 1
    },
    "title": {
      "type": "string",
      "minLength": 1
    },
    "description": {
      "type": "string"
    },
    "root": {
      "type": "string",
      "default": "."
    },
    "nodes": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/node"
      }
    }
  },
  "$defs": {
    "location": {
      "type": "object",
      "required": [
        "file",
        "line"
      ],
      "additionalProperties": false,
      "properties": {
        "file": {
          "type": "string",
          "minLength": 1
        },
        "line": {
          "type": "integer",
          "minimum": 1
        },
        "column": {
          "type": "integer",
          "minimum": 1
        },
        "symbol": {
          "type": "string",
          "minLength": 1
        },
        "anchor": {
          "type": "string",
          "minLength": 1
        }
      }
    },
    "node": {
      "type": "object",
      "required": [
        "id",
        "title"
      ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "pattern": "^[a-z0-9][a-z0-9-]*$"
        },
        "title": {
          "type": "string",
          "minLength": 1
        },
        "comment": {
          "type": "string"
        },
        "location": {
          "$ref": "#/$defs/location"
        },
        "children": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/node"
          },
          "default": []
        }
      }
    }
  }
}