deckprobe/docs/deckprobe-report.schema.json at main · aTankey/deckprobe · 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
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/deckflow/deckprobe/blob/main/docs/deckprobe-report.schema.json",
  "title": "DeckProbe JSON envelope v2",
  "oneOf": [
    { "$ref": "#/$defs/probeReport" },
    { "$ref": "#/$defs/valuesReport" },
    { "$ref": "#/$defs/errorReport" }
  ],
  "$defs": {
    "base": {
      "type": "object",
      "required": ["schema_version", "tool_version", "status"],
      "properties": {
        "schema_version": { "const": 2 },
        "tool_version": { "type": "string" },
        "status": { "type": "string" }
      }
    },
    "probeReport": {
      "allOf": [
        { "$ref": "#/$defs/base" },
        {
          "type": "object",
          "required": ["input", "driver", "results", "execution", "diagnostics"],
          "properties": {
            "schema_version": { "const": 2 },
            "tool_version": { "type": "string" },
            "status": { "enum": ["ok", "partial"] },
            "input": {
              "type": "object",
              "required": ["display_name", "source_kind", "file_size"],
              "properties": {
                "display_name": { "type": "string" },
                "source_kind": { "type": "string", "minLength": 1 },
                "file_size": { "type": "integer", "minimum": 0 }
              },
              "additionalProperties": false
            },
            "driver": {
              "type": "object",
              "required": ["id", "profile"],
              "properties": {
                "id": { "type": "string" },
                "profile": { "type": "string" }
              },
              "additionalProperties": false
            },
            "results": {
              "type": "object",
              "additionalProperties": { "$ref": "#/$defs/evidence" }
            },
            "execution": { "$ref": "#/$defs/execution" },
            "diagnostics": {
              "type": "array",
              "items": { "$ref": "#/$defs/diagnostic" }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "errorReport": {
      "allOf": [
        { "$ref": "#/$defs/base" },
        {
          "type": "object",
          "required": ["error"],
          "properties": {
            "schema_version": { "const": 2 },
            "tool_version": { "type": "string" },
            "status": { "const": "error" },
            "error": {
              "type": "object",
              "required": ["code", "message", "exit_code"],
              "properties": {
                "code": {
                  "enum": [
                    "CLI_SYNTAX",
                    "INVALID_REQUEST",
                    "UNSUPPORTED_TARGET",
                    "SOURCE_IO",
                    "UNSUPPORTED_FORMAT",
                    "MALFORMED_INPUT",
                    "BUDGET_EXCEEDED",
                    "PARSER_FAILURE"
                  ]
                },
                "message": { "type": "string" },
                "exit_code": { "type": "integer", "minimum": 1, "maximum": 6 }
              },
              "additionalProperties": false
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "valuesReport": {
      "allOf": [
        { "$ref": "#/$defs/base" },
        {
          "type": "object",
          "required": [
            "view",
            "input",
            "driver",
            "values",
            "unresolved_targets",
            "diagnostics"
          ],
          "properties": {
            "schema_version": { "const": 2 },
            "tool_version": { "type": "string" },
            "status": { "enum": ["ok", "partial"] },
            "view": { "const": "values" },
            "input": {
              "type": "object",
              "required": ["display_name", "source_kind", "file_size"],
              "properties": {
                "display_name": { "type": "string" },
                "source_kind": { "type": "string", "minLength": 1 },
                "file_size": { "type": "integer", "minimum": 0 }
              },
              "additionalProperties": false
            },
            "driver": {
              "type": "object",
              "required": ["id", "profile"],
              "properties": {
                "id": { "type": "string" },
                "profile": { "type": "string" }
              },
              "additionalProperties": false
            },
            "values": {
              "type": "object",
              "additionalProperties": true
            },
            "unresolved_targets": {
              "type": "array",
              "items": { "type": "string" }
            },
            "piggyback_targets": {
              "type": "array",
              "items": { "type": "string" }
            },
            "diagnostics": {
              "type": "array",
              "items": { "$ref": "#/$defs/diagnostic" }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "evidence": {
      "type": "object",
      "required": ["target", "status", "confidence", "confidence_score", "path", "source"],
      "properties": {
        "target": { "type": "string" },
        "status": {
          "enum": [
            "resolved",
            "estimated",
            "planned",
            "unknown",
            "unsupported",
            "invalid",
            "budget_exceeded",
            "failed"
          ]
        },
        "value": true,
        "confidence": { "enum": ["none", "low", "medium", "high", "exact"] },
        "confidence_score": { "type": "number", "minimum": 0, "maximum": 1 },
        "path": { "type": "string" },
        "source": { "type": "string" }
      },
      "additionalProperties": false
    },
    "execution": {
      "type": "object",
      "required": ["probe_level", "paths", "estimated_cost", "actual_cost", "unresolved_targets"],
      "properties": {
        "probe_level": { "enum": ["header", "metadata", "deep"] },
        "paths": { "type": "array", "items": { "type": "string" } },
        "estimated_cost": { "type": "integer", "minimum": 0 },
        "actual_cost": {
          "type": "object",
          "required": ["physical_bytes_read", "expanded_bytes", "random_reads"],
          "properties": {
            "physical_bytes_read": { "type": "integer", "minimum": 0 },
            "expanded_bytes": { "type": "integer", "minimum": 0 },
            "random_reads": { "type": "integer", "minimum": 0 },
            "elapsed_ms": { "type": "number", "minimum": 0 }
          },
          "additionalProperties": false
        },
        "unresolved_targets": { "type": "array", "items": { "type": "string" } }
        ,
        "piggyback_targets": { "type": "array", "items": { "type": "string" } }
      },
      "additionalProperties": false
    },
    "diagnostic": {
      "type": "object",
      "required": ["level", "code", "message"],
      "properties": {
        "level": { "type": "string" },
        "code": { "type": "string" },
        "message": { "type": "string" }
      },
      "additionalProperties": false
    }
  }
}