@crvouga/atlas 0.10.0 → 0.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/CHANGELOG.md +7 -1
  2. package/dist/schema/src/common.d.ts +2 -2
  3. package/dist/schema/src/manifest.d.ts +4 -4
  4. package/dist/schema/src/spec.d.ts +6 -6
  5. package/package.json +3 -3
  6. package/packages/schema/schemas/check-detail.schema.json +15 -15
  7. package/packages/schema/schemas/checks-result.schema.json +2 -2
  8. package/packages/schema/schemas/command-error.schema.json +4 -4
  9. package/packages/schema/schemas/doctor-result.schema.json +4 -4
  10. package/packages/schema/schemas/effective-delta.schema.json +69 -95
  11. package/packages/schema/schemas/effective-evidence.schema.json +63 -89
  12. package/packages/schema/schemas/evidence-page.schema.json +41 -59
  13. package/packages/schema/schemas/init-plan.schema.json +58 -90
  14. package/packages/schema/schemas/layer-rows.schema.json +17 -29
  15. package/packages/schema/schemas/layer.schema.json +54 -70
  16. package/packages/schema/schemas/live-run-start.schema.json +1 -1
  17. package/packages/schema/schemas/live-run.schema.json +1 -1
  18. package/packages/schema/schemas/merge-result.schema.json +6 -6
  19. package/packages/schema/schemas/outline.schema.json +7 -11
  20. package/packages/schema/schemas/path-record.schema.json +12 -28
  21. package/packages/schema/schemas/problem.schema.json +9 -9
  22. package/packages/schema/schemas/publish-checks.schema.json +27 -43
  23. package/packages/schema/schemas/publish-result.schema.json +16 -24
  24. package/packages/schema/schemas/ready.schema.json +12 -12
  25. package/packages/schema/schemas/report-event.schema.json +22 -28
  26. package/packages/schema/schemas/report-run.schema.json +33 -59
  27. package/packages/schema/schemas/report-runs.schema.json +24 -38
  28. package/packages/schema/schemas/report-status.schema.json +30 -54
  29. package/packages/schema/schemas/run-info.schema.json +9 -21
  30. package/packages/schema/schemas/run-summary.schema.json +6 -14
  31. package/packages/schema/schemas/server-config.schema.json +21 -21
  32. package/packages/schema/schemas/server-editable-settings.schema.json +14 -14
  33. package/packages/schema/schemas/server-info.schema.json +15 -19
  34. package/packages/schema/schemas/server-settings-snapshot.schema.json +28 -28
  35. package/packages/schema/schemas/spec-set.schema.json +16 -24
  36. package/packages/schema/schemas/state-node.schema.json +16 -16
  37. package/packages/schema/schemas/state-record.schema.json +5 -9
  38. package/packages/schema/schemas/store-listing.schema.json +3 -7
  39. package/packages/schema/schemas/store-write-result.schema.json +2 -2
  40. package/packages/schema/schemas/stream-result.schema.json +13 -17
  41. package/packages/schema/schemas/test-catalog.schema.json +109 -151
  42. package/packages/schema/schemas/test-history.schema.json +72 -136
  43. package/packages/schema/schemas/timeline-entry.schema.json +2 -2
  44. package/packages/schema/schemas/transition-record.schema.json +9 -21
  45. package/packages/server/openapi.json +620 -910
package/packages/schema/schemas/report-run.schema.json CHANGED
@@ -14,37 +14,25 @@
14
14
  "type": "object",
15
15
  "properties": {
16
16
  "key": {
17
- "description": "The run URL, or `branch@sha`. Pass it to `/api/reports/runs/detail?key=` or `/api/reports/tests?run=`",
18
- "type": "string"
17
+ "type": "string",
18
+ "description": "The run URL, or `branch@sha`. Pass it to `/api/reports/runs/detail?key=` or `/api/reports/tests?run=`"
19
19
  },
20
20
  "runUrl": {
21
- "anyOf": [
22
- {
23
- "type": "string"
24
- },
25
- {
26
- "type": "null"
27
- }
21
+ "type": [
22
+ "string",
23
+ "null"
28
24
  ]
29
25
  },
30
26
  "branch": {
31
- "anyOf": [
32
- {
33
- "type": "string"
34
- },
35
- {
36
- "type": "null"
37
- }
27
+ "type": [
28
+ "string",
29
+ "null"
38
30
  ]
39
31
  },
40
32
  "sha": {
41
- "anyOf": [
42
- {
43
- "type": "string"
44
- },
45
- {
46
- "type": "null"
47
- }
33
+ "type": [
34
+ "string",
35
+ "null"
48
36
  ]
49
37
  },
50
38
  "startedAtMs": {
@@ -93,16 +81,18 @@
93
81
  "type": "integer",
94
82
  "minimum": 0,
95
83
  "maximum": 9007199254740991
96
- }
84
+ },
85
+ "required": [
86
+ "passed",
87
+ "failed",
88
+ "running",
89
+ "not-run"
90
+ ]
97
91
  },
98
92
  "totalDurationMs": {
99
- "anyOf": [
100
- {
101
- "type": "number"
102
- },
103
- {
104
- "type": "null"
105
- }
93
+ "type": [
94
+ "number",
95
+ "null"
106
96
  ]
107
97
  },
108
98
  "failing": {
@@ -117,13 +107,9 @@
117
107
  "type": "string"
118
108
  },
119
109
  "environment": {
120
- "anyOf": [
121
- {
122
- "type": "string"
123
- },
124
- {
125
- "type": "null"
126
- }
110
+ "type": [
111
+ "string",
112
+ "null"
127
113
  ]
128
114
  },
129
115
  "detail": {
@@ -173,23 +159,15 @@
173
159
  "type": "string"
174
160
  },
175
161
  "specPath": {
176
- "anyOf": [
177
- {
178
- "type": "string"
179
- },
180
- {
181
- "type": "null"
182
- }
162
+ "type": [
163
+ "string",
164
+ "null"
183
165
  ]
184
166
  },
185
167
  "environment": {
186
- "anyOf": [
187
- {
188
- "type": "string"
189
- },
190
- {
191
- "type": "null"
192
- }
168
+ "type": [
169
+ "string",
170
+ "null"
193
171
  ]
194
172
  },
195
173
  "producer": {
@@ -205,13 +183,9 @@
205
183
  ]
206
184
  },
207
185
  "durationMs": {
208
- "anyOf": [
209
- {
210
- "type": "number"
211
- },
212
- {
213
- "type": "null"
214
- }
186
+ "type": [
187
+ "number",
188
+ "null"
215
189
  ]
216
190
  },
217
191
  "at": {
package/packages/schema/schemas/report-runs.schema.json CHANGED
@@ -21,37 +21,25 @@
21
21
  "type": "object",
22
22
  "properties": {
23
23
  "key": {
24
- "description": "The run URL, or `branch@sha`. Pass it to `/api/reports/runs/detail?key=` or `/api/reports/tests?run=`",
25
- "type": "string"
24
+ "type": "string",
25
+ "description": "The run URL, or `branch@sha`. Pass it to `/api/reports/runs/detail?key=` or `/api/reports/tests?run=`"
26
26
  },
27
27
  "runUrl": {
28
- "anyOf": [
29
- {
30
- "type": "string"
31
- },
32
- {
33
- "type": "null"
34
- }
28
+ "type": [
29
+ "string",
30
+ "null"
35
31
  ]
36
32
  },
37
33
  "branch": {
38
- "anyOf": [
39
- {
40
- "type": "string"
41
- },
42
- {
43
- "type": "null"
44
- }
34
+ "type": [
35
+ "string",
36
+ "null"
45
37
  ]
46
38
  },
47
39
  "sha": {
48
- "anyOf": [
49
- {
50
- "type": "string"
51
- },
52
- {
53
- "type": "null"
54
- }
40
+ "type": [
41
+ "string",
42
+ "null"
55
43
  ]
56
44
  },
57
45
  "startedAtMs": {
@@ -100,16 +88,18 @@
100
88
  "type": "integer",
101
89
  "minimum": 0,
102
90
  "maximum": 9007199254740991
103
- }
91
+ },
92
+ "required": [
93
+ "passed",
94
+ "failed",
95
+ "running",
96
+ "not-run"
97
+ ]
104
98
  },
105
99
  "totalDurationMs": {
106
- "anyOf": [
107
- {
108
- "type": "number"
109
- },
110
- {
111
- "type": "null"
112
- }
100
+ "type": [
101
+ "number",
102
+ "null"
113
103
  ]
114
104
  },
115
105
  "failing": {
@@ -124,13 +114,9 @@
124
114
  "type": "string"
125
115
  },
126
116
  "environment": {
127
- "anyOf": [
128
- {
129
- "type": "string"
130
- },
131
- {
132
- "type": "null"
133
- }
117
+ "type": [
118
+ "string",
119
+ "null"
134
120
  ]
135
121
  },
136
122
  "detail": {
package/packages/schema/schemas/report-status.schema.json CHANGED
@@ -11,11 +11,11 @@
11
11
  "type": "boolean"
12
12
  },
13
13
  "reasons": {
14
- "description": "Why `ok` is false, in words. Empty when it is true",
15
14
  "type": "array",
16
15
  "items": {
17
16
  "type": "string"
18
- }
17
+ },
18
+ "description": "Why `ok` is false, in words. Empty when it is true"
19
19
  },
20
20
  "checks": {
21
21
  "type": "object",
@@ -98,10 +98,10 @@
98
98
  }
99
99
  },
100
100
  "layers": {
101
- "description": "Distinct layers read, across all backends",
102
101
  "type": "integer",
103
102
  "minimum": 0,
104
- "maximum": 9007199254740991
103
+ "maximum": 9007199254740991,
104
+ "description": "Distinct layers read, across all backends"
105
105
  },
106
106
  "backends": {
107
107
  "type": "array",
@@ -126,34 +126,29 @@
126
126
  }
127
127
  },
128
128
  "notices": {
129
- "description": "What could not be read. Any notice fails the gate: unknown is not passed",
130
129
  "type": "array",
131
130
  "items": {
132
131
  "type": "string"
133
- }
132
+ },
133
+ "description": "What could not be read. Any notice fails the gate: unknown is not passed"
134
134
  },
135
135
  "specsWithoutEvidence": {
136
- "description": "Specs of the outline with no result at all. The outline is `--specs <dir>`, or else the specs the layers recorded",
137
136
  "type": "array",
138
137
  "items": {
139
138
  "type": "string"
140
- }
139
+ },
140
+ "description": "Specs of the outline with no result at all. The outline is `--specs <dir>`, or else the specs the layers recorded"
141
141
  },
142
142
  "specs": {
143
- "description": "The outcome of each spec, so a dashboard needs nothing else",
144
143
  "type": "array",
145
144
  "items": {
146
145
  "type": "object",
147
146
  "properties": {
148
147
  "path": {
149
148
  "description": "Null for checks that name no spec in the outline",
150
- "anyOf": [
151
- {
152
- "type": "string"
153
- },
154
- {
155
- "type": "null"
156
- }
149
+ "type": [
150
+ "string",
151
+ "null"
157
152
  ]
158
153
  },
159
154
  "title": {
@@ -251,22 +246,18 @@
251
246
  "byEnvironment"
252
247
  ],
253
248
  "additionalProperties": {}
254
- }
249
+ },
250
+ "description": "The outcome of each spec, so a dashboard needs nothing else"
255
251
  },
256
252
  "failing": {
257
- "description": "Each slot whose newest completed result failed, or that is still running",
258
253
  "type": "array",
259
254
  "items": {
260
255
  "type": "object",
261
256
  "properties": {
262
257
  "spec": {
263
- "anyOf": [
264
- {
265
- "type": "string"
266
- },
267
- {
268
- "type": "null"
269
- }
258
+ "type": [
259
+ "string",
260
+ "null"
270
261
  ]
271
262
  },
272
263
  "check": {
@@ -283,36 +274,24 @@
283
274
  ]
284
275
  },
285
276
  "environment": {
286
- "anyOf": [
287
- {
288
- "type": "string"
289
- },
290
- {
291
- "type": "null"
292
- }
277
+ "type": [
278
+ "string",
279
+ "null"
293
280
  ]
294
281
  },
295
282
  "producer": {
296
283
  "type": "string"
297
284
  },
298
285
  "branch": {
299
- "anyOf": [
300
- {
301
- "type": "string"
302
- },
303
- {
304
- "type": "null"
305
- }
286
+ "type": [
287
+ "string",
288
+ "null"
306
289
  ]
307
290
  },
308
291
  "sha": {
309
- "anyOf": [
310
- {
311
- "type": "string"
312
- },
313
- {
314
- "type": "null"
315
- }
292
+ "type": [
293
+ "string",
294
+ "null"
316
295
  ]
317
296
  },
318
297
  "layer": {
@@ -322,13 +301,9 @@
322
301
  "type": "string"
323
302
  },
324
303
  "runUrl": {
325
- "anyOf": [
326
- {
327
- "type": "string"
328
- },
329
- {
330
- "type": "null"
331
- }
304
+ "type": [
305
+ "string",
306
+ "null"
332
307
  ]
333
308
  },
334
309
  "detail": {
@@ -350,7 +325,8 @@
350
325
  "detail"
351
326
  ],
352
327
  "additionalProperties": {}
353
- }
328
+ },
329
+ "description": "Each slot whose newest completed result failed, or that is still running"
354
330
  }
355
331
  },
356
332
  "required": [
package/packages/schema/schemas/run-info.schema.json CHANGED
@@ -15,23 +15,15 @@
15
15
  "minimum": 0
16
16
  },
17
17
  "commit": {
18
- "anyOf": [
19
- {
20
- "type": "string"
21
- },
22
- {
23
- "type": "null"
24
- }
18
+ "type": [
19
+ "string",
20
+ "null"
25
21
  ]
26
22
  },
27
23
  "branch": {
28
- "anyOf": [
29
- {
30
- "type": "string"
31
- },
32
- {
33
- "type": "null"
34
- }
24
+ "type": [
25
+ "string",
26
+ "null"
35
27
  ]
36
28
  },
37
29
  "environment": {
@@ -75,13 +67,9 @@
75
67
  },
76
68
  "finishedAt": {
77
69
  "description": "Null while the run is still going; absent in older reports",
78
- "anyOf": [
79
- {
80
- "type": "string"
81
- },
82
- {
83
- "type": "null"
84
- }
70
+ "type": [
71
+ "string",
72
+ "null"
85
73
  ]
86
74
  },
87
75
  "progress": {
package/packages/schema/schemas/run-summary.schema.json CHANGED
@@ -14,23 +14,15 @@
14
14
  "type": "string"
15
15
  },
16
16
  "commit": {
17
- "anyOf": [
18
- {
19
- "type": "string"
20
- },
21
- {
22
- "type": "null"
23
- }
17
+ "type": [
18
+ "string",
19
+ "null"
24
20
  ]
25
21
  },
26
22
  "branch": {
27
- "anyOf": [
28
- {
29
- "type": "string"
30
- },
31
- {
32
- "type": "null"
33
- }
23
+ "type": [
24
+ "string",
25
+ "null"
34
26
  ]
35
27
  },
36
28
  "durationMs": {
package/packages/schema/schemas/server-config.schema.json CHANGED
@@ -7,8 +7,8 @@
7
7
  "type": "string"
8
8
  },
9
9
  "host": {
10
- "description": "Where to listen. 127.0.0.1 keeps it on this machine; 0.0.0.0 is every interface and needs tokens (or `auth.insecure`)",
11
10
  "default": "127.0.0.1",
11
+ "description": "Where to listen. 127.0.0.1 keeps it on this machine; 0.0.0.0 is every interface and needs tokens (or `auth.insecure`)",
12
12
  "type": "string"
13
13
  },
14
14
  "port": {
@@ -18,29 +18,29 @@
18
18
  "maximum": 65535
19
19
  },
20
20
  "data": {
21
- "description": "The folder that is the default backend and the default write target: layers, specs and runs live here",
22
21
  "default": "./atlas-data",
22
+ "description": "The folder that is the default backend and the default write target: layers, specs and runs live here",
23
23
  "type": "string"
24
24
  },
25
25
  "backends": {
26
- "description": "Further backends, read together with the data folder: S3, another server, a device lab",
27
26
  "default": [],
27
+ "description": "Further backends, read together with the data folder: S3, another server, a device lab",
28
28
  "type": "array",
29
29
  "items": {
30
30
  "type": "object",
31
31
  "properties": {
32
32
  "id": {
33
- "description": "Lowercase letters, digits and hyphens. Names where a result came from",
34
33
  "type": "string",
35
- "pattern": "^[a-z0-9-]+$"
34
+ "pattern": "^[a-z0-9-]+$",
35
+ "description": "Lowercase letters, digits and hyphens. Names where a result came from"
36
36
  },
37
37
  "label": {
38
38
  "type": "string"
39
39
  },
40
40
  "url": {
41
- "description": "A folder, s3://bucket/prefix, r2://, gs://, or another Atlas server (https://…)",
42
41
  "type": "string",
43
- "minLength": 1
42
+ "minLength": 1,
43
+ "description": "A folder, s3://bucket/prefix, r2://, gs://, or another Atlas server (https://…)"
44
44
  },
45
45
  "write": {
46
46
  "description": "Uploads go here instead of the data folder. At most one backend is the write target",
@@ -73,18 +73,18 @@
73
73
  "type": "object",
74
74
  "properties": {
75
75
  "name": {
76
- "description": "Shown in logs, never the token itself",
77
76
  "type": "string",
78
- "minLength": 1
77
+ "minLength": 1,
78
+ "description": "Shown in logs, never the token itself"
79
79
  },
80
80
  "role": {
81
- "description": "`read` may look. `publish` may also upload. `admin` may also remove scratch objects",
82
81
  "type": "string",
83
82
  "enum": [
84
83
  "read",
85
84
  "publish",
86
85
  "admin"
87
- ]
86
+ ],
87
+ "description": "`read` may look. `publish` may also upload. `admin` may also remove scratch objects"
88
88
  },
89
89
  "token": {
90
90
  "description": "The token. Prefer `tokenEnv`, so the file holds no secret",
@@ -104,13 +104,13 @@
104
104
  }
105
105
  },
106
106
  "anonymousRead": {
107
- "description": "Let anyone look without a token. Uploading still needs one",
108
107
  "default": false,
108
+ "description": "Let anyone look without a token. Uploading still needs one",
109
109
  "type": "boolean"
110
110
  },
111
111
  "insecure": {
112
- "description": "Allow listening on every interface with no tokens at all",
113
112
  "default": false,
113
+ "description": "Allow listening on every interface with no tokens at all",
114
114
  "type": "boolean"
115
115
  }
116
116
  },
@@ -143,8 +143,8 @@
143
143
  "additionalProperties": false
144
144
  },
145
145
  "refreshSeconds": {
146
- "description": "How often the backends are looked at for layers written by something other than this server",
147
146
  "default": 10,
147
+ "description": "How often the backends are looked at for layers written by something other than this server",
148
148
  "type": "number",
149
149
  "minimum": 1
150
150
  },
@@ -157,20 +157,20 @@
157
157
  "type": "object",
158
158
  "properties": {
159
159
  "maxObjectMiB": {
160
- "description": "The largest object an upload may be",
161
160
  "default": 256,
161
+ "description": "The largest object an upload may be",
162
162
  "type": "number",
163
163
  "exclusiveMinimum": 0
164
164
  },
165
165
  "maxJsonMiB": {
166
- "description": "The largest JSON body (a manifest, a checks request)",
167
166
  "default": 32,
167
+ "description": "The largest JSON body (a manifest, a checks request)",
168
168
  "type": "number",
169
169
  "exclusiveMinimum": 0
170
170
  },
171
171
  "maxStreams": {
172
- "description": "Viewers that may be connected for live updates at once",
173
172
  "default": 500,
173
+ "description": "Viewers that may be connected for live updates at once",
174
174
  "type": "integer",
175
175
  "exclusiveMinimum": 0,
176
176
  "maximum": 9007199254740991
@@ -179,28 +179,28 @@
179
179
  "additionalProperties": false
180
180
  },
181
181
  "runTimeoutSeconds": {
182
- "description": "Interrupt a live run after this many seconds without a producer heartbeat",
183
182
  "default": 30,
183
+ "description": "Interrupt a live run after this many seconds without a producer heartbeat",
184
184
  "type": "number",
185
185
  "minimum": 10,
186
186
  "maximum": 3600
187
187
  },
188
188
  "runStallSeconds": {
189
- "description": "Interrupt after this many seconds without test progress; 0 disables progress expiry",
190
189
  "default": 900,
190
+ "description": "Interrupt after this many seconds without test progress; 0 disables progress expiry",
191
191
  "type": "number",
192
192
  "minimum": 0,
193
193
  "maximum": 86400
194
194
  },
195
195
  "heartbeatSeconds": {
196
- "description": "How often a live connection is touched, so proxies keep it open",
197
196
  "default": 15,
197
+ "description": "How often a live connection is touched, so proxies keep it open",
198
198
  "type": "number",
199
199
  "minimum": 1
200
200
  },
201
201
  "log": {
202
- "description": "One JSON line per request",
203
202
  "default": true,
203
+ "description": "One JSON line per request",
204
204
  "type": "boolean"
205
205
  }
206
206
  },