@globus/sdk 6.0.0-rc.9 → 6.0.0
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/README.md +4 -0
- package/dist/cjs/core/authorization/index.js +19 -5
- package/dist/cjs/core/authorization/index.js.map +2 -2
- package/dist/cjs/core/info/index.js +1 -1
- package/dist/cjs/core/info/index.js.map +1 -1
- package/dist/cjs/index.js +27 -8
- package/dist/cjs/index.js.map +2 -2
- package/dist/cjs/services/globus-connect-server/client.js +2 -2
- package/dist/cjs/services/globus-connect-server/client.js.map +2 -2
- package/dist/esm/core/authorization/AuthorizationManager.d.ts +38 -5
- package/dist/esm/core/authorization/AuthorizationManager.d.ts.map +1 -1
- package/dist/esm/core/authorization/AuthorizationManager.js +37 -4
- package/dist/esm/core/authorization/AuthorizationManager.js.map +1 -1
- package/dist/esm/core/authorization/RedirectTransport.d.ts +2 -0
- package/dist/esm/core/authorization/RedirectTransport.d.ts.map +1 -1
- package/dist/esm/core/authorization/RedirectTransport.js.map +1 -1
- package/dist/esm/core/info/version.d.ts +1 -1
- package/dist/esm/core/info/version.js +1 -1
- package/dist/esm/index.d.ts +24 -2
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +24 -2
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/open-api/types/compute.d.ts +47 -21
- package/dist/esm/open-api/types/compute.d.ts.map +1 -1
- package/dist/esm/open-api/types/flows.d.ts +507 -424
- package/dist/esm/open-api/types/flows.d.ts.map +1 -1
- package/dist/esm/open-api/types/flows.js +0 -4
- package/dist/esm/open-api/types/flows.js.map +1 -1
- package/dist/esm/open-api/types/gcs/v5.4.d.ts +1348 -1036
- package/dist/esm/open-api/types/gcs/v5.4.d.ts.map +1 -1
- package/dist/esm/open-api/types/search.d.ts +91 -7
- package/dist/esm/open-api/types/search.d.ts.map +1 -1
- package/dist/esm/open-api/types/timers.d.ts +185 -17
- package/dist/esm/open-api/types/timers.d.ts.map +1 -1
- package/dist/esm/package.json +1 -1
- package/dist/esm/services/flows/service/flows.d.ts +9 -8
- package/dist/esm/services/flows/service/flows.d.ts.map +1 -1
- package/dist/esm/services/flows/service/flows.js.map +1 -1
- package/dist/esm/services/flows/service/runs.d.ts +17 -24
- package/dist/esm/services/flows/service/runs.d.ts.map +1 -1
- package/dist/esm/services/flows/service/runs.js.map +1 -1
- package/dist/esm/services/globus-connect-server/client.d.ts +55 -0
- package/dist/esm/services/globus-connect-server/client.d.ts.map +1 -1
- package/dist/esm/services/shared.js +1 -1
- package/dist/esm/services/shared.js.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts +3 -3
- package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint.d.ts +1 -0
- package/dist/esm/services/transfer/service/endpoint.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint.js.map +1 -1
- package/dist/esm/services/transfer/service/task.d.ts +3 -3
- package/dist/esm/services/transfer/service/task.d.ts.map +1 -1
- package/dist/esm/services/transfer/types.d.ts +1 -1
- package/dist/esm/services/transfer/types.d.ts.map +1 -1
- package/dist/esm/services/transfer/utils.d.ts.map +1 -1
- package/dist/esm/services/transfer/utils.js +8 -3
- package/dist/esm/services/transfer/utils.js.map +1 -1
- package/dist/esm/services/types.d.ts +4 -0
- package/dist/esm/services/types.d.ts.map +1 -1
- package/dist/umd/globus.production.js +2 -2
- package/dist/umd/globus.production.js.map +2 -2
- package/package.json +4 -4
- package/dist/esm/open-api/types/timer.d.ts +0 -942
- package/dist/esm/open-api/types/timer.d.ts.map +0 -1
- package/dist/esm/open-api/types/timer.js +0 -2
- package/dist/esm/open-api/types/timer.js.map +0 -1
- package/dist/esm/services/timer/config.d.ts +0 -4
- package/dist/esm/services/timer/config.d.ts.map +0 -1
- package/dist/esm/services/timer/config.js +0 -10
- package/dist/esm/services/timer/config.js.map +0 -1
- package/dist/esm/services/timer/index.d.ts +0 -16
- package/dist/esm/services/timer/index.d.ts.map +0 -1
- package/dist/esm/services/timer/index.js +0 -15
- package/dist/esm/services/timer/index.js.map +0 -1
- package/dist/esm/services/timer/service/timer.d.ts +0 -32
- package/dist/esm/services/timer/service/timer.d.ts.map +0 -1
- package/dist/esm/services/timer/service/timer.js +0 -11
- package/dist/esm/services/timer/service/timer.js.map +0 -1
|
@@ -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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
134
|
+
* @example [
|
|
135
|
+
* "globus"
|
|
136
|
+
* ]
|
|
121
137
|
*/
|
|
122
138
|
filter_fulltext?: string[];
|
|
123
139
|
/**
|
|
124
|
-
* @description
|
|
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
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
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
|
-
*
|
|
144
|
-
*
|
|
174
|
+
* - `ASC`
|
|
175
|
+
* - `DESC`
|
|
176
|
+
*
|
|
177
|
+
* @example [
|
|
178
|
+
* "title ASC",
|
|
179
|
+
* "id DESC"
|
|
180
|
+
* ]
|
|
145
181
|
*/
|
|
146
|
-
orderby?:
|
|
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
|
|
224
|
-
* identity of users
|
|
225
|
-
*
|
|
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"]["
|
|
267
|
+
flow_viewers?: ("public" | components["schemas"]["PrincipalURN"])[];
|
|
234
268
|
/**
|
|
235
|
-
* @description A set of Principal
|
|
236
|
-
*
|
|
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"]["
|
|
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,
|
|
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,
|
|
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
|
|
401
|
-
flow_id:
|
|
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
|
|
415
|
-
flow_id:
|
|
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
|
|
462
|
-
flow_id:
|
|
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,
|
|
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?:
|
|
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?:
|
|
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?:
|
|
549
|
+
flow_viewers?: string[];
|
|
524
550
|
/** @description A list of keywords that can be used for grouping or identifying flows.
|
|
525
551
|
* */
|
|
526
|
-
keywords?:
|
|
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
|
|
585
|
-
flow_id:
|
|
610
|
+
/** @description The flow ID */
|
|
611
|
+
flow_id: components["parameters"]["flow_id"];
|
|
586
612
|
};
|
|
587
613
|
cookie?: never;
|
|
588
614
|
};
|
|
@@ -624,90 +650,13 @@ export interface paths {
|
|
|
624
650
|
patch?: never;
|
|
625
651
|
trace?: never;
|
|
626
652
|
};
|
|
627
|
-
"/mine": {
|
|
628
|
-
parameters: {
|
|
629
|
-
query?: never;
|
|
630
|
-
header?: never;
|
|
631
|
-
path?: never;
|
|
632
|
-
cookie?: never;
|
|
633
|
-
};
|
|
634
|
-
/**
|
|
635
|
-
* Retrieve all Flows
|
|
636
|
-
* @deprecated
|
|
637
|
-
* @description Query the Flows service for a listing of Flows available to a user
|
|
638
|
-
* according to the permissions (role) they have on the Flow.
|
|
639
|
-
*
|
|
640
|
-
*/
|
|
641
|
-
get: {
|
|
642
|
-
parameters: {
|
|
643
|
-
query?: {
|
|
644
|
-
/**
|
|
645
|
-
* @description Return Flow's for which the user has the supplied role. The role the
|
|
646
|
-
* user has on the Flow dictates the operations they can perform.
|
|
647
|
-
*
|
|
648
|
-
* @example flow_owner,flow_viewers
|
|
649
|
-
*/
|
|
650
|
-
roles?: ("flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators")[];
|
|
651
|
-
};
|
|
652
|
-
header?: never;
|
|
653
|
-
path?: never;
|
|
654
|
-
cookie?: never;
|
|
655
|
-
};
|
|
656
|
-
requestBody?: never;
|
|
657
|
-
responses: {
|
|
658
|
-
/** @description The requestor has successfully authenticated and queried the Flow's
|
|
659
|
-
* service for the Flows available for them.
|
|
660
|
-
* */
|
|
661
|
-
200: {
|
|
662
|
-
headers: {
|
|
663
|
-
[name: string]: unknown;
|
|
664
|
-
};
|
|
665
|
-
content: {
|
|
666
|
-
"application/json": {
|
|
667
|
-
flows?: components["schemas"]["FlowResponse"][];
|
|
668
|
-
/** @description The number of Flows returned. */
|
|
669
|
-
limit?: number;
|
|
670
|
-
/** @description An opaque pagination token for iterating through returned
|
|
671
|
-
* Flows.
|
|
672
|
-
* */
|
|
673
|
-
marker?: string;
|
|
674
|
-
has_next_page?: boolean;
|
|
675
|
-
};
|
|
676
|
-
};
|
|
677
|
-
};
|
|
678
|
-
/** @description There was an issue parsing the query parameters.
|
|
679
|
-
* */
|
|
680
|
-
400: {
|
|
681
|
-
headers: {
|
|
682
|
-
[name: string]: unknown;
|
|
683
|
-
};
|
|
684
|
-
content?: never;
|
|
685
|
-
};
|
|
686
|
-
/** @description The requestor presented a token with insufficient scopes.
|
|
687
|
-
* */
|
|
688
|
-
403: {
|
|
689
|
-
headers: {
|
|
690
|
-
[name: string]: unknown;
|
|
691
|
-
};
|
|
692
|
-
content?: never;
|
|
693
|
-
};
|
|
694
|
-
};
|
|
695
|
-
};
|
|
696
|
-
put?: never;
|
|
697
|
-
post?: never;
|
|
698
|
-
delete?: never;
|
|
699
|
-
options?: never;
|
|
700
|
-
head?: never;
|
|
701
|
-
patch?: never;
|
|
702
|
-
trace?: never;
|
|
703
|
-
};
|
|
704
653
|
"/flows/{flow_id}/run": {
|
|
705
654
|
parameters: {
|
|
706
655
|
query?: never;
|
|
707
656
|
header?: never;
|
|
708
657
|
path: {
|
|
709
|
-
/** @description The ID
|
|
710
|
-
flow_id:
|
|
658
|
+
/** @description The flow ID */
|
|
659
|
+
flow_id: components["parameters"]["flow_id"];
|
|
711
660
|
};
|
|
712
661
|
cookie?: never;
|
|
713
662
|
};
|
|
@@ -722,8 +671,8 @@ export interface paths {
|
|
|
722
671
|
query?: never;
|
|
723
672
|
header?: never;
|
|
724
673
|
path: {
|
|
725
|
-
/** @description The ID
|
|
726
|
-
flow_id:
|
|
674
|
+
/** @description The flow ID */
|
|
675
|
+
flow_id: components["parameters"]["flow_id"];
|
|
727
676
|
};
|
|
728
677
|
cookie?: never;
|
|
729
678
|
};
|
|
@@ -740,13 +689,6 @@ export interface paths {
|
|
|
740
689
|
};
|
|
741
690
|
};
|
|
742
691
|
responses: {
|
|
743
|
-
/** @description The Run inputs were successfully validated during a dry-run. */
|
|
744
|
-
200: {
|
|
745
|
-
headers: {
|
|
746
|
-
[name: string]: unknown;
|
|
747
|
-
};
|
|
748
|
-
content?: never;
|
|
749
|
-
};
|
|
750
692
|
/** @description The Run was successfully started. */
|
|
751
693
|
201: {
|
|
752
694
|
headers: {
|
|
@@ -819,7 +761,10 @@ export interface paths {
|
|
|
819
761
|
parameters: {
|
|
820
762
|
query?: never;
|
|
821
763
|
header?: never;
|
|
822
|
-
path
|
|
764
|
+
path: {
|
|
765
|
+
/** @description The flow ID */
|
|
766
|
+
flow_id: components["parameters"]["flow_id"];
|
|
767
|
+
};
|
|
823
768
|
cookie?: never;
|
|
824
769
|
};
|
|
825
770
|
get?: never;
|
|
@@ -838,7 +783,10 @@ export interface paths {
|
|
|
838
783
|
parameters: {
|
|
839
784
|
query?: never;
|
|
840
785
|
header?: never;
|
|
841
|
-
path
|
|
786
|
+
path: {
|
|
787
|
+
/** @description The flow ID */
|
|
788
|
+
flow_id: components["parameters"]["flow_id"];
|
|
789
|
+
};
|
|
842
790
|
cookie?: never;
|
|
843
791
|
};
|
|
844
792
|
requestBody: {
|
|
@@ -892,124 +840,13 @@ export interface paths {
|
|
|
892
840
|
patch?: never;
|
|
893
841
|
trace?: never;
|
|
894
842
|
};
|
|
895
|
-
"/flows/{flow_id}/start": {
|
|
896
|
-
parameters: {
|
|
897
|
-
query?: never;
|
|
898
|
-
header?: never;
|
|
899
|
-
path: {
|
|
900
|
-
/** @description The ID for the Flow to run. */
|
|
901
|
-
flow_id: string;
|
|
902
|
-
};
|
|
903
|
-
cookie?: never;
|
|
904
|
-
};
|
|
905
|
-
get?: never;
|
|
906
|
-
put?: never;
|
|
907
|
-
/**
|
|
908
|
-
* Start a Flow
|
|
909
|
-
* @deprecated
|
|
910
|
-
* @description Start a particular Flow, which creates a Run.
|
|
911
|
-
*/
|
|
912
|
-
post: {
|
|
913
|
-
parameters: {
|
|
914
|
-
query?: never;
|
|
915
|
-
header?: never;
|
|
916
|
-
path: {
|
|
917
|
-
/** @description The ID for the Flow to run. */
|
|
918
|
-
flow_id: string;
|
|
919
|
-
};
|
|
920
|
-
cookie?: never;
|
|
921
|
-
};
|
|
922
|
-
requestBody: {
|
|
923
|
-
content: {
|
|
924
|
-
"application/json": {
|
|
925
|
-
body: components["schemas"]["InputBody"];
|
|
926
|
-
tags?: components["schemas"]["Tags"];
|
|
927
|
-
};
|
|
928
|
-
};
|
|
929
|
-
};
|
|
930
|
-
responses: {
|
|
931
|
-
/** @description The Run inputs were successfully validated during a dry-run. */
|
|
932
|
-
200: {
|
|
933
|
-
headers: {
|
|
934
|
-
[name: string]: unknown;
|
|
935
|
-
};
|
|
936
|
-
content?: never;
|
|
937
|
-
};
|
|
938
|
-
/** @description The Run was successfully started. */
|
|
939
|
-
201: {
|
|
940
|
-
headers: {
|
|
941
|
-
[name: string]: unknown;
|
|
942
|
-
};
|
|
943
|
-
content: {
|
|
944
|
-
"application/json": components["schemas"]["FlowRun"];
|
|
945
|
-
};
|
|
946
|
-
};
|
|
947
|
-
/** @description The Run's input failed validation against the Flow's input schema.
|
|
948
|
-
* */
|
|
949
|
-
400: {
|
|
950
|
-
headers: {
|
|
951
|
-
[name: string]: unknown;
|
|
952
|
-
};
|
|
953
|
-
content?: never;
|
|
954
|
-
};
|
|
955
|
-
/** @description The requestor presented a token with insufficient scopes.
|
|
956
|
-
* */
|
|
957
|
-
403: {
|
|
958
|
-
headers: {
|
|
959
|
-
[name: string]: unknown;
|
|
960
|
-
};
|
|
961
|
-
content?: never;
|
|
962
|
-
};
|
|
963
|
-
/** @description The requestor did not have access to run the provided Flow, or the
|
|
964
|
-
* Flow does not exist.
|
|
965
|
-
* */
|
|
966
|
-
404: {
|
|
967
|
-
headers: {
|
|
968
|
-
[name: string]: unknown;
|
|
969
|
-
};
|
|
970
|
-
content?: never;
|
|
971
|
-
};
|
|
972
|
-
/** @description The input tags did not pass validation. */
|
|
973
|
-
422: {
|
|
974
|
-
headers: {
|
|
975
|
-
[name: string]: unknown;
|
|
976
|
-
};
|
|
977
|
-
content?: never;
|
|
978
|
-
};
|
|
979
|
-
/** @description An upstream service has imposed rate limiting.
|
|
980
|
-
* The requestor may resubmit the API request.
|
|
981
|
-
* */
|
|
982
|
-
429: {
|
|
983
|
-
headers: {
|
|
984
|
-
[name: string]: unknown;
|
|
985
|
-
};
|
|
986
|
-
content?: never;
|
|
987
|
-
};
|
|
988
|
-
/** @description An upstream service returned an uncorrectable error.
|
|
989
|
-
* The error may or may not occur if the API request is submitted again.
|
|
990
|
-
* It may be possible to resubmit the API request.
|
|
991
|
-
* */
|
|
992
|
-
502: {
|
|
993
|
-
headers: {
|
|
994
|
-
[name: string]: unknown;
|
|
995
|
-
};
|
|
996
|
-
content?: never;
|
|
997
|
-
};
|
|
998
|
-
};
|
|
999
|
-
};
|
|
1000
|
-
delete?: never;
|
|
1001
|
-
options?: never;
|
|
1002
|
-
head?: never;
|
|
1003
|
-
patch?: never;
|
|
1004
|
-
trace?: never;
|
|
1005
|
-
};
|
|
1006
843
|
"/runs/{run_id}/release": {
|
|
1007
844
|
parameters: {
|
|
1008
845
|
query?: never;
|
|
1009
846
|
header?: never;
|
|
1010
847
|
path: {
|
|
1011
|
-
/** @description The ID
|
|
1012
|
-
run_id:
|
|
848
|
+
/** @description The run ID */
|
|
849
|
+
run_id: components["parameters"]["run_id"];
|
|
1013
850
|
};
|
|
1014
851
|
cookie?: never;
|
|
1015
852
|
};
|
|
@@ -1024,8 +861,8 @@ export interface paths {
|
|
|
1024
861
|
query?: never;
|
|
1025
862
|
header?: never;
|
|
1026
863
|
path: {
|
|
1027
|
-
/** @description The ID
|
|
1028
|
-
run_id:
|
|
864
|
+
/** @description The run ID */
|
|
865
|
+
run_id: components["parameters"]["run_id"];
|
|
1029
866
|
};
|
|
1030
867
|
cookie?: never;
|
|
1031
868
|
};
|
|
@@ -1102,15 +939,15 @@ export interface paths {
|
|
|
1102
939
|
patch?: never;
|
|
1103
940
|
trace?: never;
|
|
1104
941
|
};
|
|
1105
|
-
"/flows/{flow_id}/
|
|
942
|
+
"/flows/{flow_id}/{run_id}/resume": {
|
|
1106
943
|
parameters: {
|
|
1107
944
|
query?: never;
|
|
1108
945
|
header?: never;
|
|
1109
946
|
path: {
|
|
1110
|
-
/** @description The ID
|
|
1111
|
-
flow_id:
|
|
1112
|
-
/** @description The ID
|
|
1113
|
-
run_id:
|
|
947
|
+
/** @description The flow ID */
|
|
948
|
+
flow_id: components["parameters"]["flow_id"];
|
|
949
|
+
/** @description The run ID */
|
|
950
|
+
run_id: components["parameters"]["run_id"];
|
|
1114
951
|
};
|
|
1115
952
|
cookie?: never;
|
|
1116
953
|
};
|
|
@@ -1153,10 +990,10 @@ export interface paths {
|
|
|
1153
990
|
query?: never;
|
|
1154
991
|
header?: never;
|
|
1155
992
|
path: {
|
|
1156
|
-
/** @description The ID
|
|
1157
|
-
flow_id:
|
|
1158
|
-
/** @description The ID
|
|
1159
|
-
run_id:
|
|
993
|
+
/** @description The flow ID */
|
|
994
|
+
flow_id: components["parameters"]["flow_id"];
|
|
995
|
+
/** @description The run ID */
|
|
996
|
+
run_id: components["parameters"]["run_id"];
|
|
1160
997
|
};
|
|
1161
998
|
cookie?: never;
|
|
1162
999
|
};
|
|
@@ -1188,16 +1025,14 @@ export interface paths {
|
|
|
1188
1025
|
patch?: never;
|
|
1189
1026
|
trace?: never;
|
|
1190
1027
|
};
|
|
1191
|
-
"/
|
|
1192
|
-
"/runs/{action_id}/resume": paths["/flows/{flow_id}/runs/{run_id}/resume"];
|
|
1193
|
-
"/flows/{flow_id}/{run_id}/resume": paths["/flows/{flow_id}/runs/{run_id}/resume"];
|
|
1028
|
+
"/runs/{run_id}/resume": paths["/flows/{flow_id}/{run_id}/resume"];
|
|
1194
1029
|
"/runs/{run_id}/cancel": {
|
|
1195
1030
|
parameters: {
|
|
1196
1031
|
query?: never;
|
|
1197
1032
|
header?: never;
|
|
1198
1033
|
path: {
|
|
1199
|
-
/** @description The ID
|
|
1200
|
-
run_id:
|
|
1034
|
+
/** @description The run ID */
|
|
1035
|
+
run_id: components["parameters"]["run_id"];
|
|
1201
1036
|
};
|
|
1202
1037
|
cookie?: never;
|
|
1203
1038
|
};
|
|
@@ -1212,8 +1047,8 @@ export interface paths {
|
|
|
1212
1047
|
query?: never;
|
|
1213
1048
|
header?: never;
|
|
1214
1049
|
path: {
|
|
1215
|
-
/** @description The ID
|
|
1216
|
-
run_id:
|
|
1050
|
+
/** @description The run ID */
|
|
1051
|
+
run_id: components["parameters"]["run_id"];
|
|
1217
1052
|
};
|
|
1218
1053
|
cookie?: never;
|
|
1219
1054
|
};
|
|
@@ -1268,10 +1103,10 @@ export interface paths {
|
|
|
1268
1103
|
};
|
|
1269
1104
|
header?: never;
|
|
1270
1105
|
path: {
|
|
1271
|
-
/** @description The ID
|
|
1272
|
-
flow_id:
|
|
1273
|
-
/** @description The ID
|
|
1274
|
-
run_id:
|
|
1106
|
+
/** @description The flow ID */
|
|
1107
|
+
flow_id: components["parameters"]["flow_id"];
|
|
1108
|
+
/** @description The run ID */
|
|
1109
|
+
run_id: components["parameters"]["run_id"];
|
|
1275
1110
|
};
|
|
1276
1111
|
cookie?: never;
|
|
1277
1112
|
};
|
|
@@ -1294,10 +1129,10 @@ export interface paths {
|
|
|
1294
1129
|
};
|
|
1295
1130
|
header?: never;
|
|
1296
1131
|
path: {
|
|
1297
|
-
/** @description The ID
|
|
1298
|
-
flow_id:
|
|
1299
|
-
/** @description The ID
|
|
1300
|
-
run_id:
|
|
1132
|
+
/** @description The flow ID */
|
|
1133
|
+
flow_id: components["parameters"]["flow_id"];
|
|
1134
|
+
/** @description The run ID */
|
|
1135
|
+
run_id: components["parameters"]["run_id"];
|
|
1301
1136
|
};
|
|
1302
1137
|
cookie?: never;
|
|
1303
1138
|
};
|
|
@@ -1318,7 +1153,7 @@ export interface paths {
|
|
|
1318
1153
|
* */
|
|
1319
1154
|
marker?: string;
|
|
1320
1155
|
has_next_page: boolean;
|
|
1321
|
-
entries: Record<string,
|
|
1156
|
+
entries: Record<string, unknown>[];
|
|
1322
1157
|
};
|
|
1323
1158
|
};
|
|
1324
1159
|
};
|
|
@@ -1349,16 +1184,14 @@ export interface paths {
|
|
|
1349
1184
|
patch?: never;
|
|
1350
1185
|
trace?: never;
|
|
1351
1186
|
};
|
|
1352
|
-
"/
|
|
1353
|
-
"/runs/{action_id}/log": paths["/flows/{flow_id}/{run_id}/log"];
|
|
1354
|
-
"/flows/{flow_id}/{run_id}/log": paths["/flows/{flow_id}/runs/{run_id}/log"];
|
|
1187
|
+
"/runs/{run_id}/log": paths["/flows/{flow_id}/runs/{run_id}/log"];
|
|
1355
1188
|
"/flows/{flow_id}/runs": {
|
|
1356
1189
|
parameters: {
|
|
1357
1190
|
query?: never;
|
|
1358
1191
|
header?: never;
|
|
1359
1192
|
path: {
|
|
1360
|
-
/** @description The ID
|
|
1361
|
-
flow_id:
|
|
1193
|
+
/** @description The flow ID */
|
|
1194
|
+
flow_id: components["parameters"]["flow_id"];
|
|
1362
1195
|
};
|
|
1363
1196
|
cookie?: never;
|
|
1364
1197
|
};
|
|
@@ -1408,7 +1241,9 @@ export interface paths {
|
|
|
1408
1241
|
* If multiple roles are specified, the user will have at least one of
|
|
1409
1242
|
* the specified roles on each Action returned.
|
|
1410
1243
|
*
|
|
1411
|
-
* @example
|
|
1244
|
+
* @example [
|
|
1245
|
+
* "run_manager"
|
|
1246
|
+
* ]
|
|
1412
1247
|
*/
|
|
1413
1248
|
filter_roles?: ("run_owner" | "run_manager" | "run_monitor" | "flow_run_manager" | "flow_run_monitor")[];
|
|
1414
1249
|
/**
|
|
@@ -1422,7 +1257,9 @@ export interface paths {
|
|
|
1422
1257
|
* has "run_monitor" role as well. If not provided, only Actions
|
|
1423
1258
|
* for which the caller has "run_owner" role will be returned.
|
|
1424
1259
|
*
|
|
1425
|
-
* @example
|
|
1260
|
+
* @example [
|
|
1261
|
+
* "run_manager"
|
|
1262
|
+
* ]
|
|
1426
1263
|
*/
|
|
1427
1264
|
filter_role?: "run_monitor" | "run_manager" | "run_owner" | "flow_run_manager" | "flow_run_monitor";
|
|
1428
1265
|
/**
|
|
@@ -1432,7 +1269,10 @@ export interface paths {
|
|
|
1432
1269
|
* of the specified states. By default, Actions in any state will be
|
|
1433
1270
|
* returned.
|
|
1434
1271
|
*
|
|
1435
|
-
* @example
|
|
1272
|
+
* @example [
|
|
1273
|
+
* "FAILED",
|
|
1274
|
+
* "INACTIVE"
|
|
1275
|
+
* ]
|
|
1436
1276
|
*/
|
|
1437
1277
|
filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
|
|
1438
1278
|
/**
|
|
@@ -1440,64 +1280,98 @@ export interface paths {
|
|
|
1440
1280
|
* label fields. If multiple values are specified, each Action returned
|
|
1441
1281
|
* is guaranteed to contain at least one of the strings in its label.
|
|
1442
1282
|
*
|
|
1443
|
-
* @example
|
|
1283
|
+
* @example [
|
|
1284
|
+
* "science",
|
|
1285
|
+
* "tests"
|
|
1286
|
+
* ]
|
|
1444
1287
|
*/
|
|
1445
1288
|
filter_label?: string[];
|
|
1446
1289
|
/**
|
|
1447
|
-
* @description Given a pair of comma
|
|
1448
|
-
* results to only those
|
|
1449
|
-
* specified range.
|
|
1450
|
-
*
|
|
1451
|
-
*
|
|
1452
|
-
*
|
|
1453
|
-
*
|
|
1454
|
-
*
|
|
1455
|
-
*
|
|
1456
|
-
*
|
|
1290
|
+
* @description Given a pair of comma-separated ISO 8601 datetime strings,
|
|
1291
|
+
* filter results to only those runs which completed execution
|
|
1292
|
+
* within the specified range.
|
|
1293
|
+
*
|
|
1294
|
+
* If one of the dates is omitted, it forms an open range.
|
|
1295
|
+
* For example, if the filter has a datetime followed by a comma (`"DT,"`),
|
|
1296
|
+
* all records with a date greater then or equal to `DT` will be returned.
|
|
1297
|
+
* Similarly, if the filter has a comma followed by a datetime (`",DT"`),
|
|
1298
|
+
* all records with dates less than `DT` will be returned.
|
|
1299
|
+
* If there is no comma, it is treated in the same way as `"DT,"`, above.
|
|
1300
|
+
*
|
|
1301
|
+
* Results will contain runs which completed between the first datetime
|
|
1302
|
+
* onwards, up to (but not including) the second datetime.
|
|
1303
|
+
*
|
|
1304
|
+
* Note that runs which are still executing will not have a completion time
|
|
1305
|
+
* and will be automatically excluded if this filter is applied.
|
|
1457
1306
|
*
|
|
1458
1307
|
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
1459
1308
|
*/
|
|
1460
|
-
filter_completion_time?:
|
|
1309
|
+
filter_completion_time?: components["parameters"]["filter_completion_time"];
|
|
1461
1310
|
/**
|
|
1462
|
-
* @description Given a pair of comma separated ISO 8601 date/time strings,
|
|
1463
|
-
* results to only those
|
|
1464
|
-
* specified range.
|
|
1465
|
-
*
|
|
1466
|
-
*
|
|
1467
|
-
*
|
|
1468
|
-
*
|
|
1469
|
-
*
|
|
1311
|
+
* @description Given a pair of comma separated ISO 8601 date/time strings,
|
|
1312
|
+
* filter results to only those runs which started execution
|
|
1313
|
+
* within the specified range.
|
|
1314
|
+
*
|
|
1315
|
+
* If one of the dates is omitted, it forms an open range.
|
|
1316
|
+
* For example, if the filter has a datetime followed by a comma (`"DT,"`),
|
|
1317
|
+
* all records with a date greater then or equal to `DT` will be returned.
|
|
1318
|
+
* Similarly, if the filter has a comma followed by a datetime (`",DT"`),
|
|
1319
|
+
* all records with dates less than `DT` will be returned.
|
|
1320
|
+
* If there is no comma, it is treated in the same way as `"DT,"`, above.
|
|
1321
|
+
*
|
|
1322
|
+
* Results will contain runs which began between the first datetime
|
|
1323
|
+
* onwards, up to (but not including) the second datetime.
|
|
1470
1324
|
*
|
|
1471
1325
|
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
1472
1326
|
*/
|
|
1473
|
-
filter_start_time?:
|
|
1327
|
+
filter_start_time?: components["parameters"]["filter_start_time"];
|
|
1474
1328
|
/**
|
|
1475
|
-
* @description
|
|
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.
|
|
1329
|
+
* @description Ordering criteria to apply to the list of runs.
|
|
1480
1330
|
*
|
|
1481
|
-
*
|
|
1482
|
-
*
|
|
1483
|
-
*
|
|
1484
|
-
*
|
|
1485
|
-
*
|
|
1486
|
-
*
|
|
1331
|
+
* This field is a comma-separated list of sort criteria,
|
|
1332
|
+
* and follows this syntax:
|
|
1333
|
+
*
|
|
1334
|
+
* ```
|
|
1335
|
+
* CRITERION1[,CRITERION2[,...]]
|
|
1336
|
+
* ```
|
|
1337
|
+
*
|
|
1338
|
+
* and each individual `CRITERION` follows this syntax:
|
|
1339
|
+
*
|
|
1340
|
+
* ```
|
|
1341
|
+
* FIELD ORDERING
|
|
1342
|
+
* ```
|
|
1343
|
+
*
|
|
1344
|
+
* The first value, `FIELD`, indicates the field to sort by;
|
|
1345
|
+
* the second value, `ORDERING`, indicates the sorting order.
|
|
1346
|
+
*
|
|
1347
|
+
* When additional comma-separated criteria are added,
|
|
1348
|
+
* the first criterion will be used to sort the data;
|
|
1349
|
+
* subsequent criteria will be applied for ties.
|
|
1350
|
+
*
|
|
1351
|
+
* Supported fields are:
|
|
1352
|
+
*
|
|
1353
|
+
* - `id`
|
|
1354
|
+
* - `start_time`
|
|
1355
|
+
* - `completion_time`
|
|
1356
|
+
* - `status`
|
|
1357
|
+
* - `label`
|
|
1487
1358
|
*
|
|
1488
1359
|
* Supported orderings are:
|
|
1489
|
-
* - ASC
|
|
1490
|
-
* - DESC
|
|
1491
1360
|
*
|
|
1492
|
-
*
|
|
1493
|
-
*
|
|
1361
|
+
* - `ASC`
|
|
1362
|
+
* - `DESC`
|
|
1363
|
+
*
|
|
1364
|
+
* @example [
|
|
1365
|
+
* "start_time ASC",
|
|
1366
|
+
* "id DESC"
|
|
1367
|
+
* ]
|
|
1494
1368
|
*/
|
|
1495
|
-
orderby?:
|
|
1369
|
+
orderby?: components["parameters"]["list_runs_orderby"];
|
|
1496
1370
|
};
|
|
1497
1371
|
header?: never;
|
|
1498
1372
|
path: {
|
|
1499
|
-
/** @description The ID
|
|
1500
|
-
flow_id:
|
|
1373
|
+
/** @description The flow ID */
|
|
1374
|
+
flow_id: components["parameters"]["flow_id"];
|
|
1501
1375
|
};
|
|
1502
1376
|
cookie?: never;
|
|
1503
1377
|
};
|
|
@@ -1547,7 +1421,6 @@ export interface paths {
|
|
|
1547
1421
|
patch?: never;
|
|
1548
1422
|
trace?: never;
|
|
1549
1423
|
};
|
|
1550
|
-
"/flows/{flow_id}/actions": paths["/flows/{flow_id}/runs"];
|
|
1551
1424
|
"/runs": {
|
|
1552
1425
|
parameters: {
|
|
1553
1426
|
query?: never;
|
|
@@ -1601,7 +1474,10 @@ export interface paths {
|
|
|
1601
1474
|
* If multiple roles are specified, the user will have at least one of
|
|
1602
1475
|
* the specified roles on each Action returned.
|
|
1603
1476
|
*
|
|
1604
|
-
* @example
|
|
1477
|
+
* @example [
|
|
1478
|
+
* "run_owner",
|
|
1479
|
+
* "run_managers"
|
|
1480
|
+
* ]
|
|
1605
1481
|
*/
|
|
1606
1482
|
filter_roles?: ("run_owner" | "run_managers" | "run_monitors" | "flow_run_managers" | "flow_run_monitors")[];
|
|
1607
1483
|
/**
|
|
@@ -1625,7 +1501,10 @@ export interface paths {
|
|
|
1625
1501
|
* of the specified states. By default, Actions in any state will be
|
|
1626
1502
|
* returned.
|
|
1627
1503
|
*
|
|
1628
|
-
* @example
|
|
1504
|
+
* @example [
|
|
1505
|
+
* "FAILED",
|
|
1506
|
+
* "INACTIVE"
|
|
1507
|
+
* ]
|
|
1629
1508
|
*/
|
|
1630
1509
|
filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
|
|
1631
1510
|
/**
|
|
@@ -1633,7 +1512,10 @@ export interface paths {
|
|
|
1633
1512
|
* label fields. If multiple values are specified, each Action returned
|
|
1634
1513
|
* is guaranteed to contain at least one of the strings in its label.
|
|
1635
1514
|
*
|
|
1636
|
-
* @example
|
|
1515
|
+
* @example [
|
|
1516
|
+
* "science",
|
|
1517
|
+
* "tests"
|
|
1518
|
+
* ]
|
|
1637
1519
|
*/
|
|
1638
1520
|
filter_label?: string[];
|
|
1639
1521
|
/**
|
|
@@ -1642,7 +1524,10 @@ export interface paths {
|
|
|
1642
1524
|
* multiple values are specified, each Action returned will have a
|
|
1643
1525
|
* parent Flow with a title matching at least one of the strings.
|
|
1644
1526
|
*
|
|
1645
|
-
* @example
|
|
1527
|
+
* @example [
|
|
1528
|
+
* "globus",
|
|
1529
|
+
* "tests"
|
|
1530
|
+
* ]
|
|
1646
1531
|
*/
|
|
1647
1532
|
filter_flow_title?: string[];
|
|
1648
1533
|
/**
|
|
@@ -1651,61 +1536,93 @@ export interface paths {
|
|
|
1651
1536
|
* specified, each Run returned will have been initiated from at least
|
|
1652
1537
|
* one of the specified Flow IDs.
|
|
1653
1538
|
*
|
|
1654
|
-
* @example
|
|
1539
|
+
* @example [
|
|
1540
|
+
* "00000000-19d9-4f5b-9329-22ed12d4d3dd",
|
|
1541
|
+
* "11111111-19a5-4d19-998e-0709c40321e9"
|
|
1542
|
+
* ]
|
|
1655
1543
|
*/
|
|
1656
1544
|
filter_flow_id?: string[];
|
|
1657
1545
|
/**
|
|
1658
|
-
* @description Given a pair of comma
|
|
1659
|
-
* results to only those
|
|
1660
|
-
* specified range.
|
|
1661
|
-
*
|
|
1662
|
-
*
|
|
1663
|
-
*
|
|
1664
|
-
*
|
|
1665
|
-
*
|
|
1666
|
-
*
|
|
1667
|
-
*
|
|
1546
|
+
* @description Given a pair of comma-separated ISO 8601 datetime strings,
|
|
1547
|
+
* filter results to only those runs which completed execution
|
|
1548
|
+
* within the specified range.
|
|
1549
|
+
*
|
|
1550
|
+
* If one of the dates is omitted, it forms an open range.
|
|
1551
|
+
* For example, if the filter has a datetime followed by a comma (`"DT,"`),
|
|
1552
|
+
* all records with a date greater then or equal to `DT` will be returned.
|
|
1553
|
+
* Similarly, if the filter has a comma followed by a datetime (`",DT"`),
|
|
1554
|
+
* all records with dates less than `DT` will be returned.
|
|
1555
|
+
* If there is no comma, it is treated in the same way as `"DT,"`, above.
|
|
1556
|
+
*
|
|
1557
|
+
* Results will contain runs which completed between the first datetime
|
|
1558
|
+
* onwards, up to (but not including) the second datetime.
|
|
1559
|
+
*
|
|
1560
|
+
* Note that runs which are still executing will not have a completion time
|
|
1561
|
+
* and will be automatically excluded if this filter is applied.
|
|
1668
1562
|
*
|
|
1669
1563
|
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
1670
1564
|
*/
|
|
1671
|
-
filter_completion_time?:
|
|
1565
|
+
filter_completion_time?: components["parameters"]["filter_completion_time"];
|
|
1672
1566
|
/**
|
|
1673
|
-
* @description Given a pair of comma separated ISO 8601 date/time strings,
|
|
1674
|
-
* results to only those
|
|
1675
|
-
* specified range.
|
|
1676
|
-
*
|
|
1677
|
-
*
|
|
1678
|
-
*
|
|
1679
|
-
*
|
|
1680
|
-
*
|
|
1567
|
+
* @description Given a pair of comma separated ISO 8601 date/time strings,
|
|
1568
|
+
* filter results to only those runs which started execution
|
|
1569
|
+
* within the specified range.
|
|
1570
|
+
*
|
|
1571
|
+
* If one of the dates is omitted, it forms an open range.
|
|
1572
|
+
* For example, if the filter has a datetime followed by a comma (`"DT,"`),
|
|
1573
|
+
* all records with a date greater then or equal to `DT` will be returned.
|
|
1574
|
+
* Similarly, if the filter has a comma followed by a datetime (`",DT"`),
|
|
1575
|
+
* all records with dates less than `DT` will be returned.
|
|
1576
|
+
* If there is no comma, it is treated in the same way as `"DT,"`, above.
|
|
1577
|
+
*
|
|
1578
|
+
* Results will contain runs which began between the first datetime
|
|
1579
|
+
* onwards, up to (but not including) the second datetime.
|
|
1681
1580
|
*
|
|
1682
1581
|
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
1683
1582
|
*/
|
|
1684
|
-
filter_start_time?:
|
|
1583
|
+
filter_start_time?: components["parameters"]["filter_start_time"];
|
|
1685
1584
|
/**
|
|
1686
|
-
* @description
|
|
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.
|
|
1585
|
+
* @description Ordering criteria to apply to the list of runs.
|
|
1691
1586
|
*
|
|
1692
|
-
*
|
|
1693
|
-
*
|
|
1694
|
-
*
|
|
1695
|
-
*
|
|
1696
|
-
*
|
|
1697
|
-
*
|
|
1698
|
-
*
|
|
1699
|
-
*
|
|
1587
|
+
* This field is a comma-separated list of sort criteria,
|
|
1588
|
+
* and follows this syntax:
|
|
1589
|
+
*
|
|
1590
|
+
* ```
|
|
1591
|
+
* CRITERION1[,CRITERION2[,...]]
|
|
1592
|
+
* ```
|
|
1593
|
+
*
|
|
1594
|
+
* and each individual `CRITERION` follows this syntax:
|
|
1595
|
+
*
|
|
1596
|
+
* ```
|
|
1597
|
+
* FIELD ORDERING
|
|
1598
|
+
* ```
|
|
1599
|
+
*
|
|
1600
|
+
* The first value, `FIELD`, indicates the field to sort by;
|
|
1601
|
+
* the second value, `ORDERING`, indicates the sorting order.
|
|
1602
|
+
*
|
|
1603
|
+
* When additional comma-separated criteria are added,
|
|
1604
|
+
* the first criterion will be used to sort the data;
|
|
1605
|
+
* subsequent criteria will be applied for ties.
|
|
1606
|
+
*
|
|
1607
|
+
* Supported fields are:
|
|
1608
|
+
*
|
|
1609
|
+
* - `id`
|
|
1610
|
+
* - `start_time`
|
|
1611
|
+
* - `completion_time`
|
|
1612
|
+
* - `status`
|
|
1613
|
+
* - `label`
|
|
1700
1614
|
*
|
|
1701
1615
|
* Supported orderings are:
|
|
1702
|
-
* - ASC
|
|
1703
|
-
* - DESC
|
|
1704
1616
|
*
|
|
1705
|
-
*
|
|
1706
|
-
*
|
|
1617
|
+
* - `ASC`
|
|
1618
|
+
* - `DESC`
|
|
1619
|
+
*
|
|
1620
|
+
* @example [
|
|
1621
|
+
* "start_time ASC",
|
|
1622
|
+
* "id DESC"
|
|
1623
|
+
* ]
|
|
1707
1624
|
*/
|
|
1708
|
-
orderby?:
|
|
1625
|
+
orderby?: components["parameters"]["list_runs_orderby"];
|
|
1709
1626
|
};
|
|
1710
1627
|
header?: never;
|
|
1711
1628
|
path?: never;
|
|
@@ -1763,8 +1680,8 @@ export interface paths {
|
|
|
1763
1680
|
query?: never;
|
|
1764
1681
|
header?: never;
|
|
1765
1682
|
path: {
|
|
1766
|
-
/** @description The ID
|
|
1767
|
-
run_id:
|
|
1683
|
+
/** @description The run ID */
|
|
1684
|
+
run_id: components["parameters"]["run_id"];
|
|
1768
1685
|
};
|
|
1769
1686
|
cookie?: never;
|
|
1770
1687
|
};
|
|
@@ -1786,8 +1703,8 @@ export interface paths {
|
|
|
1786
1703
|
};
|
|
1787
1704
|
header?: never;
|
|
1788
1705
|
path: {
|
|
1789
|
-
/** @description The ID
|
|
1790
|
-
run_id:
|
|
1706
|
+
/** @description The run ID */
|
|
1707
|
+
run_id: components["parameters"]["run_id"];
|
|
1791
1708
|
};
|
|
1792
1709
|
cookie?: never;
|
|
1793
1710
|
};
|
|
@@ -1835,8 +1752,8 @@ export interface paths {
|
|
|
1835
1752
|
query?: never;
|
|
1836
1753
|
header?: never;
|
|
1837
1754
|
path: {
|
|
1838
|
-
/** @description The ID
|
|
1839
|
-
run_id:
|
|
1755
|
+
/** @description The run ID */
|
|
1756
|
+
run_id: components["parameters"]["run_id"];
|
|
1840
1757
|
};
|
|
1841
1758
|
cookie?: never;
|
|
1842
1759
|
};
|
|
@@ -1912,8 +1829,8 @@ export interface paths {
|
|
|
1912
1829
|
query?: never;
|
|
1913
1830
|
header?: never;
|
|
1914
1831
|
path: {
|
|
1915
|
-
/** @description The
|
|
1916
|
-
run_id:
|
|
1832
|
+
/** @description The run ID */
|
|
1833
|
+
run_id: components["parameters"]["run_id"];
|
|
1917
1834
|
};
|
|
1918
1835
|
cookie?: never;
|
|
1919
1836
|
};
|
|
@@ -1930,8 +1847,8 @@ export interface paths {
|
|
|
1930
1847
|
query?: never;
|
|
1931
1848
|
header?: never;
|
|
1932
1849
|
path: {
|
|
1933
|
-
/** @description The
|
|
1934
|
-
run_id:
|
|
1850
|
+
/** @description The run ID */
|
|
1851
|
+
run_id: components["parameters"]["run_id"];
|
|
1935
1852
|
};
|
|
1936
1853
|
cookie?: never;
|
|
1937
1854
|
};
|
|
@@ -2001,7 +1918,11 @@ export interface paths {
|
|
|
2001
1918
|
};
|
|
2002
1919
|
};
|
|
2003
1920
|
};
|
|
2004
|
-
responses:
|
|
1921
|
+
responses: {
|
|
1922
|
+
202: components["responses"]["HTTP202Response"];
|
|
1923
|
+
403: components["responses"]["HTTP403Response"];
|
|
1924
|
+
422: components["responses"]["HTTP422Response"];
|
|
1925
|
+
};
|
|
2005
1926
|
};
|
|
2006
1927
|
delete?: never;
|
|
2007
1928
|
options?: never;
|
|
@@ -2013,6 +1934,15 @@ export interface paths {
|
|
|
2013
1934
|
export type webhooks = Record<string, never>;
|
|
2014
1935
|
export interface components {
|
|
2015
1936
|
schemas: {
|
|
1937
|
+
/**
|
|
1938
|
+
* The flow definition
|
|
1939
|
+
* @description The flow definition.
|
|
1940
|
+
*
|
|
1941
|
+
* If this parameter is used when updating a flow,
|
|
1942
|
+
* runs that are currently executing will continue to use the definition
|
|
1943
|
+
* that they were initially started with.
|
|
1944
|
+
*
|
|
1945
|
+
*/
|
|
2016
1946
|
FlowDefinition: {
|
|
2017
1947
|
Comment?: string;
|
|
2018
1948
|
StartAt: string;
|
|
@@ -2058,7 +1988,10 @@ export interface components {
|
|
|
2058
1988
|
*/
|
|
2059
1989
|
status: "SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE";
|
|
2060
1990
|
display_status?: string;
|
|
2061
|
-
|
|
1991
|
+
/** @description Details about the run execution. This is null for runs of High Assurance
|
|
1992
|
+
* flows when listing runs.
|
|
1993
|
+
* */
|
|
1994
|
+
details: Record<string, unknown> | null;
|
|
2062
1995
|
run_owner: components["schemas"]["PrincipalURN"];
|
|
2063
1996
|
run_monitors?: components["schemas"]["RunMonitors"];
|
|
2064
1997
|
run_managers?: components["schemas"]["RunManagers"];
|
|
@@ -2084,15 +2017,14 @@ export interface components {
|
|
|
2084
2017
|
flow_id: string;
|
|
2085
2018
|
/** @description The definition of the Flow at the time the Run was started.
|
|
2086
2019
|
* */
|
|
2087
|
-
definition: Record<string,
|
|
2020
|
+
definition: Record<string, unknown>;
|
|
2088
2021
|
/** @description The input schema of the Flow at the time the Run was started.
|
|
2089
2022
|
* */
|
|
2090
|
-
input_schema: Record<string,
|
|
2023
|
+
input_schema: Record<string, unknown>;
|
|
2091
2024
|
};
|
|
2092
2025
|
FlowEmbed: {
|
|
2093
2026
|
/** @description The unique identifier for the Flow. */
|
|
2094
2027
|
id: string;
|
|
2095
|
-
/** @description The user with primary responsibility for the Flow. */
|
|
2096
2028
|
flow_owner?: components["schemas"]["PrincipalURN"];
|
|
2097
2029
|
/**
|
|
2098
2030
|
* Format: date-time
|
|
@@ -2217,7 +2149,9 @@ export interface components {
|
|
|
2217
2149
|
End?: boolean;
|
|
2218
2150
|
} & (unknown | unknown);
|
|
2219
2151
|
Parameters: {
|
|
2220
|
-
Parameters?:
|
|
2152
|
+
Parameters?: {
|
|
2153
|
+
[key: string]: unknown;
|
|
2154
|
+
};
|
|
2221
2155
|
};
|
|
2222
2156
|
InputPath: {
|
|
2223
2157
|
InputPath?: components["schemas"]["JsonPathPattern"];
|
|
@@ -2345,12 +2279,13 @@ export interface components {
|
|
|
2345
2279
|
FlowResponse: {
|
|
2346
2280
|
/** @description The unique identifier for the Flow. */
|
|
2347
2281
|
id?: string;
|
|
2348
|
-
/** @description The
|
|
2282
|
+
/** @description The flow definition. This is null for High Assurance flows when listing flows.
|
|
2283
|
+
* */
|
|
2349
2284
|
definition?: components["schemas"]["FlowDefinition"];
|
|
2350
2285
|
/** @description A JSON Schema compliant definition of the format of the `body` field
|
|
2351
|
-
* when requesting a Flow be run.
|
|
2286
|
+
* when requesting a Flow be run. This is null for High Assurance flows when listing flows.
|
|
2352
2287
|
* */
|
|
2353
|
-
input_schema?: Record<string,
|
|
2288
|
+
input_schema?: Record<string, unknown> | null;
|
|
2354
2289
|
/**
|
|
2355
2290
|
* Format: uri
|
|
2356
2291
|
* @description The scope of any bearer token to be used on authenticated accesses
|
|
@@ -2380,7 +2315,7 @@ export interface components {
|
|
|
2380
2315
|
* "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
|
|
2381
2316
|
* ]
|
|
2382
2317
|
*/
|
|
2383
|
-
flow_viewers?: components["schemas"]["
|
|
2318
|
+
flow_viewers?: components["schemas"]["PrincipalURN"][];
|
|
2384
2319
|
/**
|
|
2385
2320
|
* @description A set of Principal URN values, or the value
|
|
2386
2321
|
* "all_authenticated_users" indicating the identity of users
|
|
@@ -2394,7 +2329,7 @@ export interface components {
|
|
|
2394
2329
|
* "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
|
|
2395
2330
|
* ]
|
|
2396
2331
|
*/
|
|
2397
|
-
flow_starters?: components["schemas"]["
|
|
2332
|
+
flow_starters?: components["schemas"]["PrincipalURN"][];
|
|
2398
2333
|
/** @description The set of Principal URN values of users who may perform
|
|
2399
2334
|
* administrative operations, including updating the
|
|
2400
2335
|
* description itself. Only calling users with the
|
|
@@ -2402,7 +2337,6 @@ export interface components {
|
|
|
2402
2337
|
* list. Otherwise, the value will always be an empty list.
|
|
2403
2338
|
* */
|
|
2404
2339
|
flow_administrators?: components["schemas"]["PrincipalURN"][];
|
|
2405
|
-
/** @description The user with primary responsibility for the Flow. */
|
|
2406
2340
|
flow_owner?: components["schemas"]["PrincipalURN"];
|
|
2407
2341
|
/**
|
|
2408
2342
|
* Format: date-time
|
|
@@ -2438,7 +2372,6 @@ export interface components {
|
|
|
2438
2372
|
* query and discovery operations.
|
|
2439
2373
|
* */
|
|
2440
2374
|
keywords?: string[];
|
|
2441
|
-
/** @description The Flow's identity in Globus Auth. */
|
|
2442
2375
|
principal_urn?: components["schemas"]["PrincipalURN"];
|
|
2443
2376
|
/** @description The Flow's Globus Auth username. */
|
|
2444
2377
|
globus_auth_username?: string;
|
|
@@ -2449,6 +2382,11 @@ export interface components {
|
|
|
2449
2382
|
*
|
|
2450
2383
|
*/
|
|
2451
2384
|
flow_url?: string;
|
|
2385
|
+
/** @description Indicates whether this flow is High Assurance. High Assurance flows have
|
|
2386
|
+
* sensitive fields (definition, input_schema) omitted from list responses
|
|
2387
|
+
* for security purposes.
|
|
2388
|
+
* */
|
|
2389
|
+
is_high_assurance?: boolean;
|
|
2452
2390
|
/**
|
|
2453
2391
|
* Format: uuid
|
|
2454
2392
|
* @description A subscription_id associated with this Flow. If no
|
|
@@ -2460,9 +2398,6 @@ export interface components {
|
|
|
2460
2398
|
subscription_id?: string;
|
|
2461
2399
|
};
|
|
2462
2400
|
FlowValidationResponse: {
|
|
2463
|
-
/** @description A mapping of RunAs values to the scopes required to run the flow
|
|
2464
|
-
* as that identity.
|
|
2465
|
-
* */
|
|
2466
2401
|
scopes?: components["schemas"]["FlowScopes"];
|
|
2467
2402
|
};
|
|
2468
2403
|
FlowValidationErrorResponse: {
|
|
@@ -2501,36 +2436,184 @@ export interface components {
|
|
|
2501
2436
|
/** @enum {string} */
|
|
2502
2437
|
status?: "cancel";
|
|
2503
2438
|
};
|
|
2439
|
+
};
|
|
2440
|
+
responses: {
|
|
2504
2441
|
/** @description The requested operation was accepted.
|
|
2505
2442
|
*
|
|
2506
2443
|
* The operation may have been completed, or may be completed at a later time.
|
|
2507
2444
|
* A follow-up API request may be needed to confirm the status of the operation.
|
|
2508
2445
|
* */
|
|
2509
|
-
HTTP202Response:
|
|
2446
|
+
HTTP202Response: {
|
|
2447
|
+
headers: {
|
|
2448
|
+
[name: string]: unknown;
|
|
2449
|
+
};
|
|
2450
|
+
content: {
|
|
2451
|
+
"application/json": Record<string, unknown>;
|
|
2452
|
+
};
|
|
2453
|
+
};
|
|
2510
2454
|
/** @description The requesting user is not authorized to make the requested changes. */
|
|
2511
|
-
HTTP403Response:
|
|
2455
|
+
HTTP403Response: {
|
|
2456
|
+
headers: {
|
|
2457
|
+
[name: string]: unknown;
|
|
2458
|
+
};
|
|
2459
|
+
content: {
|
|
2460
|
+
"application/json": {
|
|
2461
|
+
error: {
|
|
2462
|
+
/** A readable keyword describing the failure. */
|
|
2463
|
+
code: string;
|
|
2464
|
+
/** A readable description of the failure. */
|
|
2465
|
+
detail: string;
|
|
2466
|
+
};
|
|
2467
|
+
};
|
|
2468
|
+
};
|
|
2469
|
+
};
|
|
2512
2470
|
/** @description The input document failed input validation in some way. */
|
|
2513
|
-
HTTP422Response:
|
|
2471
|
+
HTTP422Response: {
|
|
2472
|
+
headers: {
|
|
2473
|
+
[name: string]: unknown;
|
|
2474
|
+
};
|
|
2475
|
+
content: {
|
|
2476
|
+
"application/json": {
|
|
2477
|
+
error: {
|
|
2478
|
+
/** A readable keyword describing the failure. */
|
|
2479
|
+
code: string;
|
|
2480
|
+
detail: components["schemas"]["LocationErrorList"];
|
|
2481
|
+
};
|
|
2482
|
+
};
|
|
2483
|
+
};
|
|
2484
|
+
};
|
|
2485
|
+
};
|
|
2486
|
+
parameters: {
|
|
2487
|
+
/** @description The flow ID */
|
|
2488
|
+
flow_id: string;
|
|
2489
|
+
/** @description The run ID */
|
|
2490
|
+
run_id: string;
|
|
2514
2491
|
/**
|
|
2515
|
-
* @description
|
|
2516
|
-
*
|
|
2517
|
-
*
|
|
2492
|
+
* @description Given a pair of comma-separated ISO 8601 datetime strings,
|
|
2493
|
+
* filter results to only those runs which completed execution
|
|
2494
|
+
* within the specified range.
|
|
2518
2495
|
*
|
|
2519
|
-
*
|
|
2496
|
+
* If one of the dates is omitted, it forms an open range.
|
|
2497
|
+
* For example, if the filter has a datetime followed by a comma (`"DT,"`),
|
|
2498
|
+
* all records with a date greater then or equal to `DT` will be returned.
|
|
2499
|
+
* Similarly, if the filter has a comma followed by a datetime (`",DT"`),
|
|
2500
|
+
* all records with dates less than `DT` will be returned.
|
|
2501
|
+
* If there is no comma, it is treated in the same way as `"DT,"`, above.
|
|
2502
|
+
*
|
|
2503
|
+
* Results will contain runs which completed between the first datetime
|
|
2504
|
+
* onwards, up to (but not including) the second datetime.
|
|
2505
|
+
*
|
|
2506
|
+
* Note that runs which are still executing will not have a completion time
|
|
2507
|
+
* and will be automatically excluded if this filter is applied.
|
|
2508
|
+
*
|
|
2509
|
+
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
2520
2510
|
*/
|
|
2521
|
-
|
|
2511
|
+
filter_completion_time: string;
|
|
2522
2512
|
/**
|
|
2523
|
-
* @description
|
|
2524
|
-
*
|
|
2525
|
-
*
|
|
2526
|
-
*
|
|
2513
|
+
* @description Given a pair of comma separated ISO 8601 date/time strings,
|
|
2514
|
+
* filter results to only those runs which started execution
|
|
2515
|
+
* within the specified range.
|
|
2516
|
+
*
|
|
2517
|
+
* If one of the dates is omitted, it forms an open range.
|
|
2518
|
+
* For example, if the filter has a datetime followed by a comma (`"DT,"`),
|
|
2519
|
+
* all records with a date greater then or equal to `DT` will be returned.
|
|
2520
|
+
* Similarly, if the filter has a comma followed by a datetime (`",DT"`),
|
|
2521
|
+
* all records with dates less than `DT` will be returned.
|
|
2522
|
+
* If there is no comma, it is treated in the same way as `"DT,"`, above.
|
|
2523
|
+
*
|
|
2524
|
+
* Results will contain runs which began between the first datetime
|
|
2525
|
+
* onwards, up to (but not including) the second datetime.
|
|
2526
|
+
*
|
|
2527
|
+
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
2528
|
+
*/
|
|
2529
|
+
filter_start_time: string;
|
|
2530
|
+
/**
|
|
2531
|
+
* @description Ordering criteria to apply to the list of flows.
|
|
2532
|
+
*
|
|
2533
|
+
* This field is a comma-separated list of sort criteria,
|
|
2534
|
+
* and follows this syntax:
|
|
2535
|
+
*
|
|
2536
|
+
* ```
|
|
2537
|
+
* CRITERION1[,CRITERION2[,...]]
|
|
2538
|
+
* ```
|
|
2539
|
+
*
|
|
2540
|
+
* and each individual `CRITERION` follows this syntax:
|
|
2541
|
+
*
|
|
2542
|
+
* ```
|
|
2543
|
+
* FIELD ORDERING
|
|
2544
|
+
* ```
|
|
2545
|
+
*
|
|
2546
|
+
* The first value, `FIELD`, indicates the field to sort by;
|
|
2547
|
+
* the second value, `ORDERING`, indicates the sorting order.
|
|
2548
|
+
*
|
|
2549
|
+
* When additional comma-separated criteria are added,
|
|
2550
|
+
* the first criterion will be used to sort the data;
|
|
2551
|
+
* subsequent criteria will be applied for ties.
|
|
2552
|
+
*
|
|
2553
|
+
* Supported fields are:
|
|
2554
|
+
*
|
|
2555
|
+
* - `id`
|
|
2556
|
+
* - `scope_string`
|
|
2557
|
+
* - `flow_owner`
|
|
2558
|
+
* - `flow_administrators`
|
|
2559
|
+
* - `title`
|
|
2560
|
+
* - `created_at`
|
|
2561
|
+
* - `updated_at`
|
|
2562
|
+
*
|
|
2563
|
+
* Supported orderings are:
|
|
2527
2564
|
*
|
|
2528
|
-
*
|
|
2565
|
+
* - `ASC`
|
|
2566
|
+
* - `DESC`
|
|
2567
|
+
*
|
|
2568
|
+
* @example [
|
|
2569
|
+
* "title ASC",
|
|
2570
|
+
* "id DESC"
|
|
2571
|
+
* ]
|
|
2572
|
+
*/
|
|
2573
|
+
list_flows_orderby: string[];
|
|
2574
|
+
/**
|
|
2575
|
+
* @description Ordering criteria to apply to the list of runs.
|
|
2576
|
+
*
|
|
2577
|
+
* This field is a comma-separated list of sort criteria,
|
|
2578
|
+
* and follows this syntax:
|
|
2579
|
+
*
|
|
2580
|
+
* ```
|
|
2581
|
+
* CRITERION1[,CRITERION2[,...]]
|
|
2582
|
+
* ```
|
|
2583
|
+
*
|
|
2584
|
+
* and each individual `CRITERION` follows this syntax:
|
|
2585
|
+
*
|
|
2586
|
+
* ```
|
|
2587
|
+
* FIELD ORDERING
|
|
2588
|
+
* ```
|
|
2589
|
+
*
|
|
2590
|
+
* The first value, `FIELD`, indicates the field to sort by;
|
|
2591
|
+
* the second value, `ORDERING`, indicates the sorting order.
|
|
2592
|
+
*
|
|
2593
|
+
* When additional comma-separated criteria are added,
|
|
2594
|
+
* the first criterion will be used to sort the data;
|
|
2595
|
+
* subsequent criteria will be applied for ties.
|
|
2596
|
+
*
|
|
2597
|
+
* Supported fields are:
|
|
2598
|
+
*
|
|
2599
|
+
* - `id`
|
|
2600
|
+
* - `start_time`
|
|
2601
|
+
* - `completion_time`
|
|
2602
|
+
* - `status`
|
|
2603
|
+
* - `label`
|
|
2604
|
+
*
|
|
2605
|
+
* Supported orderings are:
|
|
2606
|
+
*
|
|
2607
|
+
* - `ASC`
|
|
2608
|
+
* - `DESC`
|
|
2609
|
+
*
|
|
2610
|
+
* @example [
|
|
2611
|
+
* "start_time ASC",
|
|
2612
|
+
* "id DESC"
|
|
2613
|
+
* ]
|
|
2529
2614
|
*/
|
|
2530
|
-
|
|
2615
|
+
list_runs_orderby: string[];
|
|
2531
2616
|
};
|
|
2532
|
-
responses: never;
|
|
2533
|
-
parameters: never;
|
|
2534
2617
|
requestBodies: never;
|
|
2535
2618
|
headers: never;
|
|
2536
2619
|
pathItems: never;
|