episteme 0.3.9

Knowledge graph for software engineering — design patterns, refactorings, and laws for AI agents
Documentation 
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Episteme Knowledge Graph Schema",
  "description": "Metadata schema for knowledge graph entities and relations",
  "version": "0.1.0",

  "definitions": {
    "entity": {
      "type": "object",
      "required": ["id", "type", "title"],
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^(DP|RF|LAW|SMELL|TK)-[0-9]{2,3}(?:-[A-Z])?$",
          "description": "Unique identifier: DP=Design Pattern, RF=Refactoring, LAW=Software Law/Principle, SMELL=Code Smell, TK=Tacit Knowledge/Insight"
        },
        "type": {
          "type": "string",
          "enum": ["pattern", "refactoring", "law", "smell", "insight"]
        },
        "file_path": {
          "type": "string",
          "description": "Relative path from raw/ directory"
        },
        "title": {
          "type": "string"
        },
        "name": {
          "type": "string",
          "description": "Alternative display name (used by smell entities)"
        },
        "description": {
          "type": "string"
        },
        "category": {
          "type": "string",
          "description": "Subcategory: creational/structural/behavioral, bloater/dispensable/coupler, etc."
        },
        "tags": {
          "type": "array",
          "items": { "type": "string" }
        },
        "source": {
          "oneOf": [
            { "type": "string" },
            { "type": "object" },
            { "type": "null" }
          ],
          "description": "Source metadata"
        }
      }
    },

    "relation": {
      "type": "object",
      "properties": {
        "solves": {
          "type": "array",
          "items": { "type": "string" },
          "description": "IDs of problems/smells this entity solves"
        },
        "solved_by": {
          "type": "array",
          "items": { "type": "string" },
          "description": "IDs of patterns/refactorings that solve this entity"
        },
        "enforces": {
          "type": "array",
          "items": { "type": "string" },
          "description": "IDs of laws/principles this entity enforces"
        },
        "enforced_by": {
          "type": "array",
          "items": { "type": "string" },
          "description": "IDs of entities that enforce this law/principle"
        },
        "violates": {
          "type": "array",
          "items": { "type": "string" },
          "description": "IDs of laws/principles this entity violates"
        },
        "violated_by": {
          "type": "array",
          "items": { "type": "string" },
          "description": "IDs of entities that violate this law/principle"
        },
        "related_to": {
          "type": "array",
          "items": { "type": "string" },
          "description": "IDs of similar/alternative entities"
        },
        "derives_from": {
          "type": "array",
          "items": { "type": "string" },
          "description": "IDs of canonical entities this insight derives from (user insights only)"
        },
        "applies_to": {
          "type": "array",
          "items": { "type": "string" },
          "description": "IDs of entities this insight applies to (user insights only)"
        },
        "supersedes": {
          "type": "array",
          "items": { "type": "string" },
          "description": "IDs of entities superseded by this one"
        },
        "requires": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Reserved for future use (currently empty in data)"
        },
        "enables": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Reserved for future use (currently empty in data)"
        }
      }
    },

    "context": {
      "type": "object",
      "properties": {
        "when_to_use": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Scenarios where this should be applied"
        },
        "when_not_to_use": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Anti-scenarios where this should be avoided"
        },
        "symptoms": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Code smells or indicators (for smells/refactorings)"
        },
        "benefits": {
          "type": "array",
          "items": { "type": "string" }
        },
        "drawbacks": {
          "type": "array",
          "items": { "type": "string" }
        }
      }
    }
  },

  "type": "object",
  "patternProperties": {
    "^(DP|RF|LAW|SMELL|TK)-[0-9]{2,3}(?:-[A-Z])?$": {
      "allOf": [
        { "$ref": "#/definitions/entity" },
        {
          "properties": {
            "relations": { "$ref": "#/definitions/relation" },
            "context": { "$ref": "#/definitions/context" }
          }
        }
      ]
    }
  }
}