@tailglow/cli 0.2.1 → 0.4.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.
- package/package.json +1 -1
- package/src/commands.generated.js +959 -197
- package/src/flags.js +1 -0
- package/src/help.js +4 -2
- package/src/output.js +1 -0
- package/src/request.js +1 -0
|
@@ -103,6 +103,91 @@ export const CLI_COMMANDS = [
|
|
|
103
103
|
"query_params": [],
|
|
104
104
|
"body_fields": []
|
|
105
105
|
},
|
|
106
|
+
{
|
|
107
|
+
"resource": "projects",
|
|
108
|
+
"command": "pipeline",
|
|
109
|
+
"operation_id": "getProjectPipeline",
|
|
110
|
+
"summary": "Retrieve Project Pipeline",
|
|
111
|
+
"description": "Retrieve ingest activity across all of a project's servers.",
|
|
112
|
+
"method": "GET",
|
|
113
|
+
"path": "/v1/projects/:project_id/pipeline",
|
|
114
|
+
"alternate_paths": [],
|
|
115
|
+
"scopes": [
|
|
116
|
+
"servers:read"
|
|
117
|
+
],
|
|
118
|
+
"notes": [
|
|
119
|
+
"Includes temporary deployment servers and their archived history. Pending averages valid queued records; throughput counts drained records. Older pending history without record counts is unknown."
|
|
120
|
+
],
|
|
121
|
+
"path_params": [
|
|
122
|
+
{
|
|
123
|
+
"name": "project_id",
|
|
124
|
+
"type": "string",
|
|
125
|
+
"required": true,
|
|
126
|
+
"description": "Unique identifier of the project.",
|
|
127
|
+
"allowed_values": [],
|
|
128
|
+
"deprecated": null
|
|
129
|
+
}
|
|
130
|
+
],
|
|
131
|
+
"query_params": [
|
|
132
|
+
{
|
|
133
|
+
"name": "start_at",
|
|
134
|
+
"type": "ISODateString",
|
|
135
|
+
"required": false,
|
|
136
|
+
"description": "Start time (ISO format, default: 12 hours ago). Optional.",
|
|
137
|
+
"allowed_values": [],
|
|
138
|
+
"deprecated": null
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
"name": "end_at",
|
|
142
|
+
"type": "ISODateString",
|
|
143
|
+
"required": false,
|
|
144
|
+
"description": "End time (ISO format, default: now). Optional.",
|
|
145
|
+
"allowed_values": [],
|
|
146
|
+
"deprecated": null
|
|
147
|
+
},
|
|
148
|
+
{
|
|
149
|
+
"name": "interval",
|
|
150
|
+
"type": "string",
|
|
151
|
+
"required": false,
|
|
152
|
+
"description": "Aggregation interval. Optional. Defaults to `\"minute\"`.",
|
|
153
|
+
"allowed_values": [
|
|
154
|
+
"minute",
|
|
155
|
+
"hour"
|
|
156
|
+
],
|
|
157
|
+
"deprecated": null
|
|
158
|
+
}
|
|
159
|
+
],
|
|
160
|
+
"body_fields": []
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"resource": "projects",
|
|
164
|
+
"command": "pipeline-live",
|
|
165
|
+
"operation_id": "getProjectPipelineLive",
|
|
166
|
+
"summary": "Retrieve Live Project Pipeline",
|
|
167
|
+
"description": "Retrieve the current project queue and ingest totals for the last completed minute.",
|
|
168
|
+
"method": "GET",
|
|
169
|
+
"path": "/v1/projects/:project_id/pipeline/live",
|
|
170
|
+
"alternate_paths": [],
|
|
171
|
+
"scopes": [
|
|
172
|
+
"servers:read"
|
|
173
|
+
],
|
|
174
|
+
"notes": [
|
|
175
|
+
"Includes temporary deployment servers. Queue freshness is independent of heartbeat freshness. Observations taken while queues change return estimated counts from durable records; unreadable observations or unknown write outcomes return null counts.",
|
|
176
|
+
"Throughput and error totals cover the last completed minute. Errors count requests or frames, and totals are null when telemetry is incomplete."
|
|
177
|
+
],
|
|
178
|
+
"path_params": [
|
|
179
|
+
{
|
|
180
|
+
"name": "project_id",
|
|
181
|
+
"type": "string",
|
|
182
|
+
"required": true,
|
|
183
|
+
"description": "Unique identifier of the project.",
|
|
184
|
+
"allowed_values": [],
|
|
185
|
+
"deprecated": null
|
|
186
|
+
}
|
|
187
|
+
],
|
|
188
|
+
"query_params": [],
|
|
189
|
+
"body_fields": []
|
|
190
|
+
},
|
|
106
191
|
{
|
|
107
192
|
"resource": "projects",
|
|
108
193
|
"command": "create",
|
|
@@ -134,14 +219,6 @@ export const CLI_COMMANDS = [
|
|
|
134
219
|
"description": "Date and time when the project began collecting data. Optional.",
|
|
135
220
|
"allowed_values": [],
|
|
136
221
|
"deprecated": null
|
|
137
|
-
},
|
|
138
|
-
{
|
|
139
|
-
"name": "show_onboarding_ui",
|
|
140
|
-
"type": "boolean",
|
|
141
|
-
"required": false,
|
|
142
|
-
"description": "Whether to show the onboarding UI. Optional.",
|
|
143
|
-
"allowed_values": [],
|
|
144
|
-
"deprecated": null
|
|
145
222
|
}
|
|
146
223
|
]
|
|
147
224
|
},
|
|
@@ -186,14 +263,6 @@ export const CLI_COMMANDS = [
|
|
|
186
263
|
"allowed_values": [],
|
|
187
264
|
"deprecated": null
|
|
188
265
|
},
|
|
189
|
-
{
|
|
190
|
-
"name": "show_onboarding_ui",
|
|
191
|
-
"type": "boolean",
|
|
192
|
-
"required": false,
|
|
193
|
-
"description": "Whether to show the onboarding UI. Optional.",
|
|
194
|
-
"allowed_values": [],
|
|
195
|
-
"deprecated": null
|
|
196
|
-
},
|
|
197
266
|
{
|
|
198
267
|
"name": "late_data_window_minutes",
|
|
199
268
|
"type": "integer",
|
|
@@ -556,30 +625,6 @@ export const CLI_COMMANDS = [
|
|
|
556
625
|
"allowed_values": [],
|
|
557
626
|
"deprecated": null
|
|
558
627
|
},
|
|
559
|
-
{
|
|
560
|
-
"name": "bloom_depth",
|
|
561
|
-
"type": "integer",
|
|
562
|
-
"required": false,
|
|
563
|
-
"description": "How many bloom filter layers are built for this source. Optional. Minimum: `1`. Maximum: `10`.",
|
|
564
|
-
"allowed_values": [],
|
|
565
|
-
"deprecated": null
|
|
566
|
-
},
|
|
567
|
-
{
|
|
568
|
-
"name": "schema_promotion_threshold",
|
|
569
|
-
"type": "integer",
|
|
570
|
-
"required": false,
|
|
571
|
-
"description": "How many records are sampled before a provisional schema is promoted. Optional. Minimum: `100`. Maximum: `10000`.",
|
|
572
|
-
"allowed_values": [],
|
|
573
|
-
"deprecated": null
|
|
574
|
-
},
|
|
575
|
-
{
|
|
576
|
-
"name": "provisional_schema_ttl_days",
|
|
577
|
-
"type": "integer",
|
|
578
|
-
"required": false,
|
|
579
|
-
"description": "How long a provisional schema is kept before it is cleaned up. Optional. Minimum: `1`. Maximum: `90`.",
|
|
580
|
-
"allowed_values": [],
|
|
581
|
-
"deprecated": null
|
|
582
|
-
},
|
|
583
628
|
{
|
|
584
629
|
"name": "project_id",
|
|
585
630
|
"type": "string",
|
|
@@ -633,30 +678,6 @@ export const CLI_COMMANDS = [
|
|
|
633
678
|
"allowed_values": [],
|
|
634
679
|
"deprecated": null
|
|
635
680
|
},
|
|
636
|
-
{
|
|
637
|
-
"name": "bloom_depth",
|
|
638
|
-
"type": "integer",
|
|
639
|
-
"required": false,
|
|
640
|
-
"description": "How many bloom filter layers are built for this source. Optional. Minimum: `1`. Maximum: `10`.",
|
|
641
|
-
"allowed_values": [],
|
|
642
|
-
"deprecated": null
|
|
643
|
-
},
|
|
644
|
-
{
|
|
645
|
-
"name": "schema_promotion_threshold",
|
|
646
|
-
"type": "integer",
|
|
647
|
-
"required": false,
|
|
648
|
-
"description": "How many records are sampled before a provisional schema is promoted. Optional. Minimum: `100`. Maximum: `10000`.",
|
|
649
|
-
"allowed_values": [],
|
|
650
|
-
"deprecated": null
|
|
651
|
-
},
|
|
652
|
-
{
|
|
653
|
-
"name": "provisional_schema_ttl_days",
|
|
654
|
-
"type": "integer",
|
|
655
|
-
"required": false,
|
|
656
|
-
"description": "How long a provisional schema is kept before it is cleaned up. Optional. Minimum: `1`. Maximum: `90`.",
|
|
657
|
-
"allowed_values": [],
|
|
658
|
-
"deprecated": null
|
|
659
|
-
},
|
|
660
681
|
{
|
|
661
682
|
"name": "deleted_at",
|
|
662
683
|
"type": "null",
|
|
@@ -741,11 +762,11 @@ export const CLI_COMMANDS = [
|
|
|
741
762
|
"body_fields": []
|
|
742
763
|
},
|
|
743
764
|
{
|
|
744
|
-
"resource": "
|
|
765
|
+
"resource": "ingest_keys",
|
|
745
766
|
"command": "list",
|
|
746
767
|
"operation_id": "listIngestKeys",
|
|
747
768
|
"summary": "List Ingest Keys",
|
|
748
|
-
"description": "Retrieve
|
|
769
|
+
"description": "Retrieve every address that can send records to a source.",
|
|
749
770
|
"method": "GET",
|
|
750
771
|
"path": "/v1/projects/:project_id/sources/:source_id/ingest_keys",
|
|
751
772
|
"alternate_paths": [],
|
|
@@ -789,7 +810,7 @@ export const CLI_COMMANDS = [
|
|
|
789
810
|
"name": "status",
|
|
790
811
|
"type": "IngestKeyStatus",
|
|
791
812
|
"required": false,
|
|
792
|
-
"description": "Filter by
|
|
813
|
+
"description": "Filter by whether the URL still accepts records. Optional.",
|
|
793
814
|
"allowed_values": [
|
|
794
815
|
"active",
|
|
795
816
|
"revoked",
|
|
@@ -801,7 +822,7 @@ export const CLI_COMMANDS = [
|
|
|
801
822
|
"name": "project_id",
|
|
802
823
|
"type": "string",
|
|
803
824
|
"required": false,
|
|
804
|
-
"description": "Filter to
|
|
825
|
+
"description": "Filter to URLs whose source belongs to a project. Optional.",
|
|
805
826
|
"allowed_values": [],
|
|
806
827
|
"deprecated": null
|
|
807
828
|
},
|
|
@@ -809,7 +830,7 @@ export const CLI_COMMANDS = [
|
|
|
809
830
|
"name": "source_id",
|
|
810
831
|
"type": "string",
|
|
811
832
|
"required": false,
|
|
812
|
-
"description": "Filter to
|
|
833
|
+
"description": "Filter to URLs belonging to a single source. Optional.",
|
|
813
834
|
"allowed_values": [],
|
|
814
835
|
"deprecated": null
|
|
815
836
|
},
|
|
@@ -852,7 +873,7 @@ export const CLI_COMMANDS = [
|
|
|
852
873
|
"body_fields": []
|
|
853
874
|
},
|
|
854
875
|
{
|
|
855
|
-
"resource": "
|
|
876
|
+
"resource": "ingest_keys",
|
|
856
877
|
"command": "retrieve",
|
|
857
878
|
"operation_id": "getIngestKey",
|
|
858
879
|
"summary": "Retrieve Ingest Key",
|
|
@@ -894,11 +915,11 @@ export const CLI_COMMANDS = [
|
|
|
894
915
|
"body_fields": []
|
|
895
916
|
},
|
|
896
917
|
{
|
|
897
|
-
"resource": "
|
|
918
|
+
"resource": "ingest_keys",
|
|
898
919
|
"command": "create",
|
|
899
920
|
"operation_id": "createIngestKey",
|
|
900
921
|
"summary": "Create Ingest Key",
|
|
901
|
-
"description": "Create an ingest key for a source.",
|
|
922
|
+
"description": "Create an ingest key for a source. Use this to rotate: create the replacement, deploy it, then delete the old one.",
|
|
902
923
|
"method": "POST",
|
|
903
924
|
"path": "/v1/projects/:project_id/sources/:source_id/ingest_keys",
|
|
904
925
|
"alternate_paths": [],
|
|
@@ -934,18 +955,18 @@ export const CLI_COMMANDS = [
|
|
|
934
955
|
"name": "source_id",
|
|
935
956
|
"type": "string",
|
|
936
957
|
"required": false,
|
|
937
|
-
"description": "Source the
|
|
958
|
+
"description": "Source the URL writes into. Ignored when the nested path supplies it. Optional.",
|
|
938
959
|
"allowed_values": [],
|
|
939
960
|
"deprecated": null
|
|
940
961
|
}
|
|
941
962
|
]
|
|
942
963
|
},
|
|
943
964
|
{
|
|
944
|
-
"resource": "
|
|
965
|
+
"resource": "ingest_keys",
|
|
945
966
|
"command": "delete",
|
|
946
967
|
"operation_id": "deleteIngestKey",
|
|
947
968
|
"summary": "Delete Ingest Key",
|
|
948
|
-
"description": "Delete an ingest key.
|
|
969
|
+
"description": "Delete an ingest key. Records already sent to it are unaffected; the address stops being accepted.",
|
|
949
970
|
"method": "DELETE",
|
|
950
971
|
"path": "/v1/projects/:project_id/sources/:source_id/ingest_keys/:ingest_key_id",
|
|
951
972
|
"alternate_paths": [],
|
|
@@ -1216,6 +1237,135 @@ export const CLI_COMMANDS = [
|
|
|
1216
1237
|
"allowed_values": [],
|
|
1217
1238
|
"deprecated": null
|
|
1218
1239
|
},
|
|
1240
|
+
{
|
|
1241
|
+
"name": "expected_updated_at",
|
|
1242
|
+
"type": "ISODateString",
|
|
1243
|
+
"required": false,
|
|
1244
|
+
"description": "Reject this update if the collection changed since this inspected update time. Optional.",
|
|
1245
|
+
"allowed_values": [],
|
|
1246
|
+
"deprecated": null
|
|
1247
|
+
},
|
|
1248
|
+
{
|
|
1249
|
+
"name": "schema_opaque_paths",
|
|
1250
|
+
"type": "string[][]",
|
|
1251
|
+
"required": false,
|
|
1252
|
+
"description": "Object paths whose contents do not take part in schema identity, each written as its key segments (`[\"metadata\", \"id\"]`). A path that names an array covers its elements and their children. Records that differ only inside an opaque path share one schema version; the raw values are still stored. Changing this re-keys the collection. Optional.",
|
|
1253
|
+
"allowed_values": [],
|
|
1254
|
+
"deprecated": null
|
|
1255
|
+
},
|
|
1256
|
+
{
|
|
1257
|
+
"name": "schema_tracked_paths",
|
|
1258
|
+
"type": "string[][]",
|
|
1259
|
+
"required": false,
|
|
1260
|
+
"description": "Children of opaque paths that stay part of schema identity, written like `schema_opaque_paths`. Changing this re-keys the collection. Optional.",
|
|
1261
|
+
"allowed_values": [],
|
|
1262
|
+
"deprecated": null
|
|
1263
|
+
},
|
|
1264
|
+
{
|
|
1265
|
+
"name": "schema_max_depth",
|
|
1266
|
+
"type": "integer",
|
|
1267
|
+
"required": false,
|
|
1268
|
+
"description": "How many levels of nesting take part in schema identity. Changing this re-keys the collection. Optional. Minimum: `1`. Maximum: `10`.",
|
|
1269
|
+
"allowed_values": [],
|
|
1270
|
+
"deprecated": null
|
|
1271
|
+
},
|
|
1272
|
+
{
|
|
1273
|
+
"name": "schema_nulls",
|
|
1274
|
+
"type": "string",
|
|
1275
|
+
"required": false,
|
|
1276
|
+
"description": "`auto` accepts null and absent values at any path a mapping reads; `manual` waits for a person to approve each nullable input per view. Optional.",
|
|
1277
|
+
"allowed_values": [
|
|
1278
|
+
"auto",
|
|
1279
|
+
"manual"
|
|
1280
|
+
],
|
|
1281
|
+
"deprecated": null
|
|
1282
|
+
},
|
|
1283
|
+
{
|
|
1284
|
+
"name": "schema_optional_keys",
|
|
1285
|
+
"type": "string",
|
|
1286
|
+
"required": false,
|
|
1287
|
+
"description": "`auto` lets a record whose keys are a subset of a version's keys join that version; `manual` treats every absent key as a different shape. Optional.",
|
|
1288
|
+
"allowed_values": [
|
|
1289
|
+
"auto",
|
|
1290
|
+
"manual"
|
|
1291
|
+
],
|
|
1292
|
+
"deprecated": null
|
|
1293
|
+
},
|
|
1294
|
+
{
|
|
1295
|
+
"name": "schema_detector",
|
|
1296
|
+
"type": "string",
|
|
1297
|
+
"required": false,
|
|
1298
|
+
"description": "`auto` applies a safe opaque-path proposal from the detector on its own; `manual` holds every proposal for a person. Optional.",
|
|
1299
|
+
"allowed_values": [
|
|
1300
|
+
"auto",
|
|
1301
|
+
"manual"
|
|
1302
|
+
],
|
|
1303
|
+
"deprecated": null
|
|
1304
|
+
},
|
|
1305
|
+
{
|
|
1306
|
+
"name": "schema_recurrence_gap_ms",
|
|
1307
|
+
"type": "integer",
|
|
1308
|
+
"required": false,
|
|
1309
|
+
"description": "How long after first sight a shape must be seen again before its version settles, in milliseconds. Optional. Minimum: `60000`. Maximum: `604800000`.",
|
|
1310
|
+
"allowed_values": [],
|
|
1311
|
+
"deprecated": null
|
|
1312
|
+
},
|
|
1313
|
+
{
|
|
1314
|
+
"name": "schema_bulk_rows",
|
|
1315
|
+
"type": "integer",
|
|
1316
|
+
"required": false,
|
|
1317
|
+
"description": "A single batch carrying at least this many rows of a shape settles its version immediately. `0` disables the bulk path. Optional. Minimum: `0`. Maximum: `1000000`.",
|
|
1318
|
+
"allowed_values": [],
|
|
1319
|
+
"deprecated": null
|
|
1320
|
+
},
|
|
1321
|
+
{
|
|
1322
|
+
"name": "schema_stale_after_ms",
|
|
1323
|
+
"type": "integer",
|
|
1324
|
+
"required": false,
|
|
1325
|
+
"description": "How long a candidate version waits to be seen again before it goes stale, in milliseconds. Optional. Minimum: `3600000`. Maximum: `7776000000`.",
|
|
1326
|
+
"allowed_values": [],
|
|
1327
|
+
"deprecated": null
|
|
1328
|
+
},
|
|
1329
|
+
{
|
|
1330
|
+
"name": "schema_identity_limit",
|
|
1331
|
+
"type": "integer",
|
|
1332
|
+
"required": false,
|
|
1333
|
+
"description": "How many settled schema versions the collection may hold. Past it, new shapes stay unclassified with their signatures kept. Optional. Minimum: `1`. Maximum: `4096`.",
|
|
1334
|
+
"allowed_values": [],
|
|
1335
|
+
"deprecated": null
|
|
1336
|
+
},
|
|
1337
|
+
{
|
|
1338
|
+
"name": "schema_candidate_pool",
|
|
1339
|
+
"type": "integer",
|
|
1340
|
+
"required": false,
|
|
1341
|
+
"description": "How many candidate and stale versions the collection may hold. Past it, new shapes stay unclassified. Optional. Minimum: `1`. Maximum: `8192`.",
|
|
1342
|
+
"allowed_values": [],
|
|
1343
|
+
"deprecated": null
|
|
1344
|
+
},
|
|
1345
|
+
{
|
|
1346
|
+
"name": "schema_alias_pool",
|
|
1347
|
+
"type": "integer",
|
|
1348
|
+
"required": false,
|
|
1349
|
+
"description": "How many exact signature hashes the collection remembers for fast lookup. Past it, a new hash is still resolved but not cached. Optional. Minimum: `16`. Maximum: `100000`.",
|
|
1350
|
+
"allowed_values": [],
|
|
1351
|
+
"deprecated": null
|
|
1352
|
+
},
|
|
1353
|
+
{
|
|
1354
|
+
"name": "schema_writer_limit",
|
|
1355
|
+
"type": "integer",
|
|
1356
|
+
"required": false,
|
|
1357
|
+
"description": "How many collection files one ingest batch may open for this collection. Shapes past the candidate pool get the same number of files per batch, the shapes with the most rows first; the rows of shapes past that budget stay unclassified and cannot be linked to a version later. Optional. Minimum: `1`. Maximum: `256`.",
|
|
1358
|
+
"allowed_values": [],
|
|
1359
|
+
"deprecated": null
|
|
1360
|
+
},
|
|
1361
|
+
{
|
|
1362
|
+
"name": "schema_unclassified_retention_days",
|
|
1363
|
+
"type": "integer | null",
|
|
1364
|
+
"required": false,
|
|
1365
|
+
"description": "How many days rows without a settled schema version are kept before they are deleted. `null` keeps them forever. Optional.",
|
|
1366
|
+
"allowed_values": [],
|
|
1367
|
+
"deprecated": null
|
|
1368
|
+
},
|
|
1219
1369
|
{
|
|
1220
1370
|
"name": "deleted_at",
|
|
1221
1371
|
"type": "null",
|
|
@@ -1304,7 +1454,7 @@ export const CLI_COMMANDS = [
|
|
|
1304
1454
|
"command": "list-schemas",
|
|
1305
1455
|
"operation_id": "listCollectionSchemas",
|
|
1306
1456
|
"summary": "List Collection Schemas",
|
|
1307
|
-
"description": "Retrieve the
|
|
1457
|
+
"description": "Retrieve the schema versions for a collection.",
|
|
1308
1458
|
"method": "GET",
|
|
1309
1459
|
"path": "/v1/projects/:project_id/collections/:collection_id/schemas",
|
|
1310
1460
|
"alternate_paths": [],
|
|
@@ -1312,6 +1462,7 @@ export const CLI_COMMANDS = [
|
|
|
1312
1462
|
"sources:read"
|
|
1313
1463
|
],
|
|
1314
1464
|
"notes": [
|
|
1465
|
+
"`state` is `candidate` from first sight, `settled` once the shape recurs or arrives in bulk, and `stale` when a candidate is not seen again. Only a settled version is offered to views for authoring.",
|
|
1315
1466
|
"`after` and `before` are mutually exclusive."
|
|
1316
1467
|
],
|
|
1317
1468
|
"path_params": [
|
|
@@ -1332,46 +1483,212 @@ export const CLI_COMMANDS = [
|
|
|
1332
1483
|
"deprecated": null
|
|
1333
1484
|
}
|
|
1334
1485
|
],
|
|
1335
|
-
"query_params": [
|
|
1336
|
-
"body_fields": []
|
|
1337
|
-
},
|
|
1338
|
-
{
|
|
1339
|
-
"resource": "collections",
|
|
1340
|
-
"command": "list-provisional-schemas",
|
|
1341
|
-
"operation_id": "listCollectionProvisionalSchemas",
|
|
1342
|
-
"summary": "List Provisional Schemas",
|
|
1343
|
-
"description": "Retrieve the schemas seen but not yet promoted for a collection.",
|
|
1344
|
-
"method": "GET",
|
|
1345
|
-
"path": "/v1/projects/:project_id/collections/:collection_id/provisional_schemas",
|
|
1346
|
-
"alternate_paths": [],
|
|
1347
|
-
"scopes": [
|
|
1348
|
-
"sources:read"
|
|
1349
|
-
],
|
|
1350
|
-
"notes": [
|
|
1351
|
-
"A provisional schema is promoted once enough records match it, and cleaned up if it goes stale first. Both thresholds are set on the collection's source.",
|
|
1352
|
-
"`after` and `before` are mutually exclusive."
|
|
1353
|
-
],
|
|
1354
|
-
"path_params": [
|
|
1486
|
+
"query_params": [
|
|
1355
1487
|
{
|
|
1356
|
-
"name": "
|
|
1488
|
+
"name": "limit",
|
|
1489
|
+
"type": "number",
|
|
1490
|
+
"required": false,
|
|
1491
|
+
"description": "Maximum number of items to return. Optional. Defaults to `25`. Minimum: `1`. Maximum: `200`.",
|
|
1492
|
+
"allowed_values": [],
|
|
1493
|
+
"deprecated": null
|
|
1494
|
+
},
|
|
1495
|
+
{
|
|
1496
|
+
"name": "after",
|
|
1357
1497
|
"type": "string",
|
|
1358
|
-
"required":
|
|
1359
|
-
"description": "
|
|
1498
|
+
"required": false,
|
|
1499
|
+
"description": "Cursor from `pagination.next_cursor` of a previous response. Returns the resources after that page. Optional.",
|
|
1360
1500
|
"allowed_values": [],
|
|
1361
1501
|
"deprecated": null
|
|
1362
1502
|
},
|
|
1363
1503
|
{
|
|
1364
|
-
"name": "
|
|
1504
|
+
"name": "before",
|
|
1365
1505
|
"type": "string",
|
|
1366
|
-
"required":
|
|
1367
|
-
"description": "
|
|
1506
|
+
"required": false,
|
|
1507
|
+
"description": "Cursor from `pagination.prev_cursor` of a previous response. Returns the resources before that page. Optional.",
|
|
1368
1508
|
"allowed_values": [],
|
|
1369
1509
|
"deprecated": null
|
|
1370
|
-
}
|
|
1371
|
-
|
|
1372
|
-
|
|
1510
|
+
},
|
|
1511
|
+
{
|
|
1512
|
+
"name": "sort",
|
|
1513
|
+
"type": "string",
|
|
1514
|
+
"required": false,
|
|
1515
|
+
"description": "Sort direction for the result set. Optional. Defaults to `\"desc\"`.",
|
|
1516
|
+
"allowed_values": [
|
|
1517
|
+
"asc",
|
|
1518
|
+
"desc"
|
|
1519
|
+
],
|
|
1520
|
+
"deprecated": null
|
|
1521
|
+
},
|
|
1522
|
+
{
|
|
1523
|
+
"name": "state",
|
|
1524
|
+
"type": "string",
|
|
1525
|
+
"required": false,
|
|
1526
|
+
"description": "Return only schema versions in this state. Optional.",
|
|
1527
|
+
"allowed_values": [
|
|
1528
|
+
"candidate",
|
|
1529
|
+
"settled",
|
|
1530
|
+
"stale"
|
|
1531
|
+
],
|
|
1532
|
+
"deprecated": null
|
|
1533
|
+
}
|
|
1534
|
+
],
|
|
1535
|
+
"body_fields": []
|
|
1536
|
+
},
|
|
1537
|
+
{
|
|
1538
|
+
"resource": "collections",
|
|
1539
|
+
"command": "update-schema",
|
|
1540
|
+
"operation_id": "updateCollectionSchema",
|
|
1541
|
+
"summary": "Update Collection Schema",
|
|
1542
|
+
"description": "Settle a schema version by hand, so views can author against it before its shape recurs.",
|
|
1543
|
+
"method": "POST",
|
|
1544
|
+
"path": "/v1/projects/:project_id/collections/:collection_id/schemas/:schema_version_id",
|
|
1545
|
+
"alternate_paths": [],
|
|
1546
|
+
"scopes": [
|
|
1547
|
+
"sources:write"
|
|
1548
|
+
],
|
|
1549
|
+
"notes": [
|
|
1550
|
+
"`state` accepts only `settled`; a settled version never returns to candidate or stale.",
|
|
1551
|
+
"A version that is already settled is left as it is and responds with `request_no_update`."
|
|
1552
|
+
],
|
|
1553
|
+
"path_params": [
|
|
1554
|
+
{
|
|
1555
|
+
"name": "project_id",
|
|
1556
|
+
"type": "string",
|
|
1557
|
+
"required": true,
|
|
1558
|
+
"description": "Unique identifier of the project.",
|
|
1559
|
+
"allowed_values": [],
|
|
1560
|
+
"deprecated": null
|
|
1561
|
+
},
|
|
1562
|
+
{
|
|
1563
|
+
"name": "collection_id",
|
|
1564
|
+
"type": "string",
|
|
1565
|
+
"required": true,
|
|
1566
|
+
"description": "Unique identifier of the collection.",
|
|
1567
|
+
"allowed_values": [],
|
|
1568
|
+
"deprecated": null
|
|
1569
|
+
},
|
|
1570
|
+
{
|
|
1571
|
+
"name": "schema_version_id",
|
|
1572
|
+
"type": "string",
|
|
1573
|
+
"required": true,
|
|
1574
|
+
"description": "Unique identifier of the schema.",
|
|
1575
|
+
"allowed_values": [],
|
|
1576
|
+
"deprecated": null
|
|
1577
|
+
}
|
|
1578
|
+
],
|
|
1579
|
+
"query_params": [],
|
|
1580
|
+
"body_fields": [
|
|
1581
|
+
{
|
|
1582
|
+
"name": "state",
|
|
1583
|
+
"type": "string",
|
|
1584
|
+
"required": true,
|
|
1585
|
+
"description": "The only state a person sets. `settled` trusts the version for view authoring now, without waiting for its shape to recur; a settled version never goes back.",
|
|
1586
|
+
"allowed_values": [
|
|
1587
|
+
"settled"
|
|
1588
|
+
],
|
|
1589
|
+
"deprecated": null
|
|
1590
|
+
}
|
|
1591
|
+
]
|
|
1592
|
+
},
|
|
1593
|
+
{
|
|
1594
|
+
"resource": "collections",
|
|
1595
|
+
"command": "retrieve-schema-report",
|
|
1596
|
+
"operation_id": "getCollectionSchemaReport",
|
|
1597
|
+
"summary": "Retrieve Collection Schema Report",
|
|
1598
|
+
"description": "Retrieve the detector's view of a collection: the opaque paths it proposes, whether the top-level keys are data, and how many shapes sit unclassified past the collection's pools.",
|
|
1599
|
+
"method": "GET",
|
|
1600
|
+
"path": "/v1/projects/:project_id/collections/:collection_id/schema_report",
|
|
1601
|
+
"alternate_paths": [],
|
|
1602
|
+
"scopes": [
|
|
1603
|
+
"sources:read"
|
|
1604
|
+
],
|
|
1605
|
+
"notes": [
|
|
1606
|
+
"A proposal a bound mapping reads inside is reported and never applied on its own, whatever the detector switch; apply it by adding its path to the collection's `schema_opaque_paths` and its tracked children to `schema_tracked_paths`.",
|
|
1607
|
+
"`shapes.before` and `shapes.after` are equal here; the preview is where they differ."
|
|
1608
|
+
],
|
|
1609
|
+
"path_params": [
|
|
1610
|
+
{
|
|
1611
|
+
"name": "project_id",
|
|
1612
|
+
"type": "string",
|
|
1613
|
+
"required": true,
|
|
1614
|
+
"description": "Unique identifier of the project.",
|
|
1615
|
+
"allowed_values": [],
|
|
1616
|
+
"deprecated": null
|
|
1617
|
+
},
|
|
1618
|
+
{
|
|
1619
|
+
"name": "collection_id",
|
|
1620
|
+
"type": "string",
|
|
1621
|
+
"required": true,
|
|
1622
|
+
"description": "Unique identifier of the collection.",
|
|
1623
|
+
"allowed_values": [],
|
|
1624
|
+
"deprecated": null
|
|
1625
|
+
}
|
|
1626
|
+
],
|
|
1627
|
+
"query_params": [],
|
|
1373
1628
|
"body_fields": []
|
|
1374
1629
|
},
|
|
1630
|
+
{
|
|
1631
|
+
"resource": "collections",
|
|
1632
|
+
"command": "preview-schema-rules",
|
|
1633
|
+
"operation_id": "previewCollectionSchemaRules",
|
|
1634
|
+
"summary": "Preview Collection Schema Rules",
|
|
1635
|
+
"description": "Preview a rule change: the schema report the collection would read under the rules sent, with how many shapes it holds now and how many it would hold. Nothing is changed.",
|
|
1636
|
+
"method": "POST",
|
|
1637
|
+
"path": "/v1/projects/:project_id/collections/:collection_id/schema_preview",
|
|
1638
|
+
"alternate_paths": [],
|
|
1639
|
+
"scopes": [
|
|
1640
|
+
"sources:read"
|
|
1641
|
+
],
|
|
1642
|
+
"notes": [
|
|
1643
|
+
"A rule left out of the body keeps the collection's current value.",
|
|
1644
|
+
"`shapes.before` counts the shapes under the collection's current rules and `shapes.after` under the rules sent; the difference is what updating the collection with those rules would merge."
|
|
1645
|
+
],
|
|
1646
|
+
"path_params": [
|
|
1647
|
+
{
|
|
1648
|
+
"name": "project_id",
|
|
1649
|
+
"type": "string",
|
|
1650
|
+
"required": true,
|
|
1651
|
+
"description": "Unique identifier of the project.",
|
|
1652
|
+
"allowed_values": [],
|
|
1653
|
+
"deprecated": null
|
|
1654
|
+
},
|
|
1655
|
+
{
|
|
1656
|
+
"name": "collection_id",
|
|
1657
|
+
"type": "string",
|
|
1658
|
+
"required": true,
|
|
1659
|
+
"description": "Unique identifier of the collection.",
|
|
1660
|
+
"allowed_values": [],
|
|
1661
|
+
"deprecated": null
|
|
1662
|
+
}
|
|
1663
|
+
],
|
|
1664
|
+
"query_params": [],
|
|
1665
|
+
"body_fields": [
|
|
1666
|
+
{
|
|
1667
|
+
"name": "schema_opaque_paths",
|
|
1668
|
+
"type": "string[][]",
|
|
1669
|
+
"required": false,
|
|
1670
|
+
"description": "Opaque paths to preview, written like the collection's `schema_opaque_paths`. Omitted, the collection's current opaque paths apply. Optional.",
|
|
1671
|
+
"allowed_values": [],
|
|
1672
|
+
"deprecated": null
|
|
1673
|
+
},
|
|
1674
|
+
{
|
|
1675
|
+
"name": "schema_tracked_paths",
|
|
1676
|
+
"type": "string[][]",
|
|
1677
|
+
"required": false,
|
|
1678
|
+
"description": "Tracked paths to preview, written like the collection's `schema_tracked_paths`. Omitted, the collection's current tracked paths apply. Optional.",
|
|
1679
|
+
"allowed_values": [],
|
|
1680
|
+
"deprecated": null
|
|
1681
|
+
},
|
|
1682
|
+
{
|
|
1683
|
+
"name": "schema_max_depth",
|
|
1684
|
+
"type": "integer",
|
|
1685
|
+
"required": false,
|
|
1686
|
+
"description": "Max depth to preview. Omitted, the collection's current max depth applies. Optional. Minimum: `1`. Maximum: `10`.",
|
|
1687
|
+
"allowed_values": [],
|
|
1688
|
+
"deprecated": null
|
|
1689
|
+
}
|
|
1690
|
+
]
|
|
1691
|
+
},
|
|
1375
1692
|
{
|
|
1376
1693
|
"resource": "collections",
|
|
1377
1694
|
"command": "list-docs",
|
|
@@ -1594,14 +1911,6 @@ export const CLI_COMMANDS = [
|
|
|
1594
1911
|
"allowed_values": [],
|
|
1595
1912
|
"deprecated": null
|
|
1596
1913
|
},
|
|
1597
|
-
{
|
|
1598
|
-
"name": "description",
|
|
1599
|
-
"type": "string | null",
|
|
1600
|
-
"required": false,
|
|
1601
|
-
"description": "Description of the view. Optional.",
|
|
1602
|
-
"allowed_values": [],
|
|
1603
|
-
"deprecated": null
|
|
1604
|
-
},
|
|
1605
1914
|
{
|
|
1606
1915
|
"name": "output_schema",
|
|
1607
1916
|
"type": "object[]",
|
|
@@ -1618,6 +1927,14 @@ export const CLI_COMMANDS = [
|
|
|
1618
1927
|
"allowed_values": [],
|
|
1619
1928
|
"deprecated": null
|
|
1620
1929
|
},
|
|
1930
|
+
{
|
|
1931
|
+
"name": "mapping_policy",
|
|
1932
|
+
"type": "object",
|
|
1933
|
+
"required": false,
|
|
1934
|
+
"description": "Optional.",
|
|
1935
|
+
"allowed_values": [],
|
|
1936
|
+
"deprecated": null
|
|
1937
|
+
},
|
|
1621
1938
|
{
|
|
1622
1939
|
"name": "project_id",
|
|
1623
1940
|
"type": "string",
|
|
@@ -1652,7 +1969,7 @@ export const CLI_COMMANDS = [
|
|
|
1652
1969
|
},
|
|
1653
1970
|
{
|
|
1654
1971
|
"name": "transform_mode",
|
|
1655
|
-
"type": "
|
|
1972
|
+
"type": "string",
|
|
1656
1973
|
"required": false,
|
|
1657
1974
|
"description": "Whether a new schema version that no existing transform covers gets a script generated for it, or waits for you to write one. Defaults to auto. Optional.",
|
|
1658
1975
|
"allowed_values": [
|
|
@@ -1704,14 +2021,6 @@ export const CLI_COMMANDS = [
|
|
|
1704
2021
|
"allowed_values": [],
|
|
1705
2022
|
"deprecated": null
|
|
1706
2023
|
},
|
|
1707
|
-
{
|
|
1708
|
-
"name": "description",
|
|
1709
|
-
"type": "string",
|
|
1710
|
-
"required": false,
|
|
1711
|
-
"description": "What this join view is for. Optional. Maximum length: `2048`.",
|
|
1712
|
-
"allowed_values": [],
|
|
1713
|
-
"deprecated": null
|
|
1714
|
-
},
|
|
1715
2024
|
{
|
|
1716
2025
|
"name": "project_id",
|
|
1717
2026
|
"type": "string",
|
|
@@ -1767,7 +2076,7 @@ export const CLI_COMMANDS = [
|
|
|
1767
2076
|
"command": "update",
|
|
1768
2077
|
"operation_id": "updateView",
|
|
1769
2078
|
"summary": "Update View",
|
|
1770
|
-
"description": "Update a view's name
|
|
2079
|
+
"description": "Update a view's name or output schema.",
|
|
1771
2080
|
"method": "POST",
|
|
1772
2081
|
"path": "/v1/projects/:project_id/views/:view_id",
|
|
1773
2082
|
"alternate_paths": [],
|
|
@@ -1775,7 +2084,8 @@ export const CLI_COMMANDS = [
|
|
|
1775
2084
|
"views:write"
|
|
1776
2085
|
],
|
|
1777
2086
|
"notes": [
|
|
1778
|
-
"
|
|
2087
|
+
"Output schema changes are accepted only before a mapping or stored output exists. Changing an existing view's output schema requires a recovery transition that is not yet supported.",
|
|
2088
|
+
"Mapping policy changes on an existing mapping require reviewed coverage recovery. Hint changes preserve accepted mappings and retry undecided work with the new hint.",
|
|
1779
2089
|
"What a view reads from is fixed at creation, so `collection_id` and `parent_view_id` are not accepted here. Create a new view to read from something else.",
|
|
1780
2090
|
"`output_schema` field names must be unique by name, cannot conflict on type, and cannot collide with a reserved query key such as `limit` or `cursor`.",
|
|
1781
2091
|
"Use `hint` for rules the generator cannot read off the field names: a formatting rule (\"display_name should be Name (Type)\"), a business threshold (\"classify as high above 500\"), or a disambiguation when a source field could map more than one way. Skip it for obvious mappings like renames and type conversions, which the generator already handles."
|
|
@@ -1801,18 +2111,18 @@ export const CLI_COMMANDS = [
|
|
|
1801
2111
|
"query_params": [],
|
|
1802
2112
|
"body_fields": [
|
|
1803
2113
|
{
|
|
1804
|
-
"name": "
|
|
1805
|
-
"type": "
|
|
2114
|
+
"name": "mapping_policy",
|
|
2115
|
+
"type": "object",
|
|
1806
2116
|
"required": false,
|
|
1807
|
-
"description": "
|
|
2117
|
+
"description": "Optional.",
|
|
1808
2118
|
"allowed_values": [],
|
|
1809
2119
|
"deprecated": null
|
|
1810
2120
|
},
|
|
1811
2121
|
{
|
|
1812
|
-
"name": "
|
|
1813
|
-
"type": "string
|
|
2122
|
+
"name": "name",
|
|
2123
|
+
"type": "string",
|
|
1814
2124
|
"required": false,
|
|
1815
|
-
"description": "
|
|
2125
|
+
"description": "Name for the view. Optional. Minimum length: `1`. Maximum length: `128`.",
|
|
1816
2126
|
"allowed_values": [],
|
|
1817
2127
|
"deprecated": null
|
|
1818
2128
|
},
|
|
@@ -1834,7 +2144,7 @@ export const CLI_COMMANDS = [
|
|
|
1834
2144
|
},
|
|
1835
2145
|
{
|
|
1836
2146
|
"name": "transform_mode",
|
|
1837
|
-
"type": "
|
|
2147
|
+
"type": "string",
|
|
1838
2148
|
"required": false,
|
|
1839
2149
|
"description": "Whether a new schema version that no existing transform covers gets a script generated for it, or waits for you to write one. Optional.",
|
|
1840
2150
|
"allowed_values": [
|
|
@@ -1875,7 +2185,7 @@ export const CLI_COMMANDS = [
|
|
|
1875
2185
|
],
|
|
1876
2186
|
"notes": [
|
|
1877
2187
|
"Views derived from this one are deleted with it.",
|
|
1878
|
-
"The delete is refused while an active drain reads from this view or from any view that would cascade with it. Delete
|
|
2188
|
+
"The delete is refused while an active drain reads from this view or from any view that would cascade with it. Delete those drains first. Draft drains are removed silently.",
|
|
1879
2189
|
"Backfill and indexing work for the whole cascade is cancelled immediately, so a deleted view stops consuming capacity before its rows are removed."
|
|
1880
2190
|
],
|
|
1881
2191
|
"path_params": [
|
|
@@ -1920,15 +2230,240 @@ export const CLI_COMMANDS = [
|
|
|
1920
2230
|
"name": "project_id",
|
|
1921
2231
|
"type": "string",
|
|
1922
2232
|
"required": true,
|
|
1923
|
-
"description": "Unique identifier of the project.",
|
|
2233
|
+
"description": "Unique identifier of the project.",
|
|
2234
|
+
"allowed_values": [],
|
|
2235
|
+
"deprecated": null
|
|
2236
|
+
},
|
|
2237
|
+
{
|
|
2238
|
+
"name": "view_id",
|
|
2239
|
+
"type": "string",
|
|
2240
|
+
"required": true,
|
|
2241
|
+
"description": "Unique identifier of the view.",
|
|
2242
|
+
"allowed_values": [],
|
|
2243
|
+
"deprecated": null
|
|
2244
|
+
}
|
|
2245
|
+
],
|
|
2246
|
+
"query_params": [],
|
|
2247
|
+
"body_fields": []
|
|
2248
|
+
},
|
|
2249
|
+
{
|
|
2250
|
+
"resource": "views",
|
|
2251
|
+
"command": "list-records",
|
|
2252
|
+
"operation_id": "listViewRecords",
|
|
2253
|
+
"summary": "List View Records",
|
|
2254
|
+
"description": "Retrieve the transformed records a view has produced.",
|
|
2255
|
+
"method": "GET",
|
|
2256
|
+
"path": "/v1/projects/:project_id/views/:view_id/records",
|
|
2257
|
+
"alternate_paths": [],
|
|
2258
|
+
"scopes": [
|
|
2259
|
+
"views:read"
|
|
2260
|
+
],
|
|
2261
|
+
"notes": [
|
|
2262
|
+
"Records are only filterable on fields that have a facet. Filtering on any other field is rejected, so create a facet for a field before querying it.",
|
|
2263
|
+
"Paging is forward-only. Pass `pagination.next_cursor` back as `after` to get the next page; a null `next_cursor` means there is nothing more to read. No `prev_cursor` is issued, and `before` is ignored.",
|
|
2264
|
+
"A cursor is only valid for the query that produced it. Changing the sort direction, the filter, or (on a filtered read) the time range and reusing an older cursor returns a 400 rather than a page of skipped or repeated records, so start again without a cursor after any of those change.",
|
|
2265
|
+
"`start_at` and `end_at` narrow a filtered read only. An unfiltered read returns the view's records regardless of the window, so pass a facet filter when you need a time-bounded result.",
|
|
2266
|
+
"A cursor stays valid while Tailglow reorganizes stored data in the background, so a paging client is never interrupted by storage maintenance. It is a position in this result set, not a snapshot: records that arrive while you page appear only if they sort after your position.",
|
|
2267
|
+
"`after` and `before` are mutually exclusive."
|
|
2268
|
+
],
|
|
2269
|
+
"path_params": [
|
|
2270
|
+
{
|
|
2271
|
+
"name": "project_id",
|
|
2272
|
+
"type": "string",
|
|
2273
|
+
"required": true,
|
|
2274
|
+
"description": "Unique identifier of the project.",
|
|
2275
|
+
"allowed_values": [],
|
|
2276
|
+
"deprecated": null
|
|
2277
|
+
},
|
|
2278
|
+
{
|
|
2279
|
+
"name": "view_id",
|
|
2280
|
+
"type": "string",
|
|
2281
|
+
"required": true,
|
|
2282
|
+
"description": "Unique identifier of the view.",
|
|
2283
|
+
"allowed_values": [],
|
|
2284
|
+
"deprecated": null
|
|
2285
|
+
}
|
|
2286
|
+
],
|
|
2287
|
+
"query_params": [],
|
|
2288
|
+
"body_fields": []
|
|
2289
|
+
},
|
|
2290
|
+
{
|
|
2291
|
+
"resource": "views",
|
|
2292
|
+
"command": "list-deferrals",
|
|
2293
|
+
"operation_id": "listViewDeferrals",
|
|
2294
|
+
"summary": "List Waiting Shapes",
|
|
2295
|
+
"description": "Retrieve the event shapes a view has deferred because no transform serves them yet.",
|
|
2296
|
+
"method": "GET",
|
|
2297
|
+
"path": "/v1/projects/:project_id/views/:view_id/deferrals",
|
|
2298
|
+
"alternate_paths": [],
|
|
2299
|
+
"scopes": [
|
|
2300
|
+
"views:read"
|
|
2301
|
+
],
|
|
2302
|
+
"notes": [
|
|
2303
|
+
"Deferred records are stored, not lost. They backfill automatically once a script covers the shape, and each entry's `reason` says what unblocks it.",
|
|
2304
|
+
"`event_count` is approximate: ingest retries can count an event more than once.",
|
|
2305
|
+
"`after` and `before` are mutually exclusive."
|
|
2306
|
+
],
|
|
2307
|
+
"path_params": [
|
|
2308
|
+
{
|
|
2309
|
+
"name": "project_id",
|
|
2310
|
+
"type": "string",
|
|
2311
|
+
"required": true,
|
|
2312
|
+
"description": "Unique identifier of the project.",
|
|
2313
|
+
"allowed_values": [],
|
|
2314
|
+
"deprecated": null
|
|
2315
|
+
},
|
|
2316
|
+
{
|
|
2317
|
+
"name": "view_id",
|
|
2318
|
+
"type": "string",
|
|
2319
|
+
"required": true,
|
|
2320
|
+
"description": "Unique identifier of the view.",
|
|
2321
|
+
"allowed_values": [],
|
|
2322
|
+
"deprecated": null
|
|
2323
|
+
}
|
|
2324
|
+
],
|
|
2325
|
+
"query_params": [
|
|
2326
|
+
{
|
|
2327
|
+
"name": "resolved",
|
|
2328
|
+
"type": "string",
|
|
2329
|
+
"required": false,
|
|
2330
|
+
"description": "Filter by resolution. `false` returns only shapes still waiting. Optional.",
|
|
2331
|
+
"allowed_values": [
|
|
2332
|
+
"true",
|
|
2333
|
+
"false"
|
|
2334
|
+
],
|
|
2335
|
+
"deprecated": null
|
|
2336
|
+
},
|
|
2337
|
+
{
|
|
2338
|
+
"name": "order_by",
|
|
2339
|
+
"type": "string",
|
|
2340
|
+
"required": false,
|
|
2341
|
+
"description": "Sort field. Defaults to `last_deferred_at`. Optional.",
|
|
2342
|
+
"allowed_values": [
|
|
2343
|
+
"first_deferred_at",
|
|
2344
|
+
"last_deferred_at"
|
|
2345
|
+
],
|
|
2346
|
+
"deprecated": null
|
|
2347
|
+
},
|
|
2348
|
+
{
|
|
2349
|
+
"name": "limit",
|
|
2350
|
+
"type": "number",
|
|
2351
|
+
"required": false,
|
|
2352
|
+
"description": "Maximum number of items to return. Optional. Defaults to `25`. Minimum: `1`. Maximum: `200`.",
|
|
2353
|
+
"allowed_values": [],
|
|
2354
|
+
"deprecated": null
|
|
2355
|
+
},
|
|
2356
|
+
{
|
|
2357
|
+
"name": "after",
|
|
2358
|
+
"type": "string",
|
|
2359
|
+
"required": false,
|
|
2360
|
+
"description": "Cursor from `pagination.next_cursor` of a previous response. Returns the resources after that page. Optional.",
|
|
2361
|
+
"allowed_values": [],
|
|
2362
|
+
"deprecated": null
|
|
2363
|
+
},
|
|
2364
|
+
{
|
|
2365
|
+
"name": "before",
|
|
2366
|
+
"type": "string",
|
|
2367
|
+
"required": false,
|
|
2368
|
+
"description": "Cursor from `pagination.prev_cursor` of a previous response. Returns the resources before that page. Optional.",
|
|
2369
|
+
"allowed_values": [],
|
|
2370
|
+
"deprecated": null
|
|
2371
|
+
},
|
|
2372
|
+
{
|
|
2373
|
+
"name": "sort",
|
|
2374
|
+
"type": "string",
|
|
2375
|
+
"required": false,
|
|
2376
|
+
"description": "Sort direction for the result set. Optional. Defaults to `\"desc\"`.",
|
|
2377
|
+
"allowed_values": [
|
|
2378
|
+
"asc",
|
|
2379
|
+
"desc"
|
|
2380
|
+
],
|
|
2381
|
+
"deprecated": null
|
|
2382
|
+
}
|
|
2383
|
+
],
|
|
2384
|
+
"body_fields": []
|
|
2385
|
+
},
|
|
2386
|
+
{
|
|
2387
|
+
"resource": "views",
|
|
2388
|
+
"command": "inspect-deferral",
|
|
2389
|
+
"operation_id": "inspectViewDeferral",
|
|
2390
|
+
"summary": "Inspect Waiting Shape",
|
|
2391
|
+
"description": "Inspect structural differences and candidate output bindings for a waiting shape.",
|
|
2392
|
+
"method": "GET",
|
|
2393
|
+
"path": "/v1/projects/:project_id/views/:view_id/deferrals/:deferral_id",
|
|
2394
|
+
"alternate_paths": [],
|
|
2395
|
+
"scopes": [
|
|
2396
|
+
"views:read"
|
|
2397
|
+
],
|
|
2398
|
+
"notes": [],
|
|
2399
|
+
"path_params": [
|
|
2400
|
+
{
|
|
2401
|
+
"name": "project_id",
|
|
2402
|
+
"type": "string",
|
|
2403
|
+
"required": true,
|
|
2404
|
+
"description": "Unique identifier of the project.",
|
|
2405
|
+
"allowed_values": [],
|
|
2406
|
+
"deprecated": null
|
|
2407
|
+
},
|
|
2408
|
+
{
|
|
2409
|
+
"name": "view_id",
|
|
2410
|
+
"type": "string",
|
|
2411
|
+
"required": true,
|
|
2412
|
+
"description": "Unique identifier of the view.",
|
|
2413
|
+
"allowed_values": [],
|
|
2414
|
+
"deprecated": null
|
|
2415
|
+
},
|
|
2416
|
+
{
|
|
2417
|
+
"name": "deferral_id",
|
|
2418
|
+
"type": "string",
|
|
2419
|
+
"required": true,
|
|
2420
|
+
"description": "Unique identifier of the deferral.",
|
|
2421
|
+
"allowed_values": [],
|
|
2422
|
+
"deprecated": null
|
|
2423
|
+
}
|
|
2424
|
+
],
|
|
2425
|
+
"query_params": [],
|
|
2426
|
+
"body_fields": []
|
|
2427
|
+
},
|
|
2428
|
+
{
|
|
2429
|
+
"resource": "views",
|
|
2430
|
+
"command": "retrieve-deferral-hint",
|
|
2431
|
+
"operation_id": "retrieveViewDeferralHint",
|
|
2432
|
+
"summary": "Retrieve Waiting Shape Hint",
|
|
2433
|
+
"description": "Retrieve the model's current binding question for a waiting shape.",
|
|
2434
|
+
"method": "GET",
|
|
2435
|
+
"path": "/v1/projects/:project_id/views/:view_id/deferrals/:deferral_id/hint",
|
|
2436
|
+
"alternate_paths": [],
|
|
2437
|
+
"scopes": [
|
|
2438
|
+
"views:read",
|
|
2439
|
+
"sources:read"
|
|
2440
|
+
],
|
|
2441
|
+
"notes": [
|
|
2442
|
+
"Requires both views:read and sources:read because model prose may refer to source records. Suggested paths are verified source fields in unambiguous JSON bracket notation.",
|
|
2443
|
+
"Returns null when no current question remains. Answer using this question's episode, mapping_generation, requested_at, and transform_id."
|
|
2444
|
+
],
|
|
2445
|
+
"path_params": [
|
|
2446
|
+
{
|
|
2447
|
+
"name": "project_id",
|
|
2448
|
+
"type": "string",
|
|
2449
|
+
"required": true,
|
|
2450
|
+
"description": "Unique identifier of the project.",
|
|
2451
|
+
"allowed_values": [],
|
|
2452
|
+
"deprecated": null
|
|
2453
|
+
},
|
|
2454
|
+
{
|
|
2455
|
+
"name": "view_id",
|
|
2456
|
+
"type": "string",
|
|
2457
|
+
"required": true,
|
|
2458
|
+
"description": "Unique identifier of the view.",
|
|
1924
2459
|
"allowed_values": [],
|
|
1925
2460
|
"deprecated": null
|
|
1926
2461
|
},
|
|
1927
2462
|
{
|
|
1928
|
-
"name": "
|
|
2463
|
+
"name": "deferral_id",
|
|
1929
2464
|
"type": "string",
|
|
1930
2465
|
"required": true,
|
|
1931
|
-
"description": "Unique identifier of the
|
|
2466
|
+
"description": "Unique identifier of the deferral.",
|
|
1932
2467
|
"allowed_values": [],
|
|
1933
2468
|
"deprecated": null
|
|
1934
2469
|
}
|
|
@@ -1938,23 +2473,20 @@ export const CLI_COMMANDS = [
|
|
|
1938
2473
|
},
|
|
1939
2474
|
{
|
|
1940
2475
|
"resource": "views",
|
|
1941
|
-
"command": "
|
|
1942
|
-
"operation_id": "
|
|
1943
|
-
"summary": "
|
|
1944
|
-
"description": "
|
|
1945
|
-
"method": "
|
|
1946
|
-
"path": "/v1/projects/:project_id/views/:view_id/
|
|
2476
|
+
"command": "decide-deferral",
|
|
2477
|
+
"operation_id": "decideViewDeferral",
|
|
2478
|
+
"summary": "Decide Waiting Shape",
|
|
2479
|
+
"description": "Resolve the next action for one view and schema version.",
|
|
2480
|
+
"method": "POST",
|
|
2481
|
+
"path": "/v1/projects/:project_id/views/:view_id/deferrals/:deferral_id/decision",
|
|
1947
2482
|
"alternate_paths": [],
|
|
1948
2483
|
"scopes": [
|
|
1949
|
-
"views:
|
|
2484
|
+
"views:write"
|
|
1950
2485
|
],
|
|
1951
2486
|
"notes": [
|
|
1952
|
-
"
|
|
1953
|
-
"
|
|
1954
|
-
"
|
|
1955
|
-
"`start_at` and `end_at` narrow a filtered read only. An unfiltered read returns the view's records regardless of the window, so pass a facet filter when you need a time-bounded result.",
|
|
1956
|
-
"A cursor stays valid while Tailglow reorganizes stored data in the background, so a paging client is never interrupted by storage maintenance. It is a position in this result set, not a snapshot: records that arrive while you page appear only if they sort after your position.",
|
|
1957
|
-
"`after` and `before` are mutually exclusive."
|
|
2487
|
+
"Authoring and hint answers reserve a bounded model budget. Exclusion covers unprocessed and future records of this exact version in this view.",
|
|
2488
|
+
"Answering a hint requires `hint`; excluding a version requires `reason`. Exclusion covers unprocessed and future records with this exact schema version in this view.",
|
|
2489
|
+
"Answering a pending model question also requires its exact `hint_requested_at` and `hint_transform_id`. Superseded or answered questions return a conflict; manual guidance without a pending question may omit both fields."
|
|
1958
2490
|
],
|
|
1959
2491
|
"path_params": [
|
|
1960
2492
|
{
|
|
@@ -1972,26 +2504,101 @@ export const CLI_COMMANDS = [
|
|
|
1972
2504
|
"description": "Unique identifier of the view.",
|
|
1973
2505
|
"allowed_values": [],
|
|
1974
2506
|
"deprecated": null
|
|
2507
|
+
},
|
|
2508
|
+
{
|
|
2509
|
+
"name": "deferral_id",
|
|
2510
|
+
"type": "string",
|
|
2511
|
+
"required": true,
|
|
2512
|
+
"description": "Unique identifier of the deferral.",
|
|
2513
|
+
"allowed_values": [],
|
|
2514
|
+
"deprecated": null
|
|
1975
2515
|
}
|
|
1976
2516
|
],
|
|
1977
2517
|
"query_params": [],
|
|
1978
|
-
"body_fields": [
|
|
2518
|
+
"body_fields": [
|
|
2519
|
+
{
|
|
2520
|
+
"name": "episode",
|
|
2521
|
+
"type": "integer",
|
|
2522
|
+
"required": true,
|
|
2523
|
+
"description": "The deferral episode shown when the decision was inspected. Minimum: `1`.",
|
|
2524
|
+
"allowed_values": [],
|
|
2525
|
+
"deprecated": null
|
|
2526
|
+
},
|
|
2527
|
+
{
|
|
2528
|
+
"name": "action",
|
|
2529
|
+
"type": "string",
|
|
2530
|
+
"required": true,
|
|
2531
|
+
"description": "Authorize a bounded authoring attempt, answer a hint, or exclude this exact version in this view.",
|
|
2532
|
+
"allowed_values": [
|
|
2533
|
+
"author",
|
|
2534
|
+
"hint",
|
|
2535
|
+
"exclude"
|
|
2536
|
+
],
|
|
2537
|
+
"deprecated": null
|
|
2538
|
+
},
|
|
2539
|
+
{
|
|
2540
|
+
"name": "mapping_generation",
|
|
2541
|
+
"type": "integer",
|
|
2542
|
+
"required": true,
|
|
2543
|
+
"description": "The mapping generation shown when the decision was inspected. Minimum: `1`.",
|
|
2544
|
+
"allowed_values": [],
|
|
2545
|
+
"deprecated": null
|
|
2546
|
+
},
|
|
2547
|
+
{
|
|
2548
|
+
"name": "hint",
|
|
2549
|
+
"type": "string",
|
|
2550
|
+
"required": false,
|
|
2551
|
+
"description": "Answer to the model's binding question. Optional. Minimum length: `1`. Maximum length: `4096`.",
|
|
2552
|
+
"allowed_values": [],
|
|
2553
|
+
"deprecated": null
|
|
2554
|
+
},
|
|
2555
|
+
{
|
|
2556
|
+
"name": "hint_requested_at",
|
|
2557
|
+
"type": "ISODateString",
|
|
2558
|
+
"required": false,
|
|
2559
|
+
"description": "Exact requested_at of the pending hint being answered. Optional.",
|
|
2560
|
+
"allowed_values": [],
|
|
2561
|
+
"deprecated": null
|
|
2562
|
+
},
|
|
2563
|
+
{
|
|
2564
|
+
"name": "hint_transform_id",
|
|
2565
|
+
"type": "string",
|
|
2566
|
+
"required": false,
|
|
2567
|
+
"description": "Transform that owns the pending hint being answered. Optional. Minimum length: `1`. Maximum length: `32`.",
|
|
2568
|
+
"allowed_values": [],
|
|
2569
|
+
"deprecated": null
|
|
2570
|
+
},
|
|
2571
|
+
{
|
|
2572
|
+
"name": "reason",
|
|
2573
|
+
"type": "string",
|
|
2574
|
+
"required": false,
|
|
2575
|
+
"description": "Required audit reason for an exclusion. Optional. Minimum length: `1`. Maximum length: `2000`.",
|
|
2576
|
+
"allowed_values": [],
|
|
2577
|
+
"deprecated": null
|
|
2578
|
+
},
|
|
2579
|
+
{
|
|
2580
|
+
"name": "mapping_policy",
|
|
2581
|
+
"type": "object",
|
|
2582
|
+
"required": false,
|
|
2583
|
+
"description": "Explicit null, fallback, drop, and source-binding rules. Optional.",
|
|
2584
|
+
"allowed_values": [],
|
|
2585
|
+
"deprecated": null
|
|
2586
|
+
}
|
|
2587
|
+
]
|
|
1979
2588
|
},
|
|
1980
2589
|
{
|
|
1981
2590
|
"resource": "views",
|
|
1982
|
-
"command": "list-
|
|
1983
|
-
"operation_id": "
|
|
1984
|
-
"summary": "List
|
|
1985
|
-
"description": "Retrieve
|
|
2591
|
+
"command": "list-transforms",
|
|
2592
|
+
"operation_id": "listViewTransforms",
|
|
2593
|
+
"summary": "List View Transforms",
|
|
2594
|
+
"description": "Retrieve a list of a view's transforms.",
|
|
1986
2595
|
"method": "GET",
|
|
1987
|
-
"path": "/v1/projects/:project_id/views/:view_id/
|
|
2596
|
+
"path": "/v1/projects/:project_id/views/:view_id/transforms",
|
|
1988
2597
|
"alternate_paths": [],
|
|
1989
2598
|
"scopes": [
|
|
1990
2599
|
"views:read"
|
|
1991
2600
|
],
|
|
1992
2601
|
"notes": [
|
|
1993
|
-
"Deferred records are stored, not lost. They backfill automatically once a script covers the shape, and each entry's `reason` says what unblocks it.",
|
|
1994
|
-
"`event_count` is approximate: ingest retries can count an event more than once.",
|
|
1995
2602
|
"`after` and `before` are mutually exclusive."
|
|
1996
2603
|
],
|
|
1997
2604
|
"path_params": [
|
|
@@ -2014,24 +2621,27 @@ export const CLI_COMMANDS = [
|
|
|
2014
2621
|
],
|
|
2015
2622
|
"query_params": [
|
|
2016
2623
|
{
|
|
2017
|
-
"name": "
|
|
2624
|
+
"name": "order_by",
|
|
2018
2625
|
"type": "string",
|
|
2019
2626
|
"required": false,
|
|
2020
|
-
"description": "
|
|
2627
|
+
"description": "Field the results are sorted by. Creation order matches schema version order. Optional. Defaults to `\"created_at\"`.",
|
|
2021
2628
|
"allowed_values": [
|
|
2022
|
-
"
|
|
2023
|
-
"
|
|
2629
|
+
"created_at",
|
|
2630
|
+
"updated_at"
|
|
2024
2631
|
],
|
|
2025
2632
|
"deprecated": null
|
|
2026
2633
|
},
|
|
2027
2634
|
{
|
|
2028
|
-
"name": "
|
|
2029
|
-
"type": "
|
|
2635
|
+
"name": "status",
|
|
2636
|
+
"type": "ViewTransformStatus",
|
|
2030
2637
|
"required": false,
|
|
2031
|
-
"description": "
|
|
2638
|
+
"description": "Return only transforms in this state. Optional.",
|
|
2032
2639
|
"allowed_values": [
|
|
2033
|
-
"
|
|
2034
|
-
"
|
|
2640
|
+
"queued",
|
|
2641
|
+
"analyzing",
|
|
2642
|
+
"active",
|
|
2643
|
+
"error",
|
|
2644
|
+
"draft"
|
|
2035
2645
|
],
|
|
2036
2646
|
"deprecated": null
|
|
2037
2647
|
},
|
|
@@ -2039,7 +2649,7 @@ export const CLI_COMMANDS = [
|
|
|
2039
2649
|
"name": "limit",
|
|
2040
2650
|
"type": "number",
|
|
2041
2651
|
"required": false,
|
|
2042
|
-
"description": "
|
|
2652
|
+
"description": "Optional. Defaults to `25`. Minimum: `1`. Maximum: `200`.",
|
|
2043
2653
|
"allowed_values": [],
|
|
2044
2654
|
"deprecated": null
|
|
2045
2655
|
},
|
|
@@ -2063,7 +2673,7 @@ export const CLI_COMMANDS = [
|
|
|
2063
2673
|
"name": "sort",
|
|
2064
2674
|
"type": "string",
|
|
2065
2675
|
"required": false,
|
|
2066
|
-
"description": "
|
|
2676
|
+
"description": "Optional. Defaults to `\"asc\"`.",
|
|
2067
2677
|
"allowed_values": [
|
|
2068
2678
|
"asc",
|
|
2069
2679
|
"desc"
|
|
@@ -2075,17 +2685,61 @@ export const CLI_COMMANDS = [
|
|
|
2075
2685
|
},
|
|
2076
2686
|
{
|
|
2077
2687
|
"resource": "views",
|
|
2078
|
-
"command": "
|
|
2079
|
-
"operation_id": "
|
|
2080
|
-
"summary": "
|
|
2081
|
-
"description": "Retrieve a
|
|
2688
|
+
"command": "retrieve-transform",
|
|
2689
|
+
"operation_id": "getViewTransform",
|
|
2690
|
+
"summary": "Retrieve View Transform",
|
|
2691
|
+
"description": "Retrieve a single transform.",
|
|
2082
2692
|
"method": "GET",
|
|
2083
|
-
"path": "/v1/projects/:project_id/views/:view_id/transforms",
|
|
2693
|
+
"path": "/v1/projects/:project_id/views/:view_id/transforms/:transform_id",
|
|
2694
|
+
"alternate_paths": [],
|
|
2695
|
+
"scopes": [
|
|
2696
|
+
"views:read"
|
|
2697
|
+
],
|
|
2698
|
+
"notes": [],
|
|
2699
|
+
"path_params": [
|
|
2700
|
+
{
|
|
2701
|
+
"name": "project_id",
|
|
2702
|
+
"type": "string",
|
|
2703
|
+
"required": true,
|
|
2704
|
+
"description": "Unique identifier of the project.",
|
|
2705
|
+
"allowed_values": [],
|
|
2706
|
+
"deprecated": null
|
|
2707
|
+
},
|
|
2708
|
+
{
|
|
2709
|
+
"name": "view_id",
|
|
2710
|
+
"type": "string",
|
|
2711
|
+
"required": true,
|
|
2712
|
+
"description": "Unique identifier of the view.",
|
|
2713
|
+
"allowed_values": [],
|
|
2714
|
+
"deprecated": null
|
|
2715
|
+
},
|
|
2716
|
+
{
|
|
2717
|
+
"name": "transform_id",
|
|
2718
|
+
"type": "string",
|
|
2719
|
+
"required": true,
|
|
2720
|
+
"description": "Unique identifier of the transform.",
|
|
2721
|
+
"allowed_values": [],
|
|
2722
|
+
"deprecated": null
|
|
2723
|
+
}
|
|
2724
|
+
],
|
|
2725
|
+
"query_params": [],
|
|
2726
|
+
"body_fields": []
|
|
2727
|
+
},
|
|
2728
|
+
{
|
|
2729
|
+
"resource": "views",
|
|
2730
|
+
"command": "list-versions",
|
|
2731
|
+
"operation_id": "listViewVersions",
|
|
2732
|
+
"summary": "List View Versions",
|
|
2733
|
+
"description": "Retrieve a list of the schema versions a view covers.",
|
|
2734
|
+
"method": "GET",
|
|
2735
|
+
"path": "/v1/projects/:project_id/views/:view_id/versions",
|
|
2084
2736
|
"alternate_paths": [],
|
|
2085
2737
|
"scopes": [
|
|
2086
2738
|
"views:read"
|
|
2087
2739
|
],
|
|
2088
2740
|
"notes": [
|
|
2741
|
+
"One row per source schema version the view covers, newest version first. A view that reads another view has no schema versions, so its list is empty.",
|
|
2742
|
+
"Versions sharing a `script_hash` run the same transform. Filter by it to see every version one script serves.",
|
|
2089
2743
|
"`after` and `before` are mutually exclusive."
|
|
2090
2744
|
],
|
|
2091
2745
|
"path_params": [
|
|
@@ -2111,10 +2765,9 @@ export const CLI_COMMANDS = [
|
|
|
2111
2765
|
"name": "order_by",
|
|
2112
2766
|
"type": "string",
|
|
2113
2767
|
"required": false,
|
|
2114
|
-
"description": "Field the results are sorted by.
|
|
2768
|
+
"description": "Field the results are sorted by. Optional. Defaults to `\"version\"`.",
|
|
2115
2769
|
"allowed_values": [
|
|
2116
|
-
"
|
|
2117
|
-
"updated_at"
|
|
2770
|
+
"version"
|
|
2118
2771
|
],
|
|
2119
2772
|
"deprecated": null
|
|
2120
2773
|
},
|
|
@@ -2122,7 +2775,7 @@ export const CLI_COMMANDS = [
|
|
|
2122
2775
|
"name": "status",
|
|
2123
2776
|
"type": "ViewTransformStatus",
|
|
2124
2777
|
"required": false,
|
|
2125
|
-
"description": "Return only
|
|
2778
|
+
"description": "Return only versions whose transform is in this state. Optional.",
|
|
2126
2779
|
"allowed_values": [
|
|
2127
2780
|
"queued",
|
|
2128
2781
|
"analyzing",
|
|
@@ -2132,11 +2785,19 @@ export const CLI_COMMANDS = [
|
|
|
2132
2785
|
],
|
|
2133
2786
|
"deprecated": null
|
|
2134
2787
|
},
|
|
2788
|
+
{
|
|
2789
|
+
"name": "script_hash",
|
|
2790
|
+
"type": "string",
|
|
2791
|
+
"required": false,
|
|
2792
|
+
"description": "Return only versions served by this script. Take the value from a version's row. Optional. Minimum length: `64`. Maximum length: `64`.",
|
|
2793
|
+
"allowed_values": [],
|
|
2794
|
+
"deprecated": null
|
|
2795
|
+
},
|
|
2135
2796
|
{
|
|
2136
2797
|
"name": "limit",
|
|
2137
2798
|
"type": "number",
|
|
2138
2799
|
"required": false,
|
|
2139
|
-
"description": "Optional. Defaults to `25`. Minimum: `1`. Maximum: `200`.",
|
|
2800
|
+
"description": "Maximum number of items to return. Optional. Defaults to `25`. Minimum: `1`. Maximum: `200`.",
|
|
2140
2801
|
"allowed_values": [],
|
|
2141
2802
|
"deprecated": null
|
|
2142
2803
|
},
|
|
@@ -2160,7 +2821,7 @@ export const CLI_COMMANDS = [
|
|
|
2160
2821
|
"name": "sort",
|
|
2161
2822
|
"type": "string",
|
|
2162
2823
|
"required": false,
|
|
2163
|
-
"description": "Optional. Defaults to `\"
|
|
2824
|
+
"description": "Sort direction for the result set. Optional. Defaults to `\"desc\"`.",
|
|
2164
2825
|
"allowed_values": [
|
|
2165
2826
|
"asc",
|
|
2166
2827
|
"desc"
|
|
@@ -2172,17 +2833,19 @@ export const CLI_COMMANDS = [
|
|
|
2172
2833
|
},
|
|
2173
2834
|
{
|
|
2174
2835
|
"resource": "views",
|
|
2175
|
-
"command": "retrieve-
|
|
2176
|
-
"operation_id": "
|
|
2177
|
-
"summary": "Retrieve View
|
|
2178
|
-
"description": "Retrieve a
|
|
2836
|
+
"command": "retrieve-version",
|
|
2837
|
+
"operation_id": "getViewVersion",
|
|
2838
|
+
"summary": "Retrieve View Version",
|
|
2839
|
+
"description": "Retrieve one schema version a view covers.",
|
|
2179
2840
|
"method": "GET",
|
|
2180
|
-
"path": "/v1/projects/:project_id/views/:view_id/
|
|
2841
|
+
"path": "/v1/projects/:project_id/views/:view_id/versions/:version_id",
|
|
2181
2842
|
"alternate_paths": [],
|
|
2182
2843
|
"scopes": [
|
|
2183
2844
|
"views:read"
|
|
2184
2845
|
],
|
|
2185
|
-
"notes": [
|
|
2846
|
+
"notes": [
|
|
2847
|
+
"`version_id` is the schema version NUMBER, the `version` a row carries, not a `vta_` id."
|
|
2848
|
+
],
|
|
2186
2849
|
"path_params": [
|
|
2187
2850
|
{
|
|
2188
2851
|
"name": "project_id",
|
|
@@ -2201,10 +2864,10 @@ export const CLI_COMMANDS = [
|
|
|
2201
2864
|
"deprecated": null
|
|
2202
2865
|
},
|
|
2203
2866
|
{
|
|
2204
|
-
"name": "
|
|
2867
|
+
"name": "version_id",
|
|
2205
2868
|
"type": "string",
|
|
2206
2869
|
"required": true,
|
|
2207
|
-
"description": "Unique identifier of the
|
|
2870
|
+
"description": "Unique identifier of the version.",
|
|
2208
2871
|
"allowed_values": [],
|
|
2209
2872
|
"deprecated": null
|
|
2210
2873
|
}
|
|
@@ -2287,7 +2950,7 @@ export const CLI_COMMANDS = [
|
|
|
2287
2950
|
"Conflicting versions are moved to queued placeholders by default. Set `conflict_resolution` to `keep` to leave those versions on their prior script.",
|
|
2288
2951
|
"Removing an output field is rejected while a metric, facet, child view, or join clause reads it. Consumer checks use the complete nested output path. Records already produced keep their existing values until the transform is re-backfilled.",
|
|
2289
2952
|
"Set `dry_run` to preview the per-version verdict report without saving. A dry run changes nothing and triggers nothing, and returns a `preview_token` alongside the report.",
|
|
2290
|
-
"Saving requires the `preview_token` from that dry run. It pins the save to the set of schema versions the report described, so a version
|
|
2953
|
+
"Saving requires the `preview_token` from that dry run. It pins the save to the set of schema versions the report described, so a version added or reassigned between the preview and the save cannot be silently included.",
|
|
2291
2954
|
"A save with a missing or outdated token is rejected with 409 and changes nothing. The error carries the report as it stands now, so the next preview is already in hand.",
|
|
2292
2955
|
"`transform_script` cannot be whitespace-only. To clear a script and have it regenerated, use the regenerate endpoint rather than sending an empty one.",
|
|
2293
2956
|
"Saving is a two-step gesture: send `dry_run` to get the report and its `preview_token`, then send the same edit with that token. A save without one, or with a token whose set has since changed, is rejected with 409 and a fresh report."
|
|
@@ -2574,6 +3237,14 @@ export const CLI_COMMANDS = [
|
|
|
2574
3237
|
}
|
|
2575
3238
|
],
|
|
2576
3239
|
"query_params": [
|
|
3240
|
+
{
|
|
3241
|
+
"name": "view_id",
|
|
3242
|
+
"type": "string",
|
|
3243
|
+
"required": false,
|
|
3244
|
+
"description": "Return metrics that read from this view. Optional.",
|
|
3245
|
+
"allowed_values": [],
|
|
3246
|
+
"deprecated": null
|
|
3247
|
+
},
|
|
2577
3248
|
{
|
|
2578
3249
|
"name": "order_by",
|
|
2579
3250
|
"type": "string",
|
|
@@ -2677,7 +3348,9 @@ export const CLI_COMMANDS = [
|
|
|
2677
3348
|
"metrics:read"
|
|
2678
3349
|
],
|
|
2679
3350
|
"notes": [
|
|
2680
|
-
"`
|
|
3351
|
+
"`last` returns the latest reading in each time bucket within the requested range.",
|
|
3352
|
+
"`coverage_mode=observed` returns partial observed rows beyond the strict boundary without filling missing buckets. `coverage_reasons` names unresolved view scopes; `excluded` is informational.",
|
|
3353
|
+
"Record keys are UTC bucket starts. A bucket is final only when its UTC calendar end (start plus one `interval`) is at or before `complete_through_at`; strict omits all other buckets. A null cutoff means unknown completeness. Observed may include populated partial buckets even when the requested end lies inside one, and does not synthesize empty partial buckets.",
|
|
2681
3354
|
"The aggregation window is resolved in order: an explicit `start_at` plus `end_at` wins; otherwise `time_range` is used; otherwise the metric's saved chart range is used.",
|
|
2682
3355
|
"`start_at` and `end_at` only take effect when sent together. Sending one without the other has no effect on the window.",
|
|
2683
3356
|
"When both are provided, `start_at` must be earlier than `end_at`.",
|
|
@@ -2703,6 +3376,17 @@ export const CLI_COMMANDS = [
|
|
|
2703
3376
|
}
|
|
2704
3377
|
],
|
|
2705
3378
|
"query_params": [
|
|
3379
|
+
{
|
|
3380
|
+
"name": "coverage_mode",
|
|
3381
|
+
"type": "string",
|
|
3382
|
+
"required": false,
|
|
3383
|
+
"description": "Strict returns only final data. Observed includes partial data beyond complete_through_at without filling missing buckets. Optional. Defaults to `\"strict\"`.",
|
|
3384
|
+
"allowed_values": [
|
|
3385
|
+
"strict",
|
|
3386
|
+
"observed"
|
|
3387
|
+
],
|
|
3388
|
+
"deprecated": null
|
|
3389
|
+
},
|
|
2706
3390
|
{
|
|
2707
3391
|
"name": "start_at",
|
|
2708
3392
|
"type": "ISODateString",
|
|
@@ -2833,7 +3517,8 @@ export const CLI_COMMANDS = [
|
|
|
2833
3517
|
"Custom chart ranges require both dates, with an interval of at least 30 minutes.",
|
|
2834
3518
|
"Color-mode configuration must match the selected chart color mode.",
|
|
2835
3519
|
"`filters` must be a valid filter expression.",
|
|
2836
|
-
"`timestamp_field` cannot reference `__meta__` metadata."
|
|
3520
|
+
"`timestamp_field` cannot reference `__meta__` metadata.",
|
|
3521
|
+
"`group_by_display_fields` is set at create and cannot be changed afterwards, because each series takes its label from the first record it sees. Map a `group_by` field to a view field that carries a readable value for the same record."
|
|
2837
3522
|
],
|
|
2838
3523
|
"path_params": [
|
|
2839
3524
|
{
|
|
@@ -2871,6 +3556,14 @@ export const CLI_COMMANDS = [
|
|
|
2871
3556
|
"allowed_values": [],
|
|
2872
3557
|
"deprecated": null
|
|
2873
3558
|
},
|
|
3559
|
+
{
|
|
3560
|
+
"name": "group_by_display_fields",
|
|
3561
|
+
"type": "object | null",
|
|
3562
|
+
"required": false,
|
|
3563
|
+
"description": "Maps a field in `group_by` to another view field whose value labels the series, so a chart grouped on an opaque id reads as `api.example.com` instead of `chk_a1b2c3`. Each label is read from the first record of a series and kept from then on. Optional.",
|
|
3564
|
+
"allowed_values": [],
|
|
3565
|
+
"deprecated": null
|
|
3566
|
+
},
|
|
2874
3567
|
{
|
|
2875
3568
|
"name": "filters",
|
|
2876
3569
|
"type": "string",
|
|
@@ -4949,6 +5642,22 @@ export const CLI_COMMANDS = [
|
|
|
4949
5642
|
"allowed_values": [],
|
|
4950
5643
|
"deprecated": null
|
|
4951
5644
|
},
|
|
5645
|
+
{
|
|
5646
|
+
"name": "public_ui_show_trends",
|
|
5647
|
+
"type": "boolean",
|
|
5648
|
+
"required": false,
|
|
5649
|
+
"description": "Whether trend lines enabled on each metric are shown on the public page. Defaults to true. Optional.",
|
|
5650
|
+
"allowed_values": [],
|
|
5651
|
+
"deprecated": null
|
|
5652
|
+
},
|
|
5653
|
+
{
|
|
5654
|
+
"name": "public_ui_show_forecast",
|
|
5655
|
+
"type": "boolean",
|
|
5656
|
+
"required": false,
|
|
5657
|
+
"description": "Whether forecasts enabled on each metric are shown on the public page. Defaults to true. Optional.",
|
|
5658
|
+
"allowed_values": [],
|
|
5659
|
+
"deprecated": null
|
|
5660
|
+
},
|
|
4952
5661
|
{
|
|
4953
5662
|
"name": "access_code",
|
|
4954
5663
|
"type": "string | null",
|
|
@@ -5082,6 +5791,22 @@ export const CLI_COMMANDS = [
|
|
|
5082
5791
|
"allowed_values": [],
|
|
5083
5792
|
"deprecated": null
|
|
5084
5793
|
},
|
|
5794
|
+
{
|
|
5795
|
+
"name": "public_ui_show_trends",
|
|
5796
|
+
"type": "boolean",
|
|
5797
|
+
"required": false,
|
|
5798
|
+
"description": "Whether trend lines enabled on each metric are shown on the public page. Defaults to true. Optional.",
|
|
5799
|
+
"allowed_values": [],
|
|
5800
|
+
"deprecated": null
|
|
5801
|
+
},
|
|
5802
|
+
{
|
|
5803
|
+
"name": "public_ui_show_forecast",
|
|
5804
|
+
"type": "boolean",
|
|
5805
|
+
"required": false,
|
|
5806
|
+
"description": "Whether forecasts enabled on each metric are shown on the public page. Defaults to true. Optional.",
|
|
5807
|
+
"allowed_values": [],
|
|
5808
|
+
"deprecated": null
|
|
5809
|
+
},
|
|
5085
5810
|
{
|
|
5086
5811
|
"name": "access_code",
|
|
5087
5812
|
"type": "string | null",
|
|
@@ -5665,6 +6390,36 @@ export const CLI_COMMANDS = [
|
|
|
5665
6390
|
"query_params": [],
|
|
5666
6391
|
"body_fields": []
|
|
5667
6392
|
},
|
|
6393
|
+
{
|
|
6394
|
+
"resource": "teams",
|
|
6395
|
+
"command": "billing",
|
|
6396
|
+
"operation_id": "getTeamBilling",
|
|
6397
|
+
"summary": "Retrieve Team Billing",
|
|
6398
|
+
"description": "Retrieve the team's current billing summary.",
|
|
6399
|
+
"method": "GET",
|
|
6400
|
+
"path": "/v1/teams/:team_id/billing",
|
|
6401
|
+
"alternate_paths": [],
|
|
6402
|
+
"scopes": [
|
|
6403
|
+
"billing:read"
|
|
6404
|
+
],
|
|
6405
|
+
"notes": [
|
|
6406
|
+
"Requires `billing:read` and credentials scoped to this team. Every response includes accrued and projected charges, stored and available promotional credits, and server usage.",
|
|
6407
|
+
"Available credits account for uninvoiced usage, including the preceding month before its invoice is saved. Reading this summary does not consume credits or create an invoice.",
|
|
6408
|
+
"Amounts exclude tax and credit notes applied at payment. Projections assume current usage continues; the final invoice can differ."
|
|
6409
|
+
],
|
|
6410
|
+
"path_params": [
|
|
6411
|
+
{
|
|
6412
|
+
"name": "team_id",
|
|
6413
|
+
"type": "string",
|
|
6414
|
+
"required": true,
|
|
6415
|
+
"description": "Unique identifier of the team.",
|
|
6416
|
+
"allowed_values": [],
|
|
6417
|
+
"deprecated": null
|
|
6418
|
+
}
|
|
6419
|
+
],
|
|
6420
|
+
"query_params": [],
|
|
6421
|
+
"body_fields": []
|
|
6422
|
+
},
|
|
5668
6423
|
{
|
|
5669
6424
|
"resource": "teams",
|
|
5670
6425
|
"command": "create",
|
|
@@ -6455,16 +7210,20 @@ export const CLI_COMMANDS = [
|
|
|
6455
7210
|
},
|
|
6456
7211
|
{
|
|
6457
7212
|
"name": "default_ai_model",
|
|
6458
|
-
"type": "
|
|
7213
|
+
"type": "AiChatSelection",
|
|
6459
7214
|
"required": false,
|
|
6460
|
-
"description": "Model a new chat opens on. Null clears the preference.
|
|
7215
|
+
"description": "Model a new chat opens on. Null clears the preference. An unavailable selection asks the member to choose again; it never changes who pays automatically. Optional.",
|
|
6461
7216
|
"allowed_values": [
|
|
6462
|
-
"claude-opus-5",
|
|
7217
|
+
"claude-opus-5-5",
|
|
6463
7218
|
"claude-sonnet-5",
|
|
6464
|
-
"gpt-
|
|
7219
|
+
"gpt-6-sol",
|
|
6465
7220
|
"gpt-5.6-terra",
|
|
7221
|
+
"gpt-6-luna",
|
|
7222
|
+
"claude-opus-5",
|
|
7223
|
+
"gpt-5.6-sol",
|
|
6466
7224
|
"gpt-5.6-luna",
|
|
6467
|
-
"claude-opus-4-6"
|
|
7225
|
+
"claude-opus-4-6",
|
|
7226
|
+
"tailglow"
|
|
6468
7227
|
],
|
|
6469
7228
|
"deprecated": null
|
|
6470
7229
|
},
|
|
@@ -7496,7 +8255,9 @@ export const CLI_COMMANDS = [
|
|
|
7496
8255
|
"Scaling up requires the team to have a payment method, and `count` must stay within the team's per-project server limit.",
|
|
7497
8256
|
"The response is the project's whole fleet after the request, not only the servers that changed.",
|
|
7498
8257
|
"Requesting the count the project already runs, with nothing in flight, returns a `409`.",
|
|
7499
|
-
"
|
|
8258
|
+
"During a platform update, a scale request is queued and answered with a `202`; it is applied once the update finishes, and the project's `queued_server_count` shows it meanwhile. A project that has no servers yet still gets its first server immediately.",
|
|
8259
|
+
"Adding servers to a project that has not finished moving to the current platform version is queued the same way, even with no update in progress. Removing servers is not held back by it.",
|
|
8260
|
+
"Requesting the count the project currently runs while a change is queued cancels the queued change, or returns a `409` if that change has already started. A newer request replaces an older queued one."
|
|
7500
8261
|
],
|
|
7501
8262
|
"path_params": [
|
|
7502
8263
|
{
|
|
@@ -7645,7 +8406,7 @@ export const CLI_COMMANDS = [
|
|
|
7645
8406
|
"servers:read"
|
|
7646
8407
|
],
|
|
7647
8408
|
"notes": [
|
|
7648
|
-
"Pending
|
|
8409
|
+
"Pending averages valid queued records, Throughput counts drained records, and Errors counts rejected requests and dropped frames. Older pending history without record counts is unknown.",
|
|
7649
8410
|
"Takes the same range and interval parameters as the vitals endpoint, so the two can be read over the same window.",
|
|
7650
8411
|
"Without `start_at` and `end_at` the range is the last 12 hours."
|
|
7651
8412
|
],
|
|
@@ -9028,7 +9789,8 @@ export const CLI_COMMANDS = [
|
|
|
9028
9789
|
"`schedule_cron` must be a valid cron expression. It is evaluated in UTC, and the finest granularity is one minute.",
|
|
9029
9790
|
"`collection_slug` is required, and must be lowercase, start with a letter or digit, and may otherwise contain digits, letters, hyphens and underscores. Naming it here is what lets several checks deliberately share one collection and chart together; renaming the check later never moves the series, because the slug is stored rather than derived.",
|
|
9030
9791
|
"`check_retry_seconds` is between 1 and 20, and defaults to 10. A failed run waits this long and requests once more before it is recorded, so a single flake does not become a recorded minute of downtime. Send `null` to record the first result as it stands.",
|
|
9031
|
-
"Each run writes one observation to `collection_slug` carrying `check_id`, `checked_at`, `up`, `http_status`, `response_time_ms`, `error_stage`, `error_message` and `attempts`. `up` is 1 when the endpoint returned a 2xx and 0 when it did not answer or answered with an error status, so the average of `up` over a period is the uptime for that period.",
|
|
9792
|
+
"Each run writes one observation to `collection_slug` carrying `check_id`, `check_name`, `checked_at`, `up`, `http_status`, `response_time_ms`, `error_stage`, `error_message` and `attempts`. `up` is 1 when the endpoint returned a 2xx and 0 when it did not answer or answered with an error status, so the average of `up` over a period is the uptime for that period.",
|
|
9793
|
+
"`check_name` is the name the check carried when the run was recorded, so a chart grouped on `check_id` can label its series with something readable. Renaming the check does not rewrite observations already stored.",
|
|
9032
9794
|
"`checked_at` is the scheduled minute rather than the moment the observation was written, so a run delayed by a confirming request still lands in the minute it describes.",
|
|
9033
9795
|
"`name` must be unique within the project, so a check is identifiable in a list and in the strip it charts as."
|
|
9034
9796
|
],
|