@globus/sdk 6.0.0-rc.11 → 6.0.0-rc.12

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 (12) hide show
  1. package/dist/cjs/index.js.map +2 -2
  2. package/dist/esm/open-api/types/flows.d.ts +505 -229
  3. package/dist/esm/open-api/types/flows.d.ts.map +1 -1
  4. package/dist/esm/open-api/types/flows.js +0 -4
  5. package/dist/esm/open-api/types/flows.js.map +1 -1
  6. package/dist/esm/package.json +1 -1
  7. package/dist/esm/services/flows/service/runs.d.ts +9 -17
  8. package/dist/esm/services/flows/service/runs.d.ts.map +1 -1
  9. package/dist/esm/services/flows/service/runs.js.map +1 -1
  10. package/dist/umd/globus.production.js +2 -2
  11. package/dist/umd/globus.production.js.map +2 -2
  12. package/package.json +2 -2
package/dist/esm/open-api/types/flows.d.ts CHANGED
@@ -1,7 +1,3 @@
1
- /**
2
- * This file was auto-generated by openapi-typescript.
3
- * Do not make direct changes to the file.
4
- */
5
1
  export interface paths {
6
2
  "/flows": {
7
3
  parameters: {
@@ -43,7 +39,10 @@ export interface paths {
43
39
  * multiple roles are specified, the user will have at least one of the
44
40
  * specified roles on each Flow returned.
45
41
  *
46
- * @example flow_owner,flow_viewers
42
+ * @example [
43
+ * "flow_owner",
44
+ * "flow_viewers"
45
+ * ]
47
46
  */
48
47
  filter_roles?: ("flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators" | "run_managers" | "run_monitors")[];
49
48
  /**
@@ -66,7 +65,10 @@ export interface paths {
66
65
  * returned is guaranteed to contain at least one of the strings in its
67
66
  * scope strings.
68
67
  *
69
- * @example 0abc,100
68
+ * @example [
69
+ * "0abc",
70
+ * "100"
71
+ * ]
70
72
  */
71
73
  filter_scope_string?: string[];
72
74
  /**
@@ -74,7 +76,10 @@ export interface paths {
74
76
  * field. If multiple values are specified, each Flow returned
75
77
  * is guaranteed to contain at least one of the strings in its title.
76
78
  *
77
- * @example hello,science
79
+ * @example [
80
+ * "hello",
81
+ * "science"
82
+ * ]
78
83
  */
79
84
  filter_title?: string[];
80
85
  /**
@@ -83,7 +88,10 @@ export interface paths {
83
88
  * is guaranteed to contain at least one of the strings in its
84
89
  * subtitle.
85
90
  *
86
- * @example hello,science
91
+ * @example [
92
+ * "hello",
93
+ * "science"
94
+ * ]
87
95
  */
88
96
  filter_subtitle?: string[];
89
97
  /**
@@ -92,7 +100,10 @@ export interface paths {
92
100
  * is guaranteed to contain at least one of the strings in its
93
101
  * description.
94
102
  *
95
- * @example hello,science
103
+ * @example [
104
+ * "hello",
105
+ * "science"
106
+ * ]
96
107
  */
97
108
  filter_description?: string[];
98
109
  /**
@@ -101,7 +112,10 @@ export interface paths {
101
112
  * is guaranteed to contain at least one of the substrings as a
102
113
  * keyword.
103
114
  *
104
- * @example hello,science
115
+ * @example [
116
+ * "hello",
117
+ * "science"
118
+ * ]
105
119
  */
106
120
  filter_keywords?: string[];
107
121
  /**
@@ -117,33 +131,55 @@ export interface paths {
117
131
  * - id
118
132
  * - flow_administrators
119
133
  *
120
- * @example globus
134
+ * @example [
135
+ * "globus"
136
+ * ]
121
137
  */
122
138
  filter_fulltext?: string[];
123
139
  /**
124
- * @description An ordering criteria to apply to the resulting Flows listing. The
125
- * first value indicates the field to order on, and the second value
126
- * indicates the sorting order. The first ordering criteria will be
127
- * used to sort the data, subsequent ordering criteria will be applied
128
- * for ties.
140
+ * @description Ordering criteria to apply to the list of flows.
129
141
  *
130
- * Fields that support ordering are:
131
- * - id
132
- * - scope_string
133
- * - flow_owner
134
- * - flow_administrators
135
- * - title
136
- * - created_at
137
- * - updated_at
142
+ * This field is a comma-separated list of sort criteria,
143
+ * and follows this syntax:
144
+ *
145
+ * ```
146
+ * CRITERION1[,CRITERION2[,...]]
147
+ * ```
148
+ *
149
+ * and each individual `CRITERION` follows this syntax:
150
+ *
151
+ * ```
152
+ * FIELD ORDERING
153
+ * ```
154
+ *
155
+ * The first value, `FIELD`, indicates the field to sort by;
156
+ * the second value, `ORDERING`, indicates the sorting order.
157
+ *
158
+ * When additional comma-separated criteria are added,
159
+ * the first criterion will be used to sort the data;
160
+ * subsequent criteria will be applied for ties.
161
+ *
162
+ * Supported fields are:
163
+ *
164
+ * - `id`
165
+ * - `scope_string`
166
+ * - `flow_owner`
167
+ * - `flow_administrators`
168
+ * - `title`
169
+ * - `created_at`
170
+ * - `updated_at`
138
171
  *
139
172
  * Supported orderings are:
140
- * - ASC
141
- * - DESC
142
173
  *
143
- * @default orderby=id ASC
144
- * @example title ASC,id DESC
174
+ * - `ASC`
175
+ * - `DESC`
176
+ *
177
+ * @example [
178
+ * "title ASC",
179
+ * "id DESC"
180
+ * ]
145
181
  */
146
- orderby?: string[];
182
+ orderby?: components["parameters"]["list_flows_orderby"];
147
183
  };
148
184
  header?: never;
149
185
  path?: never;
@@ -204,7 +240,6 @@ export interface paths {
204
240
  requestBody: {
205
241
  content: {
206
242
  "application/json": {
207
- /** @description The Flow to deploy. */
208
243
  definition: components["schemas"]["FlowDefinition"];
209
244
  /** @description A non-unique, human-friendly name used for displaying the provider
210
245
  * to end users.
@@ -220,29 +255,26 @@ export interface paths {
220
255
  * */
221
256
  keywords?: string[];
222
257
  /**
223
- * @description A set of Principal URN values, or the value "public" indicating the
224
- * identity of users who can view the provider description via
225
- * introspection or when indexed in any provider catalog service.
258
+ * @description A set of Principal URNs, or the value "public",
259
+ * indicating the identity of users and/or groups
260
+ * who can view the flow.
226
261
  *
227
262
  * @example [
228
- * "public",
229
263
  * "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
230
264
  * "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
231
265
  * ]
232
266
  */
233
- flow_viewers?: components["schemas"]["PrincipalURN_or_public"][];
267
+ flow_viewers?: ("public" | components["schemas"]["PrincipalURN"])[];
234
268
  /**
235
- * @description A set of Principal URN values, or the value
236
- * "all_authenticated_users" indicating the identity of users who can
237
- * use the /run operation to initiate an action on the provider.
269
+ * @description A set of Principal URNs, or the value "all_authenticated_users",
270
+ * indicating the identity of users who can start the flow.
238
271
  *
239
272
  * @example [
240
- * "all_authenticated_users",
241
273
  * "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
242
274
  * "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
243
275
  * ]
244
276
  */
245
- flow_starters?: components["schemas"]["PrincipalURN_or_all_authenticated_users"][];
277
+ flow_starters?: ("all_authenticated_users" | components["schemas"]["PrincipalURN"])[];
246
278
  /**
247
279
  * @description The set of Principal URN values of users who may perform
248
280
  * administrative operations, including updating the description
@@ -257,7 +289,7 @@ export interface paths {
257
289
  /** @description A published JSON Schema which input to the Flow must conform
258
290
  * to.
259
291
  * */
260
- input_schema?: Record<string, never>;
292
+ input_schema?: Record<string, unknown>;
261
293
  run_managers?: components["schemas"]["RunManagers"];
262
294
  run_monitors?: components["schemas"]["RunMonitors"];
263
295
  /**
@@ -331,11 +363,10 @@ export interface paths {
331
363
  requestBody: {
332
364
  content: {
333
365
  "application/json": {
334
- /** @description The flow definition. */
335
366
  definition: components["schemas"]["FlowDefinition"];
336
367
  /** @description A JSON Schema describing valid input to the flow.
337
368
  * */
338
- input_schema?: Record<string, never>;
369
+ input_schema?: Record<string, unknown>;
339
370
  };
340
371
  };
341
372
  };
@@ -397,8 +428,8 @@ export interface paths {
397
428
  query?: never;
398
429
  header?: never;
399
430
  path: {
400
- /** @description The ID for the Flow whose definition is being looked up. */
401
- flow_id: string;
431
+ /** @description The flow ID */
432
+ flow_id: components["parameters"]["flow_id"];
402
433
  };
403
434
  cookie?: never;
404
435
  };
@@ -411,8 +442,8 @@ export interface paths {
411
442
  query?: never;
412
443
  header?: never;
413
444
  path: {
414
- /** @description The ID for the Flow whose definition is being looked up. */
415
- flow_id: string;
445
+ /** @description The flow ID */
446
+ flow_id: components["parameters"]["flow_id"];
416
447
  };
417
448
  cookie?: never;
418
449
  };
@@ -458,26 +489,21 @@ export interface paths {
458
489
  query?: never;
459
490
  header?: never;
460
491
  path: {
461
- /** @description The ID for the Flow whose definition is being looked up. */
462
- flow_id: string;
492
+ /** @description The flow ID */
493
+ flow_id: components["parameters"]["flow_id"];
463
494
  };
464
495
  cookie?: never;
465
496
  };
466
497
  requestBody: {
467
498
  content: {
468
499
  "application/json": {
469
- /** @description A new flow definition that will replace the old one.
470
- *
471
- * Runs that are currently executing will continue to use the definition
472
- * that they were initially started with.
473
- * */
474
500
  definition?: components["schemas"]["FlowDefinition"];
475
501
  /** @description A JSON schema document.
476
502
  *
477
503
  * When starting the flow, input keys and values must conform to the schema.
478
504
  * The Globus Web App uses the input schema to created a guided input page when starting the flow.
479
505
  * */
480
- input_schema?: Record<string, never>;
506
+ input_schema?: Record<string, unknown>;
481
507
  /** @description A non-unique, human-friendly name used for displaying the flow to end users.
482
508
  * */
483
509
  title?: string;
@@ -499,7 +525,7 @@ export interface paths {
499
525
  * Flow administrators are able to see the full flow definition,
500
526
  * including any parameters listed in a "__Private_Parameters" value.
501
527
  * */
502
- flow_administrators?: Record<string, never>[];
528
+ flow_administrators?: string[];
503
529
  /** @description A list of Globus Auth identity and group URNs that may start the flow.
504
530
  *
505
531
  * It is possible to make a flow available for use to all authenticated users
@@ -509,7 +535,7 @@ export interface paths {
509
535
  * Parameters listed in "__Private_Parameters" values in the definition
510
536
  * will be removed from the definition when it is viewed by a flow starter.
511
537
  * */
512
- flow_starters?: Record<string, never>[];
538
+ flow_starters?: string[];
513
539
  /** @description A list of Globus Auth identity and group URNs that may see the flow,
514
540
  * including its definition and input schema.
515
541
  *
@@ -520,10 +546,10 @@ export interface paths {
520
546
  * Parameters listed in "__Private_Parameters" values in the definition
521
547
  * will be removed from the definition when it is viewed by a flow starter.
522
548
  * */
523
- flow_viewers?: Record<string, never>[];
549
+ flow_viewers?: string[];
524
550
  /** @description A list of keywords that can be used for grouping or identifying flows.
525
551
  * */
526
- keywords?: Record<string, never>[];
552
+ keywords?: string[];
527
553
  run_managers?: components["schemas"]["RunManagers"];
528
554
  run_monitors?: components["schemas"]["RunMonitors"];
529
555
  subscription_id?: string & (unknown | "DEFAULT");
@@ -581,8 +607,8 @@ export interface paths {
581
607
  query?: never;
582
608
  header?: never;
583
609
  path: {
584
- /** @description The ID for the Flow whose definition is being looked up. */
585
- flow_id: string;
610
+ /** @description The flow ID */
611
+ flow_id: components["parameters"]["flow_id"];
586
612
  };
587
613
  cookie?: never;
588
614
  };
@@ -645,7 +671,10 @@ export interface paths {
645
671
  * @description Return Flow's for which the user has the supplied role. The role the
646
672
  * user has on the Flow dictates the operations they can perform.
647
673
  *
648
- * @example flow_owner,flow_viewers
674
+ * @example [
675
+ * "flow_owner",
676
+ * "flow_viewers"
677
+ * ]
649
678
  */
650
679
  roles?: ("flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators")[];
651
680
  };
@@ -706,8 +735,8 @@ export interface paths {
706
735
  query?: never;
707
736
  header?: never;
708
737
  path: {
709
- /** @description The ID for the Flow to run. */
710
- flow_id: string;
738
+ /** @description The flow ID */
739
+ flow_id: components["parameters"]["flow_id"];
711
740
  };
712
741
  cookie?: never;
713
742
  };
@@ -722,8 +751,8 @@ export interface paths {
722
751
  query?: never;
723
752
  header?: never;
724
753
  path: {
725
- /** @description The ID for the Flow to run. */
726
- flow_id: string;
754
+ /** @description The flow ID */
755
+ flow_id: components["parameters"]["flow_id"];
727
756
  };
728
757
  cookie?: never;
729
758
  };
@@ -819,7 +848,10 @@ export interface paths {
819
848
  parameters: {
820
849
  query?: never;
821
850
  header?: never;
822
- path?: never;
851
+ path: {
852
+ /** @description The flow ID */
853
+ flow_id: components["parameters"]["flow_id"];
854
+ };
823
855
  cookie?: never;
824
856
  };
825
857
  get?: never;
@@ -838,7 +870,10 @@ export interface paths {
838
870
  parameters: {
839
871
  query?: never;
840
872
  header?: never;
841
- path?: never;
873
+ path: {
874
+ /** @description The flow ID */
875
+ flow_id: components["parameters"]["flow_id"];
876
+ };
842
877
  cookie?: never;
843
878
  };
844
879
  requestBody: {
@@ -897,8 +932,8 @@ export interface paths {
897
932
  query?: never;
898
933
  header?: never;
899
934
  path: {
900
- /** @description The ID for the Flow to run. */
901
- flow_id: string;
935
+ /** @description The flow ID */
936
+ flow_id: components["parameters"]["flow_id"];
902
937
  };
903
938
  cookie?: never;
904
939
  };
@@ -914,8 +949,8 @@ export interface paths {
914
949
  query?: never;
915
950
  header?: never;
916
951
  path: {
917
- /** @description The ID for the Flow to run. */
918
- flow_id: string;
952
+ /** @description The flow ID */
953
+ flow_id: components["parameters"]["flow_id"];
919
954
  };
920
955
  cookie?: never;
921
956
  };
@@ -1008,8 +1043,8 @@ export interface paths {
1008
1043
  query?: never;
1009
1044
  header?: never;
1010
1045
  path: {
1011
- /** @description The ID for the Run whose data is being released. */
1012
- run_id: string;
1046
+ /** @description The run ID */
1047
+ run_id: components["parameters"]["run_id"];
1013
1048
  };
1014
1049
  cookie?: never;
1015
1050
  };
@@ -1024,8 +1059,8 @@ export interface paths {
1024
1059
  query?: never;
1025
1060
  header?: never;
1026
1061
  path: {
1027
- /** @description The ID for the Run whose data is being released. */
1028
- run_id: string;
1062
+ /** @description The run ID */
1063
+ run_id: components["parameters"]["run_id"];
1029
1064
  };
1030
1065
  cookie?: never;
1031
1066
  };
@@ -1107,10 +1142,10 @@ export interface paths {
1107
1142
  query?: never;
1108
1143
  header?: never;
1109
1144
  path: {
1110
- /** @description The ID for the Flow which launched the Run. */
1111
- flow_id: string;
1112
- /** @description The ID for the Run whose data is being resumed. */
1113
- run_id: string;
1145
+ /** @description The flow ID */
1146
+ flow_id: components["parameters"]["flow_id"];
1147
+ /** @description The run ID */
1148
+ run_id: components["parameters"]["run_id"];
1114
1149
  };
1115
1150
  cookie?: never;
1116
1151
  };
@@ -1153,10 +1188,10 @@ export interface paths {
1153
1188
  query?: never;
1154
1189
  header?: never;
1155
1190
  path: {
1156
- /** @description The ID for the Flow which launched the Run. */
1157
- flow_id: string;
1158
- /** @description The ID for the Run whose data is being resumed. */
1159
- run_id: string;
1191
+ /** @description The flow ID */
1192
+ flow_id: components["parameters"]["flow_id"];
1193
+ /** @description The run ID */
1194
+ run_id: components["parameters"]["run_id"];
1160
1195
  };
1161
1196
  cookie?: never;
1162
1197
  };
@@ -1188,16 +1223,16 @@ export interface paths {
1188
1223
  patch?: never;
1189
1224
  trace?: never;
1190
1225
  };
1191
- "/flows/{flow_id}/actions/{action_id}/resume": paths["/flows/{flow_id}/runs/{run_id}/resume"];
1192
- "/runs/{action_id}/resume": paths["/flows/{flow_id}/runs/{run_id}/resume"];
1226
+ "/flows/{flow_id}/actions/{run_id}/resume": paths["/flows/{flow_id}/runs/{run_id}/resume"];
1227
+ "/runs/{run_id}/resume": paths["/flows/{flow_id}/runs/{run_id}/resume"];
1193
1228
  "/flows/{flow_id}/{run_id}/resume": paths["/flows/{flow_id}/runs/{run_id}/resume"];
1194
1229
  "/runs/{run_id}/cancel": {
1195
1230
  parameters: {
1196
1231
  query?: never;
1197
1232
  header?: never;
1198
1233
  path: {
1199
- /** @description The ID for the Run to cancel. */
1200
- run_id: string;
1234
+ /** @description The run ID */
1235
+ run_id: components["parameters"]["run_id"];
1201
1236
  };
1202
1237
  cookie?: never;
1203
1238
  };
@@ -1212,8 +1247,8 @@ export interface paths {
1212
1247
  query?: never;
1213
1248
  header?: never;
1214
1249
  path: {
1215
- /** @description The ID for the Run to cancel. */
1216
- run_id: string;
1250
+ /** @description The run ID */
1251
+ run_id: components["parameters"]["run_id"];
1217
1252
  };
1218
1253
  cookie?: never;
1219
1254
  };
@@ -1268,10 +1303,10 @@ export interface paths {
1268
1303
  };
1269
1304
  header?: never;
1270
1305
  path: {
1271
- /** @description The ID for the Flow which launched the Run. */
1272
- flow_id: string;
1273
- /** @description The ID for the Run whose log is getting pulled. */
1274
- run_id: string;
1306
+ /** @description The flow ID */
1307
+ flow_id: components["parameters"]["flow_id"];
1308
+ /** @description The run ID */
1309
+ run_id: components["parameters"]["run_id"];
1275
1310
  };
1276
1311
  cookie?: never;
1277
1312
  };
@@ -1294,10 +1329,10 @@ export interface paths {
1294
1329
  };
1295
1330
  header?: never;
1296
1331
  path: {
1297
- /** @description The ID for the Flow which launched the Run. */
1298
- flow_id: string;
1299
- /** @description The ID for the Run whose log is getting pulled. */
1300
- run_id: string;
1332
+ /** @description The flow ID */
1333
+ flow_id: components["parameters"]["flow_id"];
1334
+ /** @description The run ID */
1335
+ run_id: components["parameters"]["run_id"];
1301
1336
  };
1302
1337
  cookie?: never;
1303
1338
  };
@@ -1318,7 +1353,7 @@ export interface paths {
1318
1353
  * */
1319
1354
  marker?: string;
1320
1355
  has_next_page: boolean;
1321
- entries: Record<string, never>[];
1356
+ entries: Record<string, unknown>[];
1322
1357
  };
1323
1358
  };
1324
1359
  };
@@ -1349,16 +1384,16 @@ export interface paths {
1349
1384
  patch?: never;
1350
1385
  trace?: never;
1351
1386
  };
1352
- "/flows/{flow_id}/actions/{action_id}/log": paths["/flows/{flow_id}/{run_id}/log"];
1353
- "/runs/{action_id}/log": paths["/flows/{flow_id}/{run_id}/log"];
1387
+ "/flows/{flow_id}/actions/{run_id}/log": paths["/flows/{flow_id}/{run_id}/log"];
1388
+ "/runs/{run_id}/log": paths["/flows/{flow_id}/{run_id}/log"];
1354
1389
  "/flows/{flow_id}/{run_id}/log": paths["/flows/{flow_id}/runs/{run_id}/log"];
1355
1390
  "/flows/{flow_id}/runs": {
1356
1391
  parameters: {
1357
1392
  query?: never;
1358
1393
  header?: never;
1359
1394
  path: {
1360
- /** @description The ID for the Flow which launched the Runs. */
1361
- flow_id: string;
1395
+ /** @description The flow ID */
1396
+ flow_id: components["parameters"]["flow_id"];
1362
1397
  };
1363
1398
  cookie?: never;
1364
1399
  };
@@ -1408,7 +1443,9 @@ export interface paths {
1408
1443
  * If multiple roles are specified, the user will have at least one of
1409
1444
  * the specified roles on each Action returned.
1410
1445
  *
1411
- * @example run_manager
1446
+ * @example [
1447
+ * "run_manager"
1448
+ * ]
1412
1449
  */
1413
1450
  filter_roles?: ("run_owner" | "run_manager" | "run_monitor" | "flow_run_manager" | "flow_run_monitor")[];
1414
1451
  /**
@@ -1422,7 +1459,9 @@ export interface paths {
1422
1459
  * has "run_monitor" role as well. If not provided, only Actions
1423
1460
  * for which the caller has "run_owner" role will be returned.
1424
1461
  *
1425
- * @example run_manager
1462
+ * @example [
1463
+ * "run_manager"
1464
+ * ]
1426
1465
  */
1427
1466
  filter_role?: "run_monitor" | "run_manager" | "run_owner" | "flow_run_manager" | "flow_run_monitor";
1428
1467
  /**
@@ -1432,7 +1471,10 @@ export interface paths {
1432
1471
  * of the specified states. By default, Actions in any state will be
1433
1472
  * returned.
1434
1473
  *
1435
- * @example FAILED,INACTIVE
1474
+ * @example [
1475
+ * "FAILED",
1476
+ * "INACTIVE"
1477
+ * ]
1436
1478
  */
1437
1479
  filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
1438
1480
  /**
@@ -1440,64 +1482,98 @@ export interface paths {
1440
1482
  * label fields. If multiple values are specified, each Action returned
1441
1483
  * is guaranteed to contain at least one of the strings in its label.
1442
1484
  *
1443
- * @example science,tests
1485
+ * @example [
1486
+ * "science",
1487
+ * "tests"
1488
+ * ]
1444
1489
  */
1445
1490
  filter_label?: string[];
1446
1491
  /**
1447
- * @description Given a pair of comma separated ISO 8601 date/time strings, filter
1448
- * results to only those Actions whose completion time is within the
1449
- * specified range. If one of the dates is omitted, it forms an open
1450
- * range, so "dt," returns all records with date greater or equal to
1451
- * dt, and ",dt" returns all records with dates less than dt. If there
1452
- * is no comma, it is treated in the same way as "dt,". Results will
1453
- * contain Actions which completed between the first date/time string
1454
- * onwards, up to (but not including) the second date/time string.
1455
- * Note that Actions which are still running will have null completion
1456
- * times and thus cannot be filtered by this field.
1492
+ * @description Given a pair of comma-separated ISO 8601 datetime strings,
1493
+ * filter results to only those runs which completed execution
1494
+ * within the specified range.
1495
+ *
1496
+ * If one of the dates is omitted, it forms an open range.
1497
+ * For example, if the filter has a datetime followed by a comma (`"DT,"`),
1498
+ * all records with a date greater then or equal to `DT` will be returned.
1499
+ * Similarly, if the filter has a comma followed by a datetime (`",DT"`),
1500
+ * all records with dates less than `DT` will be returned.
1501
+ * If there is no comma, it is treated in the same way as `"DT,"`, above.
1502
+ *
1503
+ * Results will contain runs which completed between the first datetime
1504
+ * onwards, up to (but not including) the second datetime.
1505
+ *
1506
+ * Note that runs which are still executing will not have a completion time
1507
+ * and will be automatically excluded if this filter is applied.
1457
1508
  *
1458
1509
  * @example 2021-03-09T21:52:14,2021-03-09T21:53
1459
1510
  */
1460
- filter_completion_time?: string;
1511
+ filter_completion_time?: components["parameters"]["filter_completion_time"];
1461
1512
  /**
1462
- * @description Given a pair of comma separated ISO 8601 date/time strings, filter
1463
- * results to only those Actions which started running within the
1464
- * specified range. If one of the dates is omitted, it forms an open
1465
- * range, so "dt," returns all records with date greater or equal to
1466
- * dt, and ",dt" returns all records with dates less than dt. If there
1467
- * is no comma, it is treated in the same way as "dt,". Results will
1468
- * contain Actions which began between the first date/time string
1469
- * onwards, up to (but not including) the second date/time string.
1513
+ * @description Given a pair of comma separated ISO 8601 date/time strings,
1514
+ * filter results to only those runs which started execution
1515
+ * within the specified range.
1516
+ *
1517
+ * If one of the dates is omitted, it forms an open range.
1518
+ * For example, if the filter has a datetime followed by a comma (`"DT,"`),
1519
+ * all records with a date greater then or equal to `DT` will be returned.
1520
+ * Similarly, if the filter has a comma followed by a datetime (`",DT"`),
1521
+ * all records with dates less than `DT` will be returned.
1522
+ * If there is no comma, it is treated in the same way as `"DT,"`, above.
1523
+ *
1524
+ * Results will contain runs which began between the first datetime
1525
+ * onwards, up to (but not including) the second datetime.
1470
1526
  *
1471
1527
  * @example 2021-03-09T21:52:14,2021-03-09T21:53
1472
1528
  */
1473
- filter_start_time?: string;
1529
+ filter_start_time?: components["parameters"]["filter_start_time"];
1474
1530
  /**
1475
- * @description An ordering criteria to apply to the resulting Action listing. The
1476
- * first value indicates the field to order on, and the second value
1477
- * indicates the sorting order. The first ordering criteria will be
1478
- * used to sort the data, subsequent ordering criteria will be applied
1479
- * for ties.
1531
+ * @description Ordering criteria to apply to the list of runs.
1480
1532
  *
1481
- * Fields that support ordering are:
1482
- * - id
1483
- * - start_time
1484
- * - completion_time
1485
- * - status
1486
- * - label
1533
+ * This field is a comma-separated list of sort criteria,
1534
+ * and follows this syntax:
1535
+ *
1536
+ * ```
1537
+ * CRITERION1[,CRITERION2[,...]]
1538
+ * ```
1539
+ *
1540
+ * and each individual `CRITERION` follows this syntax:
1541
+ *
1542
+ * ```
1543
+ * FIELD ORDERING
1544
+ * ```
1545
+ *
1546
+ * The first value, `FIELD`, indicates the field to sort by;
1547
+ * the second value, `ORDERING`, indicates the sorting order.
1548
+ *
1549
+ * When additional comma-separated criteria are added,
1550
+ * the first criterion will be used to sort the data;
1551
+ * subsequent criteria will be applied for ties.
1552
+ *
1553
+ * Supported fields are:
1554
+ *
1555
+ * - `id`
1556
+ * - `start_time`
1557
+ * - `completion_time`
1558
+ * - `status`
1559
+ * - `label`
1487
1560
  *
1488
1561
  * Supported orderings are:
1489
- * - ASC
1490
- * - DESC
1491
1562
  *
1492
- * @default orderby=id ASC
1493
- * @example start_time ASC,id DESC
1563
+ * - `ASC`
1564
+ * - `DESC`
1565
+ *
1566
+ * @example [
1567
+ * "start_time ASC",
1568
+ * "id DESC"
1569
+ * ]
1494
1570
  */
1495
- orderby?: string[];
1571
+ orderby?: components["parameters"]["list_runs_orderby"];
1496
1572
  };
1497
1573
  header?: never;
1498
1574
  path: {
1499
- /** @description The ID for the Flow which launched the Runs. */
1500
- flow_id: string;
1575
+ /** @description The flow ID */
1576
+ flow_id: components["parameters"]["flow_id"];
1501
1577
  };
1502
1578
  cookie?: never;
1503
1579
  };
@@ -1601,7 +1677,10 @@ export interface paths {
1601
1677
  * If multiple roles are specified, the user will have at least one of
1602
1678
  * the specified roles on each Action returned.
1603
1679
  *
1604
- * @example run_owner,run_managers
1680
+ * @example [
1681
+ * "run_owner",
1682
+ * "run_managers"
1683
+ * ]
1605
1684
  */
1606
1685
  filter_roles?: ("run_owner" | "run_managers" | "run_monitors" | "flow_run_managers" | "flow_run_monitors")[];
1607
1686
  /**
@@ -1625,7 +1704,10 @@ export interface paths {
1625
1704
  * of the specified states. By default, Actions in any state will be
1626
1705
  * returned.
1627
1706
  *
1628
- * @example FAILED,INACTIVE
1707
+ * @example [
1708
+ * "FAILED",
1709
+ * "INACTIVE"
1710
+ * ]
1629
1711
  */
1630
1712
  filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
1631
1713
  /**
@@ -1633,7 +1715,10 @@ export interface paths {
1633
1715
  * label fields. If multiple values are specified, each Action returned
1634
1716
  * is guaranteed to contain at least one of the strings in its label.
1635
1717
  *
1636
- * @example science,tests
1718
+ * @example [
1719
+ * "science",
1720
+ * "tests"
1721
+ * ]
1637
1722
  */
1638
1723
  filter_label?: string[];
1639
1724
  /**
@@ -1642,7 +1727,10 @@ export interface paths {
1642
1727
  * multiple values are specified, each Action returned will have a
1643
1728
  * parent Flow with a title matching at least one of the strings.
1644
1729
  *
1645
- * @example globus,tests
1730
+ * @example [
1731
+ * "globus",
1732
+ * "tests"
1733
+ * ]
1646
1734
  */
1647
1735
  filter_flow_title?: string[];
1648
1736
  /**
@@ -1651,61 +1739,93 @@ export interface paths {
1651
1739
  * specified, each Run returned will have been initiated from at least
1652
1740
  * one of the specified Flow IDs.
1653
1741
  *
1654
- * @example 6086d817-19d9-4f5b-9329-22ed12d4d3dd,71a70751-19a5-4d19-998e-0709c40321e9
1742
+ * @example [
1743
+ * "00000000-19d9-4f5b-9329-22ed12d4d3dd",
1744
+ * "11111111-19a5-4d19-998e-0709c40321e9"
1745
+ * ]
1655
1746
  */
1656
1747
  filter_flow_id?: string[];
1657
1748
  /**
1658
- * @description Given a pair of comma separated ISO 8601 date/time strings, filter
1659
- * results to only those Actions whose completion time is within the
1660
- * specified range. If one of the dates is omitted, it forms an open
1661
- * range, so "dt," returns all records with date greater or equal to
1662
- * dt, and ",dt" returns all records with dates less than dt. If there
1663
- * is no comma, it is treated in the same way as "dt,". Results will
1664
- * contain Actions which completed between the first date/time string
1665
- * onwards, up to (but not including) the second date/time string.
1666
- * Note that Actions which are still running will have null completion
1667
- * times and thus cannot be filtered by this field.
1749
+ * @description Given a pair of comma-separated ISO 8601 datetime strings,
1750
+ * filter results to only those runs which completed execution
1751
+ * within the specified range.
1752
+ *
1753
+ * If one of the dates is omitted, it forms an open range.
1754
+ * For example, if the filter has a datetime followed by a comma (`"DT,"`),
1755
+ * all records with a date greater then or equal to `DT` will be returned.
1756
+ * Similarly, if the filter has a comma followed by a datetime (`",DT"`),
1757
+ * all records with dates less than `DT` will be returned.
1758
+ * If there is no comma, it is treated in the same way as `"DT,"`, above.
1759
+ *
1760
+ * Results will contain runs which completed between the first datetime
1761
+ * onwards, up to (but not including) the second datetime.
1762
+ *
1763
+ * Note that runs which are still executing will not have a completion time
1764
+ * and will be automatically excluded if this filter is applied.
1668
1765
  *
1669
1766
  * @example 2021-03-09T21:52:14,2021-03-09T21:53
1670
1767
  */
1671
- filter_completion_time?: string;
1768
+ filter_completion_time?: components["parameters"]["filter_completion_time"];
1672
1769
  /**
1673
- * @description Given a pair of comma separated ISO 8601 date/time strings, filter
1674
- * results to only those Actions which started running within the
1675
- * specified range. If one of the dates is omitted, it forms an open
1676
- * range, so "dt," returns all records with date greater or equal to
1677
- * dt, and ",dt" returns all records with dates less than dt. If there
1678
- * is no comma, it is treated in the same way as "dt,". Results will
1679
- * contain Actions which began between the first date/time string
1680
- * onwards, up to (but not including) the second date/time string.
1770
+ * @description Given a pair of comma separated ISO 8601 date/time strings,
1771
+ * filter results to only those runs which started execution
1772
+ * within the specified range.
1773
+ *
1774
+ * If one of the dates is omitted, it forms an open range.
1775
+ * For example, if the filter has a datetime followed by a comma (`"DT,"`),
1776
+ * all records with a date greater then or equal to `DT` will be returned.
1777
+ * Similarly, if the filter has a comma followed by a datetime (`",DT"`),
1778
+ * all records with dates less than `DT` will be returned.
1779
+ * If there is no comma, it is treated in the same way as `"DT,"`, above.
1780
+ *
1781
+ * Results will contain runs which began between the first datetime
1782
+ * onwards, up to (but not including) the second datetime.
1681
1783
  *
1682
1784
  * @example 2021-03-09T21:52:14,2021-03-09T21:53
1683
1785
  */
1684
- filter_start_time?: string;
1786
+ filter_start_time?: components["parameters"]["filter_start_time"];
1685
1787
  /**
1686
- * @description An ordering criteria to apply to the resulting Action listing. The
1687
- * first value indicates the field to order on, and the second value
1688
- * indicates the sorting order. The first ordering criteria will be
1689
- * used to sort the data, subsequent ordering criteria will be applied
1690
- * for ties.
1788
+ * @description Ordering criteria to apply to the list of runs.
1691
1789
  *
1692
- * Fields that support ordering are:
1693
- * - id
1694
- * - start_time
1695
- * - completion_time
1696
- * - status
1697
- * - label
1698
- * - run_owner
1699
- * - flow_title
1790
+ * This field is a comma-separated list of sort criteria,
1791
+ * and follows this syntax:
1792
+ *
1793
+ * ```
1794
+ * CRITERION1[,CRITERION2[,...]]
1795
+ * ```
1796
+ *
1797
+ * and each individual `CRITERION` follows this syntax:
1798
+ *
1799
+ * ```
1800
+ * FIELD ORDERING
1801
+ * ```
1802
+ *
1803
+ * The first value, `FIELD`, indicates the field to sort by;
1804
+ * the second value, `ORDERING`, indicates the sorting order.
1805
+ *
1806
+ * When additional comma-separated criteria are added,
1807
+ * the first criterion will be used to sort the data;
1808
+ * subsequent criteria will be applied for ties.
1809
+ *
1810
+ * Supported fields are:
1811
+ *
1812
+ * - `id`
1813
+ * - `start_time`
1814
+ * - `completion_time`
1815
+ * - `status`
1816
+ * - `label`
1700
1817
  *
1701
1818
  * Supported orderings are:
1702
- * - ASC
1703
- * - DESC
1704
1819
  *
1705
- * @default orderby=start_time DESC
1706
- * @example start_time ASC,id DESC
1820
+ * - `ASC`
1821
+ * - `DESC`
1822
+ *
1823
+ * @example [
1824
+ * "start_time ASC",
1825
+ * "id DESC"
1826
+ * ]
1707
1827
  */
1708
- orderby?: string[];
1828
+ orderby?: components["parameters"]["list_runs_orderby"];
1709
1829
  };
1710
1830
  header?: never;
1711
1831
  path?: never;
@@ -1763,8 +1883,8 @@ export interface paths {
1763
1883
  query?: never;
1764
1884
  header?: never;
1765
1885
  path: {
1766
- /** @description The ID for the Run. */
1767
- run_id: string;
1886
+ /** @description The run ID */
1887
+ run_id: components["parameters"]["run_id"];
1768
1888
  };
1769
1889
  cookie?: never;
1770
1890
  };
@@ -1786,8 +1906,8 @@ export interface paths {
1786
1906
  };
1787
1907
  header?: never;
1788
1908
  path: {
1789
- /** @description The ID for the Run. */
1790
- run_id: string;
1909
+ /** @description The run ID */
1910
+ run_id: components["parameters"]["run_id"];
1791
1911
  };
1792
1912
  cookie?: never;
1793
1913
  };
@@ -1835,8 +1955,8 @@ export interface paths {
1835
1955
  query?: never;
1836
1956
  header?: never;
1837
1957
  path: {
1838
- /** @description The ID for the Run. */
1839
- run_id: string;
1958
+ /** @description The run ID */
1959
+ run_id: components["parameters"]["run_id"];
1840
1960
  };
1841
1961
  cookie?: never;
1842
1962
  };
@@ -1912,8 +2032,8 @@ export interface paths {
1912
2032
  query?: never;
1913
2033
  header?: never;
1914
2034
  path: {
1915
- /** @description The UUID of the Run. */
1916
- run_id: string;
2035
+ /** @description The run ID */
2036
+ run_id: components["parameters"]["run_id"];
1917
2037
  };
1918
2038
  cookie?: never;
1919
2039
  };
@@ -1930,8 +2050,8 @@ export interface paths {
1930
2050
  query?: never;
1931
2051
  header?: never;
1932
2052
  path: {
1933
- /** @description The UUID of the Run. */
1934
- run_id: string;
2053
+ /** @description The run ID */
2054
+ run_id: components["parameters"]["run_id"];
1935
2055
  };
1936
2056
  cookie?: never;
1937
2057
  };
@@ -2001,7 +2121,11 @@ export interface paths {
2001
2121
  };
2002
2122
  };
2003
2123
  };
2004
- responses: never;
2124
+ responses: {
2125
+ 202: components["responses"]["HTTP202Response"];
2126
+ 403: components["responses"]["HTTP403Response"];
2127
+ 422: components["responses"]["HTTP422Response"];
2128
+ };
2005
2129
  };
2006
2130
  delete?: never;
2007
2131
  options?: never;
@@ -2013,6 +2137,15 @@ export interface paths {
2013
2137
  export type webhooks = Record<string, never>;
2014
2138
  export interface components {
2015
2139
  schemas: {
2140
+ /**
2141
+ * The flow definition
2142
+ * @description The flow definition.
2143
+ *
2144
+ * If this parameter is used when updating a flow,
2145
+ * runs that are currently executing will continue to use the definition
2146
+ * that they were initially started with.
2147
+ *
2148
+ */
2016
2149
  FlowDefinition: {
2017
2150
  Comment?: string;
2018
2151
  StartAt: string;
@@ -2058,7 +2191,7 @@ export interface components {
2058
2191
  */
2059
2192
  status: "SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE";
2060
2193
  display_status?: string;
2061
- details: Record<string, never>;
2194
+ details: Record<string, unknown>;
2062
2195
  run_owner: components["schemas"]["PrincipalURN"];
2063
2196
  run_monitors?: components["schemas"]["RunMonitors"];
2064
2197
  run_managers?: components["schemas"]["RunManagers"];
@@ -2084,15 +2217,14 @@ export interface components {
2084
2217
  flow_id: string;
2085
2218
  /** @description The definition of the Flow at the time the Run was started.
2086
2219
  * */
2087
- definition: Record<string, never>;
2220
+ definition: Record<string, unknown>;
2088
2221
  /** @description The input schema of the Flow at the time the Run was started.
2089
2222
  * */
2090
- input_schema: Record<string, never>;
2223
+ input_schema: Record<string, unknown>;
2091
2224
  };
2092
2225
  FlowEmbed: {
2093
2226
  /** @description The unique identifier for the Flow. */
2094
2227
  id: string;
2095
- /** @description The user with primary responsibility for the Flow. */
2096
2228
  flow_owner?: components["schemas"]["PrincipalURN"];
2097
2229
  /**
2098
2230
  * Format: date-time
@@ -2217,7 +2349,9 @@ export interface components {
2217
2349
  End?: boolean;
2218
2350
  } & (unknown | unknown);
2219
2351
  Parameters: {
2220
- Parameters?: components["schemas"]["JsonPathPattern"];
2352
+ Parameters?: {
2353
+ [key: string]: unknown;
2354
+ };
2221
2355
  };
2222
2356
  InputPath: {
2223
2357
  InputPath?: components["schemas"]["JsonPathPattern"];
@@ -2345,12 +2479,11 @@ export interface components {
2345
2479
  FlowResponse: {
2346
2480
  /** @description The unique identifier for the Flow. */
2347
2481
  id?: string;
2348
- /** @description The Flow to deploy. */
2349
2482
  definition?: components["schemas"]["FlowDefinition"];
2350
2483
  /** @description A JSON Schema compliant definition of the format of the `body` field
2351
2484
  * when requesting a Flow be run.
2352
2485
  * */
2353
- input_schema?: Record<string, never>;
2486
+ input_schema?: Record<string, unknown>;
2354
2487
  /**
2355
2488
  * Format: uri
2356
2489
  * @description The scope of any bearer token to be used on authenticated accesses
@@ -2380,7 +2513,7 @@ export interface components {
2380
2513
  * "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
2381
2514
  * ]
2382
2515
  */
2383
- flow_viewers?: components["schemas"]["PrincipalURN_or_public"][];
2516
+ flow_viewers?: components["schemas"]["PrincipalURN"][];
2384
2517
  /**
2385
2518
  * @description A set of Principal URN values, or the value
2386
2519
  * "all_authenticated_users" indicating the identity of users
@@ -2394,7 +2527,7 @@ export interface components {
2394
2527
  * "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
2395
2528
  * ]
2396
2529
  */
2397
- flow_starters?: components["schemas"]["PrincipalURN_or_all_authenticated_users"][];
2530
+ flow_starters?: components["schemas"]["PrincipalURN"][];
2398
2531
  /** @description The set of Principal URN values of users who may perform
2399
2532
  * administrative operations, including updating the
2400
2533
  * description itself. Only calling users with the
@@ -2402,7 +2535,6 @@ export interface components {
2402
2535
  * list. Otherwise, the value will always be an empty list.
2403
2536
  * */
2404
2537
  flow_administrators?: components["schemas"]["PrincipalURN"][];
2405
- /** @description The user with primary responsibility for the Flow. */
2406
2538
  flow_owner?: components["schemas"]["PrincipalURN"];
2407
2539
  /**
2408
2540
  * Format: date-time
@@ -2438,7 +2570,6 @@ export interface components {
2438
2570
  * query and discovery operations.
2439
2571
  * */
2440
2572
  keywords?: string[];
2441
- /** @description The Flow's identity in Globus Auth. */
2442
2573
  principal_urn?: components["schemas"]["PrincipalURN"];
2443
2574
  /** @description The Flow's Globus Auth username. */
2444
2575
  globus_auth_username?: string;
@@ -2460,9 +2591,6 @@ export interface components {
2460
2591
  subscription_id?: string;
2461
2592
  };
2462
2593
  FlowValidationResponse: {
2463
- /** @description A mapping of RunAs values to the scopes required to run the flow
2464
- * as that identity.
2465
- * */
2466
2594
  scopes?: components["schemas"]["FlowScopes"];
2467
2595
  };
2468
2596
  FlowValidationErrorResponse: {
@@ -2501,36 +2629,184 @@ export interface components {
2501
2629
  /** @enum {string} */
2502
2630
  status?: "cancel";
2503
2631
  };
2632
+ };
2633
+ responses: {
2504
2634
  /** @description The requested operation was accepted.
2505
2635
  *
2506
2636
  * The operation may have been completed, or may be completed at a later time.
2507
2637
  * A follow-up API request may be needed to confirm the status of the operation.
2508
2638
  * */
2509
- HTTP202Response: unknown;
2639
+ HTTP202Response: {
2640
+ headers: {
2641
+ [name: string]: unknown;
2642
+ };
2643
+ content: {
2644
+ "application/json": Record<string, unknown>;
2645
+ };
2646
+ };
2510
2647
  /** @description The requesting user is not authorized to make the requested changes. */
2511
- HTTP403Response: unknown;
2648
+ HTTP403Response: {
2649
+ headers: {
2650
+ [name: string]: unknown;
2651
+ };
2652
+ content: {
2653
+ "application/json": {
2654
+ error: {
2655
+ /** A readable keyword describing the failure. */
2656
+ code: string;
2657
+ /** A readable description of the failure. */
2658
+ detail: string;
2659
+ };
2660
+ };
2661
+ };
2662
+ };
2512
2663
  /** @description The input document failed input validation in some way. */
2513
- HTTP422Response: unknown;
2664
+ HTTP422Response: {
2665
+ headers: {
2666
+ [name: string]: unknown;
2667
+ };
2668
+ content: {
2669
+ "application/json": {
2670
+ error: {
2671
+ /** A readable keyword describing the failure. */
2672
+ code: string;
2673
+ detail: components["schemas"]["LocationErrorList"];
2674
+ };
2675
+ };
2676
+ };
2677
+ };
2678
+ };
2679
+ parameters: {
2680
+ /** @description The flow ID */
2681
+ flow_id: string;
2682
+ /** @description The run ID */
2683
+ run_id: string;
2514
2684
  /**
2515
- * @description A URN representation of an Identity in Globus either of a user from
2516
- * Globus Auth or a group from Globus Groups or the special value
2517
- * "public".
2685
+ * @description Given a pair of comma-separated ISO 8601 datetime strings,
2686
+ * filter results to only those runs which completed execution
2687
+ * within the specified range.
2688
+ *
2689
+ * If one of the dates is omitted, it forms an open range.
2690
+ * For example, if the filter has a datetime followed by a comma (`"DT,"`),
2691
+ * all records with a date greater then or equal to `DT` will be returned.
2692
+ * Similarly, if the filter has a comma followed by a datetime (`",DT"`),
2693
+ * all records with dates less than `DT` will be returned.
2694
+ * If there is no comma, it is treated in the same way as `"DT,"`, above.
2695
+ *
2696
+ * Results will contain runs which completed between the first datetime
2697
+ * onwards, up to (but not including) the second datetime.
2518
2698
  *
2519
- * @example urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035
2699
+ * Note that runs which are still executing will not have a completion time
2700
+ * and will be automatically excluded if this filter is applied.
2701
+ *
2702
+ * @example 2021-03-09T21:52:14,2021-03-09T21:53
2520
2703
  */
2521
- PrincipalURN_or_public: string;
2704
+ filter_completion_time: string;
2522
2705
  /**
2523
- * @description A URN representation of an Identity in Globus either of a user from
2524
- * Globus Auth or a group from Globus Groups or the special value
2525
- * "all_authenticated_users" indicating any user who presents valid
2526
- * credentials (bearer token).
2706
+ * @description Given a pair of comma separated ISO 8601 date/time strings,
2707
+ * filter results to only those runs which started execution
2708
+ * within the specified range.
2709
+ *
2710
+ * If one of the dates is omitted, it forms an open range.
2711
+ * For example, if the filter has a datetime followed by a comma (`"DT,"`),
2712
+ * all records with a date greater then or equal to `DT` will be returned.
2713
+ * Similarly, if the filter has a comma followed by a datetime (`",DT"`),
2714
+ * all records with dates less than `DT` will be returned.
2715
+ * If there is no comma, it is treated in the same way as `"DT,"`, above.
2716
+ *
2717
+ * Results will contain runs which began between the first datetime
2718
+ * onwards, up to (but not including) the second datetime.
2719
+ *
2720
+ * @example 2021-03-09T21:52:14,2021-03-09T21:53
2721
+ */
2722
+ filter_start_time: string;
2723
+ /**
2724
+ * @description Ordering criteria to apply to the list of flows.
2527
2725
  *
2528
- * @example all_authenticated_users
2726
+ * This field is a comma-separated list of sort criteria,
2727
+ * and follows this syntax:
2728
+ *
2729
+ * ```
2730
+ * CRITERION1[,CRITERION2[,...]]
2731
+ * ```
2732
+ *
2733
+ * and each individual `CRITERION` follows this syntax:
2734
+ *
2735
+ * ```
2736
+ * FIELD ORDERING
2737
+ * ```
2738
+ *
2739
+ * The first value, `FIELD`, indicates the field to sort by;
2740
+ * the second value, `ORDERING`, indicates the sorting order.
2741
+ *
2742
+ * When additional comma-separated criteria are added,
2743
+ * the first criterion will be used to sort the data;
2744
+ * subsequent criteria will be applied for ties.
2745
+ *
2746
+ * Supported fields are:
2747
+ *
2748
+ * - `id`
2749
+ * - `scope_string`
2750
+ * - `flow_owner`
2751
+ * - `flow_administrators`
2752
+ * - `title`
2753
+ * - `created_at`
2754
+ * - `updated_at`
2755
+ *
2756
+ * Supported orderings are:
2757
+ *
2758
+ * - `ASC`
2759
+ * - `DESC`
2760
+ *
2761
+ * @example [
2762
+ * "title ASC",
2763
+ * "id DESC"
2764
+ * ]
2765
+ */
2766
+ list_flows_orderby: string[];
2767
+ /**
2768
+ * @description Ordering criteria to apply to the list of runs.
2769
+ *
2770
+ * This field is a comma-separated list of sort criteria,
2771
+ * and follows this syntax:
2772
+ *
2773
+ * ```
2774
+ * CRITERION1[,CRITERION2[,...]]
2775
+ * ```
2776
+ *
2777
+ * and each individual `CRITERION` follows this syntax:
2778
+ *
2779
+ * ```
2780
+ * FIELD ORDERING
2781
+ * ```
2782
+ *
2783
+ * The first value, `FIELD`, indicates the field to sort by;
2784
+ * the second value, `ORDERING`, indicates the sorting order.
2785
+ *
2786
+ * When additional comma-separated criteria are added,
2787
+ * the first criterion will be used to sort the data;
2788
+ * subsequent criteria will be applied for ties.
2789
+ *
2790
+ * Supported fields are:
2791
+ *
2792
+ * - `id`
2793
+ * - `start_time`
2794
+ * - `completion_time`
2795
+ * - `status`
2796
+ * - `label`
2797
+ *
2798
+ * Supported orderings are:
2799
+ *
2800
+ * - `ASC`
2801
+ * - `DESC`
2802
+ *
2803
+ * @example [
2804
+ * "start_time ASC",
2805
+ * "id DESC"
2806
+ * ]
2529
2807
  */
2530
- PrincipalURN_or_all_authenticated_users: string;
2808
+ list_runs_orderby: string[];
2531
2809
  };
2532
- responses: never;
2533
- parameters: never;
2534
2810
  requestBodies: never;
2535
2811
  headers: never;
2536
2812
  pathItems: never;