specification/graphSchema.json at main · statelyai/specification · 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
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "type": {
      "description": "Default edge direction for the graph.",
      "default": "directed",
      "type": "string",
      "enum": [
        "directed",
        "undirected"
      ]
    },
    "description": {
      "description": "Optional description of the graph",
      "type": "string"
    },
    "nodes": {
      "description": "Nodes in the graph.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/Node"
      }
    },
    "edges": {
      "description": "Edges connecting nodes.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/Edge"
      }
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": false,
  "$defs": {
    "Node": {
      "type": "object",
      "properties": {
        "id": {
          "description": "Unique identifier for the node within the document. Required attribute.",
          "type": "string"
        },
        "parentId": {
          "description": "ID of the parent node for nested graphs.",
          "type": "string"
        },
        "description": {
          "description": "Optional description of the node",
          "type": "string"
        },
        "meta": {
          "description": "Metadata for the node",
          "$ref": "#/$defs/GraphMeta"
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false,
      "id": "Node"
    },
    "GraphMeta": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {},
      "id": "GraphMeta"
    },
    "Edge": {
      "type": "object",
      "properties": {
        "id": {
          "description": "Optional unique identifier for the edge",
          "type": "string"
        },
        "sourceId": {
          "description": "ID of the source node. Required attribute.",
          "type": "string"
        },
        "targetId": {
          "description": "ID(s) of the target node(s). Single string for regular edges, array for hyperedges.",
          "anyOf": [
            {
              "description": "ID of the target node",
              "type": "string"
            },
            {
              "description": "IDs of multiple target nodes for hyperedges.",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          ]
        },
        "description": {
          "description": "Optional description of the edge",
          "type": "string"
        },
        "meta": {
          "description": "Metadata for the edge",
          "$ref": "#/$defs/GraphMeta"
        }
      },
      "required": [
        "sourceId",
        "targetId"
      ],
      "additionalProperties": false,
      "id": "Edge"
    }
  }
}