@globus/sdk 6.1.0 → 6.2.0-next.9.9c8bf24

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 (50) hide show
  1. package/dist/cjs/core/authorization/index.js +1 -1
  2. package/dist/cjs/core/authorization/index.js.map +1 -1
  3. package/dist/cjs/core/info/index.js +1 -1
  4. package/dist/cjs/core/info/index.js.map +1 -1
  5. package/dist/cjs/index.js +246 -120
  6. package/dist/cjs/index.js.map +4 -4
  7. package/dist/cjs/services/globus-connect-server/client.js +1 -1
  8. package/dist/cjs/services/globus-connect-server/client.js.map +1 -1
  9. package/dist/esm/core/info/version.d.ts +1 -1
  10. package/dist/esm/core/info/version.js +1 -1
  11. package/dist/esm/open-api/types/compute.d.ts +356 -88
  12. package/dist/esm/open-api/types/compute.d.ts.map +1 -1
  13. package/dist/esm/open-api/types/flows.d.ts +210 -262
  14. package/dist/esm/open-api/types/flows.d.ts.map +1 -1
  15. package/dist/esm/open-api/types/gcs/v5.4.d.ts +2536 -2276
  16. package/dist/esm/open-api/types/gcs/v5.4.d.ts.map +1 -1
  17. package/dist/esm/open-api/types/search.d.ts +131 -65
  18. package/dist/esm/open-api/types/search.d.ts.map +1 -1
  19. package/dist/esm/open-api/types/timers.d.ts +12 -6
  20. package/dist/esm/open-api/types/timers.d.ts.map +1 -1
  21. package/dist/esm/open-api/types/transfer.d.ts +798 -0
  22. package/dist/esm/open-api/types/transfer.d.ts.map +1 -0
  23. package/dist/esm/open-api/types/transfer.js +2 -0
  24. package/dist/esm/open-api/types/transfer.js.map +1 -0
  25. package/dist/esm/package.json +1 -1
  26. package/dist/esm/services/compute/index.d.ts +1 -1
  27. package/dist/esm/services/compute/index.js +1 -1
  28. package/dist/esm/services/globus-connect-server/client.d.ts +4 -4
  29. package/dist/esm/services/globus-connect-server/client.d.ts.map +1 -1
  30. package/dist/esm/services/search/service/query.d.ts +2 -5
  31. package/dist/esm/services/search/service/query.d.ts.map +1 -1
  32. package/dist/esm/services/search/service/query.js.map +1 -1
  33. package/dist/esm/services/transfer/index.d.ts +2 -0
  34. package/dist/esm/services/transfer/index.d.ts.map +1 -1
  35. package/dist/esm/services/transfer/index.js +2 -0
  36. package/dist/esm/services/transfer/index.js.map +1 -1
  37. package/dist/esm/services/transfer/service/endpoint-search.d.ts +5 -3
  38. package/dist/esm/services/transfer/service/endpoint-search.d.ts.map +1 -1
  39. package/dist/esm/services/transfer/service/endpoint-search.js.map +1 -1
  40. package/dist/esm/services/transfer/service/stream-access-point.d.ts +23 -0
  41. package/dist/esm/services/transfer/service/stream-access-point.d.ts.map +1 -0
  42. package/dist/esm/services/transfer/service/stream-access-point.js +26 -0
  43. package/dist/esm/services/transfer/service/stream-access-point.js.map +1 -0
  44. package/dist/esm/services/transfer/service/tunnel.d.ts +75 -0
  45. package/dist/esm/services/transfer/service/tunnel.d.ts.map +1 -0
  46. package/dist/esm/services/transfer/service/tunnel.js +80 -0
  47. package/dist/esm/services/transfer/service/tunnel.js.map +1 -0
  48. package/dist/umd/globus.production.js +2 -2
  49. package/dist/umd/globus.production.js.map +4 -4
  50. package/package.json +2 -2
package/dist/esm/open-api/types/flows.d.ts CHANGED
@@ -10,21 +10,20 @@ export interface paths {
10
10
  * Retrieve all Flows
11
11
  * @description Query the Flows service for a listing of Flows available to a user
12
12
  * according to the permissions (role) they have on the Flow.
13
- *
14
13
  */
15
14
  get: {
16
15
  parameters: {
17
16
  query?: {
18
- /** @description An opaque token used to iterate through pages of returned Flows.
17
+ /**
18
+ * @description An opaque token used to iterate through pages of returned Flows.
19
19
  * If provided, all other query arguments will be ignored.
20
20
  * The marker encodes all state in a given query,
21
21
  * therefore it's unnecessary to provide query arguments
22
22
  * once an initial marker has been received.
23
- * */
23
+ */
24
24
  marker?: string;
25
25
  /**
26
26
  * @description The number of results to return in a single paged response.
27
- *
28
27
  * @example 50
29
28
  */
30
29
  per_page?: number;
@@ -38,7 +37,6 @@ export interface paths {
38
37
  * user has on the Flow dictates the operations they can perform. If
39
38
  * multiple roles are specified, the user will have at least one of the
40
39
  * specified roles on each Flow returned.
41
- *
42
40
  * @example [
43
41
  * "flow_owner",
44
42
  * "flow_viewers"
@@ -55,7 +53,6 @@ export interface paths {
55
53
  * include all Flows for which the user has "flow_viewer" role as
56
54
  * well. If not provided, only Flows for which the caller has
57
55
  * "flow_owner" role will be returned.
58
- *
59
56
  * @example flow_starter
60
57
  */
61
58
  filter_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner" | "run_manager" | "run_monitor";
@@ -64,7 +61,6 @@ export interface paths {
64
61
  * scope string fields. If multiple values are specified, each Flow
65
62
  * returned is guaranteed to contain at least one of the strings in its
66
63
  * scope strings.
67
- *
68
64
  * @example [
69
65
  * "0abc",
70
66
  * "100"
@@ -75,7 +71,6 @@ export interface paths {
75
71
  * @description Performs a case insensitive substring based search on the Flows' title
76
72
  * field. If multiple values are specified, each Flow returned
77
73
  * is guaranteed to contain at least one of the strings in its title.
78
- *
79
74
  * @example [
80
75
  * "hello",
81
76
  * "science"
@@ -87,7 +82,6 @@ export interface paths {
87
82
  * subtitle field. If multiple values are specified, each Flow returned
88
83
  * is guaranteed to contain at least one of the strings in its
89
84
  * subtitle.
90
- *
91
85
  * @example [
92
86
  * "hello",
93
87
  * "science"
@@ -99,7 +93,6 @@ export interface paths {
99
93
  * description field. If multiple values are specified, each Flow returned
100
94
  * is guaranteed to contain at least one of the strings in its
101
95
  * description.
102
- *
103
96
  * @example [
104
97
  * "hello",
105
98
  * "science"
@@ -111,7 +104,6 @@ export interface paths {
111
104
  * keywords field. If multiple values are specified, each Flow returned
112
105
  * is guaranteed to contain at least one of the substrings as a
113
106
  * keyword.
114
- *
115
107
  * @example [
116
108
  * "hello",
117
109
  * "science"
@@ -130,7 +122,6 @@ export interface paths {
130
122
  * - description
131
123
  * - id
132
124
  * - flow_administrators
133
- *
134
125
  * @example [
135
126
  * "globus"
136
127
  * ]
@@ -173,7 +164,6 @@ export interface paths {
173
164
  *
174
165
  * - `ASC`
175
166
  * - `DESC`
176
- *
177
167
  * @example [
178
168
  * "title ASC",
179
169
  * "id DESC"
@@ -187,9 +177,10 @@ export interface paths {
187
177
  };
188
178
  requestBody?: never;
189
179
  responses: {
190
- /** @description The requestor has successfully authenticated and queried the Flow's
180
+ /**
181
+ * @description The requestor has successfully authenticated and queried the Flow's
191
182
  * service for the Flows available for them.
192
- * */
183
+ */
193
184
  200: {
194
185
  headers: {
195
186
  [name: string]: unknown;
@@ -199,24 +190,23 @@ export interface paths {
199
190
  flows?: components["schemas"]["FlowResponse"][];
200
191
  /** @description The number of Flows returned. */
201
192
  limit?: number;
202
- /** @description An opaque pagination token for iterating through returned
193
+ /**
194
+ * @description An opaque pagination token for iterating through returned
203
195
  * Flows.
204
- * */
196
+ */
205
197
  marker?: string;
206
198
  has_next_page?: boolean;
207
199
  };
208
200
  };
209
201
  };
210
- /** @description There was an issue parsing the query parameters.
211
- * */
202
+ /** @description There was an issue parsing the query parameters. */
212
203
  400: {
213
204
  headers: {
214
205
  [name: string]: unknown;
215
206
  };
216
207
  content?: never;
217
208
  };
218
- /** @description The requestor presented a token with insufficient scopes.
219
- * */
209
+ /** @description The requestor presented a token with insufficient scopes. */
220
210
  403: {
221
211
  headers: {
222
212
  [name: string]: unknown;
@@ -241,24 +231,25 @@ export interface paths {
241
231
  content: {
242
232
  "application/json": {
243
233
  definition: components["schemas"]["FlowDefinition"];
244
- /** @description A non-unique, human-friendly name used for displaying the provider
234
+ /**
235
+ * @description A non-unique, human-friendly name used for displaying the provider
245
236
  * to end users.
246
- * */
237
+ */
247
238
  title?: string;
248
239
  /** @description A concise summary of the provider’s purpose. */
249
240
  subtitle?: string;
250
241
  /** @description A detailed description of the provider for end user display. */
251
242
  description?: string;
252
- /** @description A set of terms used to categorize the provider which may be used in
243
+ /**
244
+ * @description A set of terms used to categorize the provider which may be used in
253
245
  * query and discovery operations. Maximum total length of all
254
246
  * keywords is 1024 characters.
255
- * */
247
+ */
256
248
  keywords?: string[];
257
249
  /**
258
250
  * @description A set of Principal URNs, or the value "public",
259
251
  * indicating the identity of users and/or groups
260
252
  * who can view the flow.
261
- *
262
253
  * @example [
263
254
  * "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
264
255
  * "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
@@ -268,7 +259,6 @@ export interface paths {
268
259
  /**
269
260
  * @description A set of Principal URNs, or the value "all_authenticated_users",
270
261
  * indicating the identity of users who can start the flow.
271
- *
272
262
  * @example [
273
263
  * "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
274
264
  * "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
@@ -279,16 +269,16 @@ export interface paths {
279
269
  * @description The set of Principal URN values of users who may perform
280
270
  * administrative operations, including updating the description
281
271
  * itself, on the flow.
282
- *
283
272
  * @example [
284
273
  * "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
285
274
  * "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
286
275
  * ]
287
276
  */
288
277
  flow_administrators?: components["schemas"]["PrincipalURN"][];
289
- /** @description A published JSON Schema which input to the Flow must conform
278
+ /**
279
+ * @description A published JSON Schema which input to the Flow must conform
290
280
  * to.
291
- * */
281
+ */
292
282
  input_schema?: Record<string, unknown>;
293
283
  run_managers?: components["schemas"]["RunManagers"];
294
284
  run_monitors?: components["schemas"]["RunMonitors"];
@@ -298,16 +288,16 @@ export interface paths {
298
288
  *
299
289
  * If no subscription is specified, the flow may be created
300
290
  * but may have limits on how long or how much it can be used.
301
- *
302
291
  */
303
292
  subscription_id?: string;
304
293
  };
305
294
  };
306
295
  };
307
296
  responses: {
308
- /** @description The Flow definition was successfully deployed onto the Flows
297
+ /**
298
+ * @description The Flow definition was successfully deployed onto the Flows
309
299
  * service.
310
- * */
300
+ */
311
301
  201: {
312
302
  headers: {
313
303
  [name: string]: unknown;
@@ -316,16 +306,14 @@ export interface paths {
316
306
  "application/json": components["schemas"]["FlowResponse"];
317
307
  };
318
308
  };
319
- /** @description The requestor attempted to deploy a malformed Flow.
320
- * */
309
+ /** @description The requestor attempted to deploy a malformed Flow. */
321
310
  400: {
322
311
  headers: {
323
312
  [name: string]: unknown;
324
313
  };
325
314
  content?: never;
326
315
  };
327
- /** @description The requestor is not authorized to deploy a Flow.
328
- * */
316
+ /** @description The requestor is not authorized to deploy a Flow. */
329
317
  403: {
330
318
  headers: {
331
319
  [name: string]: unknown;
@@ -364,15 +352,13 @@ export interface paths {
364
352
  content: {
365
353
  "application/json": {
366
354
  definition: components["schemas"]["FlowDefinition"];
367
- /** @description A JSON Schema describing valid input to the flow.
368
- * */
355
+ /** @description A JSON Schema describing valid input to the flow. */
369
356
  input_schema?: Record<string, unknown>;
370
357
  };
371
358
  };
372
359
  };
373
360
  responses: {
374
- /** @description The flow passed all validation checks.
375
- * */
361
+ /** @description The flow passed all validation checks. */
376
362
  200: {
377
363
  headers: {
378
364
  [name: string]: unknown;
@@ -381,32 +367,28 @@ export interface paths {
381
367
  "application/json": components["schemas"]["FlowValidationResponse"];
382
368
  };
383
369
  };
384
- /** @description The requestor attempted to validate a malformed flow.
385
- * */
370
+ /** @description The requestor attempted to validate a malformed flow. */
386
371
  400: {
387
372
  headers: {
388
373
  [name: string]: unknown;
389
374
  };
390
375
  content?: never;
391
376
  };
392
- /** @description The requestor is not authorized to validate a flow.
393
- * */
377
+ /** @description The requestor is not authorized to validate a flow. */
394
378
  403: {
395
379
  headers: {
396
380
  [name: string]: unknown;
397
381
  };
398
382
  content?: never;
399
383
  };
400
- /** @description A conflict was found in the flow definition or input schema.
401
- * */
384
+ /** @description A conflict was found in the flow definition or input schema. */
402
385
  409: {
403
386
  headers: {
404
387
  [name: string]: unknown;
405
388
  };
406
389
  content?: never;
407
390
  };
408
- /** @description The flow definition or input schema failed validation checks.
409
- * */
391
+ /** @description The flow definition or input schema failed validation checks. */
410
392
  422: {
411
393
  headers: {
412
394
  [name: string]: unknown;
@@ -449,9 +431,10 @@ export interface paths {
449
431
  };
450
432
  requestBody?: never;
451
433
  responses: {
452
- /** @description The requestor has successfully authenticated and queried the Flow's
434
+ /**
435
+ * @description The requestor has successfully authenticated and queried the Flow's
453
436
  * service for a specific Flow definition.
454
- * */
437
+ */
455
438
  200: {
456
439
  headers: {
457
440
  [name: string]: unknown;
@@ -460,18 +443,20 @@ export interface paths {
460
443
  "application/json": components["schemas"]["FlowResponse"];
461
444
  };
462
445
  };
463
- /** @description The requestor attempted to retrieve a Flow definition for which they
446
+ /**
447
+ * @description The requestor attempted to retrieve a Flow definition for which they
464
448
  * did not have access.
465
- * */
449
+ */
466
450
  403: {
467
451
  headers: {
468
452
  [name: string]: unknown;
469
453
  };
470
454
  content?: never;
471
455
  };
472
- /** @description The requestor attempted to retrieve a non-existent Flow, or the
456
+ /**
457
+ * @description The requestor attempted to retrieve a non-existent Flow, or the
473
458
  * requestor did not have permissions to view a Flow.
474
- * */
459
+ */
475
460
  404: {
476
461
  headers: {
477
462
  [name: string]: unknown;
@@ -498,35 +483,36 @@ export interface paths {
498
483
  content: {
499
484
  "application/json": {
500
485
  definition?: components["schemas"]["FlowDefinition"];
501
- /** @description A JSON schema document.
486
+ /**
487
+ * @description A JSON schema document.
502
488
  *
503
489
  * When starting the flow, input keys and values must conform to the schema.
504
490
  * The Globus Web App uses the input schema to created a guided input page when starting the flow.
505
- * */
491
+ */
506
492
  input_schema?: Record<string, unknown>;
507
- /** @description A non-unique, human-friendly name used for displaying the flow to end users.
508
- * */
493
+ /** @description A non-unique, human-friendly name used for displaying the flow to end users. */
509
494
  title?: string;
510
- /** @description A short summary of the flow's purpose or functionality.
511
- * */
495
+ /** @description A short summary of the flow's purpose or functionality. */
512
496
  subtitle?: string;
513
- /** @description Arbitrary text to describe the Flow.
514
- * */
497
+ /** @description Arbitrary text to describe the Flow. */
515
498
  description?: string;
516
- /** @description If provided, the value must be the calling user's Globus Auth identity URN,
499
+ /**
500
+ * @description If provided, the value must be the calling user's Globus Auth identity URN,
517
501
  * and the user must be a flow administrator.
518
502
  *
519
503
  * It is not possible for non-administrators to take ownership of a flow.
520
504
  * Also, it is currently not possible to assign ownership to another user.
521
- * */
505
+ */
522
506
  flow_owner?: string;
523
- /** @description A list of Globus Auth identity and group URNs that may administer the flow.
507
+ /**
508
+ * @description A list of Globus Auth identity and group URNs that may administer the flow.
524
509
  *
525
510
  * Flow administrators are able to see the full flow definition,
526
511
  * including any parameters listed in a "__Private_Parameters" value.
527
- * */
512
+ */
528
513
  flow_administrators?: string[];
529
- /** @description A list of Globus Auth identity and group URNs that may start the flow.
514
+ /**
515
+ * @description A list of Globus Auth identity and group URNs that may start the flow.
530
516
  *
531
517
  * It is possible to make a flow available for use to all authenticated users
532
518
  * -- including those outside your organization or domain --
@@ -534,9 +520,10 @@ export interface paths {
534
520
  *
535
521
  * Parameters listed in "__Private_Parameters" values in the definition
536
522
  * will be removed from the definition when it is viewed by a flow starter.
537
- * */
523
+ */
538
524
  flow_starters?: string[];
539
- /** @description A list of Globus Auth identity and group URNs that may see the flow,
525
+ /**
526
+ * @description A list of Globus Auth identity and group URNs that may see the flow,
540
527
  * including its definition and input schema.
541
528
  *
542
529
  * It is possible to make a flow available for viewing to all users
@@ -545,10 +532,9 @@ export interface paths {
545
532
  *
546
533
  * Parameters listed in "__Private_Parameters" values in the definition
547
534
  * will be removed from the definition when it is viewed by a flow starter.
548
- * */
535
+ */
549
536
  flow_viewers?: string[];
550
- /** @description A list of keywords that can be used for grouping or identifying flows.
551
- * */
537
+ /** @description A list of keywords that can be used for grouping or identifying flows. */
552
538
  keywords?: string[];
553
539
  run_managers?: components["schemas"]["RunManagers"];
554
540
  run_monitors?: components["schemas"]["RunMonitors"];
@@ -557,9 +543,10 @@ export interface paths {
557
543
  };
558
544
  };
559
545
  responses: {
560
- /** @description The requestor has successfully authenticated and updated the target
546
+ /**
547
+ * @description The requestor has successfully authenticated and updated the target
561
548
  * Flow definition.
562
- * */
549
+ */
563
550
  200: {
564
551
  headers: {
565
552
  [name: string]: unknown;
@@ -568,27 +555,30 @@ export interface paths {
568
555
  "application/json": components["schemas"]["FlowResponse"];
569
556
  };
570
557
  };
571
- /** @description The Flow definition update failed due to an attempt to perform a
558
+ /**
559
+ * @description The Flow definition update failed due to an attempt to perform a
572
560
  * malformed update.
573
- * */
561
+ */
574
562
  400: {
575
563
  headers: {
576
564
  [name: string]: unknown;
577
565
  };
578
566
  content?: never;
579
567
  };
580
- /** @description The requestor attempted to update a Flow for which they did not have
568
+ /**
569
+ * @description The requestor attempted to update a Flow for which they did not have
581
570
  * access.
582
- * */
571
+ */
583
572
  403: {
584
573
  headers: {
585
574
  [name: string]: unknown;
586
575
  };
587
576
  content?: never;
588
577
  };
589
- /** @description The requestor attempted to update a non-existent Flow, or the
578
+ /**
579
+ * @description The requestor attempted to update a non-existent Flow, or the
590
580
  * requestor did not have permissions to update a Flow.
591
- * */
581
+ */
592
582
  404: {
593
583
  headers: {
594
584
  [name: string]: unknown;
@@ -614,9 +604,10 @@ export interface paths {
614
604
  };
615
605
  requestBody?: never;
616
606
  responses: {
617
- /** @description The requestor has successfully removed the Flow from the Flows
607
+ /**
608
+ * @description The requestor has successfully removed the Flow from the Flows
618
609
  * service.
619
- * */
610
+ */
620
611
  200: {
621
612
  headers: {
622
613
  [name: string]: unknown;
@@ -625,18 +616,20 @@ export interface paths {
625
616
  "application/json": components["schemas"]["FlowResponse"];
626
617
  };
627
618
  };
628
- /** @description The requestor attempted to modify a Flow for which they did not have
619
+ /**
620
+ * @description The requestor attempted to modify a Flow for which they did not have
629
621
  * access.
630
- * */
622
+ */
631
623
  403: {
632
624
  headers: {
633
625
  [name: string]: unknown;
634
626
  };
635
627
  content?: never;
636
628
  };
637
- /** @description The requestor attempted to remove a non-existent Flow, or the
629
+ /**
630
+ * @description The requestor attempted to remove a non-existent Flow, or the
638
631
  * requestor did not have permissions to remove the Flow.
639
- * */
632
+ */
640
633
  404: {
641
634
  headers: {
642
635
  [name: string]: unknown;
@@ -698,25 +691,24 @@ export interface paths {
698
691
  "application/json": components["schemas"]["FlowRun"];
699
692
  };
700
693
  };
701
- /** @description The Run's input failed validation against the Flow's input schema.
702
- * */
694
+ /** @description The Run's input failed validation against the Flow's input schema. */
703
695
  400: {
704
696
  headers: {
705
697
  [name: string]: unknown;
706
698
  };
707
699
  content?: never;
708
700
  };
709
- /** @description The requestor presented a token with insufficient scopes.
710
- * */
701
+ /** @description The requestor presented a token with insufficient scopes. */
711
702
  403: {
712
703
  headers: {
713
704
  [name: string]: unknown;
714
705
  };
715
706
  content?: never;
716
707
  };
717
- /** @description The requestor did not have access to run the provided Flow, or the
708
+ /**
709
+ * @description The requestor did not have access to run the provided Flow, or the
718
710
  * Flow does not exist.
719
- * */
711
+ */
720
712
  404: {
721
713
  headers: {
722
714
  [name: string]: unknown;
@@ -730,19 +722,21 @@ export interface paths {
730
722
  };
731
723
  content?: never;
732
724
  };
733
- /** @description An upstream service has imposed rate limiting.
725
+ /**
726
+ * @description An upstream service has imposed rate limiting.
734
727
  * The requestor may resubmit the API request.
735
- * */
728
+ */
736
729
  429: {
737
730
  headers: {
738
731
  [name: string]: unknown;
739
732
  };
740
733
  content?: never;
741
734
  };
742
- /** @description An upstream service returned an uncorrectable error.
735
+ /**
736
+ * @description An upstream service returned an uncorrectable error.
743
737
  * The error may or may not occur if the API request is submitted again.
744
738
  * It may be possible to resubmit the API request.
745
- * */
739
+ */
746
740
  502: {
747
741
  headers: {
748
742
  [name: string]: unknown;
@@ -777,7 +771,6 @@ export interface paths {
777
771
  *
778
772
  * If validation passes, then it is likely that the flow can be started
779
773
  * with the same inputs and Globus Auth token.
780
- *
781
774
  */
782
775
  post: {
783
776
  parameters: {
@@ -802,11 +795,12 @@ export interface paths {
802
795
  };
803
796
  };
804
797
  responses: {
805
- /** @description The inputs and Globus Auth token passed validation.
798
+ /**
799
+ * @description The inputs and Globus Auth token passed validation.
806
800
  *
807
801
  * It is likely that the user or client will be able to start the flow
808
802
  * using the same Globus Auth token and input values.
809
- * */
803
+ */
810
804
  200: {
811
805
  headers: {
812
806
  [name: string]: unknown;
@@ -815,17 +809,17 @@ export interface paths {
815
809
  "application/json": components["schemas"]["ValidateRun"];
816
810
  };
817
811
  };
818
- /** @description The input body failed validation against the flow's input schema.
819
- * */
812
+ /** @description The input body failed validation against the flow's input schema. */
820
813
  400: {
821
814
  headers: {
822
815
  [name: string]: unknown;
823
816
  };
824
817
  content?: never;
825
818
  };
826
- /** @description The user or client is not allowed to run the flow,
819
+ /**
820
+ * @description The user or client is not allowed to run the flow,
827
821
  * or the Globus Auth token is missing required scopes.
828
- * */
822
+ */
829
823
  403: {
830
824
  headers: {
831
825
  [name: string]: unknown;
@@ -877,54 +871,60 @@ export interface paths {
877
871
  "application/json": components["schemas"]["FlowRun"];
878
872
  };
879
873
  };
880
- /** @description The requestor is not authorized to access the run or flow,
874
+ /**
875
+ * @description The requestor is not authorized to access the run or flow,
881
876
  * or has not provided access tokens with sufficient privileges.
882
- * */
877
+ */
883
878
  403: {
884
879
  headers: {
885
880
  [name: string]: unknown;
886
881
  };
887
882
  content?: never;
888
883
  };
889
- /** @description The requested Run or Flow was not found. Or, the requestor did not
884
+ /**
885
+ * @description The requested Run or Flow was not found. Or, the requestor did not
890
886
  * have access to view the Run.
891
- * */
887
+ */
892
888
  404: {
893
889
  headers: {
894
890
  [name: string]: unknown;
895
891
  };
896
892
  content?: never;
897
893
  };
898
- /** @description The requestor attempted to remove the state for a Run which had
894
+ /**
895
+ * @description The requestor attempted to remove the state for a Run which had
899
896
  * not yet reached a completed status.
900
- * */
897
+ */
901
898
  409: {
902
899
  headers: {
903
900
  [name: string]: unknown;
904
901
  };
905
902
  content?: never;
906
903
  };
907
- /** @description An upstream service rate-limited the request to release the Run.
904
+ /**
905
+ * @description An upstream service rate-limited the request to release the Run.
908
906
  * The requestor may re-submit the request at a later time.
909
- * */
907
+ */
910
908
  429: {
911
909
  headers: {
912
910
  [name: string]: unknown;
913
911
  };
914
912
  content?: never;
915
913
  };
916
- /** @description The run is in an unexpected state in the Flows service.
914
+ /**
915
+ * @description The run is in an unexpected state in the Flows service.
917
916
  * Please contact Globus support.
918
- * */
917
+ */
919
918
  500: {
920
919
  headers: {
921
920
  [name: string]: unknown;
922
921
  };
923
922
  content?: never;
924
923
  };
925
- /** @description A request to an upstream service failed for an unknown reason.
924
+ /**
925
+ * @description A request to an upstream service failed for an unknown reason.
926
926
  * The requestor can re-submit the request or contact Globus support.
927
- * */
927
+ */
928
928
  502: {
929
929
  headers: {
930
930
  [name: string]: unknown;
@@ -983,7 +983,6 @@ export interface paths {
983
983
  * progress. Performing the resume operation may simply cause a
984
984
  * poll to happen more quickly and thus allow the Action to
985
985
  * resume more quickly.
986
- *
987
986
  */
988
987
  post: {
989
988
  parameters: {
@@ -1008,9 +1007,10 @@ export interface paths {
1008
1007
  "application/json": components["schemas"]["FlowRun"];
1009
1008
  };
1010
1009
  };
1011
- /** @description The requested Run or Flow was not found. Or, the requestor did not
1010
+ /**
1011
+ * @description The requested Run or Flow was not found. Or, the requestor did not
1012
1012
  * have access to manage the Run.
1013
- * */
1013
+ */
1014
1014
  404: {
1015
1015
  headers: {
1016
1016
  [name: string]: unknown;
@@ -1063,18 +1063,20 @@ export interface paths {
1063
1063
  "application/json": components["schemas"]["FlowRun"];
1064
1064
  };
1065
1065
  };
1066
- /** @description The requested Run or Flow was not found. Or, the requestor did not
1066
+ /**
1067
+ * @description The requested Run or Flow was not found. Or, the requestor did not
1067
1068
  * have access to view the Run.
1068
- * */
1069
+ */
1069
1070
  404: {
1070
1071
  headers: {
1071
1072
  [name: string]: unknown;
1072
1073
  };
1073
1074
  content?: never;
1074
1075
  };
1075
- /** @description The service encountered an Upstream error when attempting to cancel
1076
+ /**
1077
+ * @description The service encountered an Upstream error when attempting to cancel
1076
1078
  * the Run.
1077
- * */
1079
+ */
1078
1080
  502: {
1079
1081
  headers: {
1080
1082
  [name: string]: unknown;
@@ -1094,11 +1096,9 @@ export interface paths {
1094
1096
  query?: {
1095
1097
  /** @description An integer limit on the number of log records returned. */
1096
1098
  limit?: number;
1097
- /** @description A flag to indicate if log records should be returned in reverse order.
1098
- * */
1099
+ /** @description A flag to indicate if log records should be returned in reverse order. */
1099
1100
  reverse_order?: boolean;
1100
- /** @description A token used to iterate through pages of returned log records.
1101
- * */
1101
+ /** @description A token used to iterate through pages of returned log records. */
1102
1102
  pagination_token?: string;
1103
1103
  };
1104
1104
  header?: never;
@@ -1113,18 +1113,15 @@ export interface paths {
1113
1113
  /**
1114
1114
  * Get execution details on a Run
1115
1115
  * @description Retrieve detailed execution information for a particular Flow Run
1116
- *
1117
1116
  */
1118
1117
  get: {
1119
1118
  parameters: {
1120
1119
  query?: {
1121
1120
  /** @description An integer limit on the number of log records returned. */
1122
1121
  limit?: number;
1123
- /** @description A flag to indicate if log records should be returned in reverse order.
1124
- * */
1122
+ /** @description A flag to indicate if log records should be returned in reverse order. */
1125
1123
  reverse_order?: boolean;
1126
- /** @description A token used to iterate through pages of returned log records.
1127
- * */
1124
+ /** @description A token used to iterate through pages of returned log records. */
1128
1125
  pagination_token?: string;
1129
1126
  };
1130
1127
  header?: never;
@@ -1147,27 +1144,28 @@ export interface paths {
1147
1144
  "application/json": {
1148
1145
  /** @description The number of log states returned. */
1149
1146
  limit: number;
1150
- /** @description An opaque pagination token for iterating through returned
1147
+ /**
1148
+ * @description An opaque pagination token for iterating through returned
1151
1149
  * records. If there are no more entries, this field will not
1152
1150
  * exist.
1153
- * */
1151
+ */
1154
1152
  marker?: string;
1155
1153
  has_next_page: boolean;
1156
1154
  entries: Record<string, unknown>[];
1157
1155
  };
1158
1156
  };
1159
1157
  };
1160
- /** @description There was an issue parsing the query parameters.
1161
- * */
1158
+ /** @description There was an issue parsing the query parameters. */
1162
1159
  400: {
1163
1160
  headers: {
1164
1161
  [name: string]: unknown;
1165
1162
  };
1166
1163
  content?: never;
1167
1164
  };
1168
- /** @description The requested Action or Flow was not found. Or, the
1165
+ /**
1166
+ * @description The requested Action or Flow was not found. Or, the
1169
1167
  * requestor did not have access to view the Action.
1170
- * */
1168
+ */
1171
1169
  404: {
1172
1170
  headers: {
1173
1171
  [name: string]: unknown;
@@ -1201,17 +1199,17 @@ export interface paths {
1201
1199
  * the *\/actions endpoint, the response will list the Runs under a
1202
1200
  * "actions" key. If hitting the *\/runs endpoint, the response will list
1203
1201
  * the Runs under a "runs" key.
1204
- *
1205
1202
  */
1206
1203
  get: {
1207
1204
  parameters: {
1208
1205
  query?: {
1209
- /** @description An opaque token used to iterate through pages of returned Actions.
1206
+ /**
1207
+ * @description An opaque token used to iterate through pages of returned Actions.
1210
1208
  * If provided, all other query arguments will be ignored.
1211
1209
  * The marker encodes all state in a given query,
1212
1210
  * therefore it's unnecessary to provide query arguments
1213
1211
  * once an initial marker has been received.
1214
- * */
1212
+ */
1215
1213
  marker?: string;
1216
1214
  /**
1217
1215
  * @deprecated
@@ -1221,12 +1219,10 @@ export interface paths {
1221
1219
  * pagination_token encodes all state in a given query, therefore it's
1222
1220
  * unnecessary to provide query arguments once an initial token has been
1223
1221
  * received.
1224
- *
1225
1222
  */
1226
1223
  pagination_token?: string;
1227
1224
  /**
1228
1225
  * @description The number of results to return in a single paged response.
1229
- *
1230
1226
  * @example 50
1231
1227
  */
1232
1228
  per_page?: number;
@@ -1240,7 +1236,6 @@ export interface paths {
1240
1236
  * user has on the Action dictates the operations they can perform.
1241
1237
  * If multiple roles are specified, the user will have at least one of
1242
1238
  * the specified roles on each Action returned.
1243
- *
1244
1239
  * @example [
1245
1240
  * "run_manager"
1246
1241
  * ]
@@ -1256,7 +1251,6 @@ export interface paths {
1256
1251
  * manager will also include all Actions for which the user
1257
1252
  * has "run_monitor" role as well. If not provided, only Actions
1258
1253
  * for which the caller has "run_owner" role will be returned.
1259
- *
1260
1254
  * @example [
1261
1255
  * "run_manager"
1262
1256
  * ]
@@ -1268,7 +1262,6 @@ export interface paths {
1268
1262
  * multiple statuses are specified, each Action returned will be in one
1269
1263
  * of the specified states. By default, Actions in any state will be
1270
1264
  * returned.
1271
- *
1272
1265
  * @example [
1273
1266
  * "FAILED",
1274
1267
  * "INACTIVE"
@@ -1279,7 +1272,6 @@ export interface paths {
1279
1272
  * @description Performs a case insensitive string based search on the Actions'
1280
1273
  * label fields. If multiple values are specified, each Action returned
1281
1274
  * is guaranteed to contain at least one of the strings in its label.
1282
- *
1283
1275
  * @example [
1284
1276
  * "science",
1285
1277
  * "tests"
@@ -1303,7 +1295,6 @@ export interface paths {
1303
1295
  *
1304
1296
  * Note that runs which are still executing will not have a completion time
1305
1297
  * and will be automatically excluded if this filter is applied.
1306
- *
1307
1298
  * @example 2021-03-09T21:52:14,2021-03-09T21:53
1308
1299
  */
1309
1300
  filter_completion_time?: components["parameters"]["filter_completion_time"];
@@ -1321,7 +1312,6 @@ export interface paths {
1321
1312
  *
1322
1313
  * Results will contain runs which began between the first datetime
1323
1314
  * onwards, up to (but not including) the second datetime.
1324
- *
1325
1315
  * @example 2021-03-09T21:52:14,2021-03-09T21:53
1326
1316
  */
1327
1317
  filter_start_time?: components["parameters"]["filter_start_time"];
@@ -1360,7 +1350,6 @@ export interface paths {
1360
1350
  *
1361
1351
  * - `ASC`
1362
1352
  * - `DESC`
1363
- *
1364
1353
  * @example [
1365
1354
  * "start_time ASC",
1366
1355
  * "id DESC"
@@ -1384,27 +1373,28 @@ export interface paths {
1384
1373
  };
1385
1374
  content: {
1386
1375
  "application/json": {
1387
- /** @description An opaque pagination token for iterating through returned
1376
+ /**
1377
+ * @description An opaque pagination token for iterating through returned
1388
1378
  * Actions. If there are no more entries, this field will not
1389
1379
  * exist.
1390
- * */
1380
+ */
1391
1381
  marker?: string;
1392
1382
  has_next_page: boolean;
1393
1383
  actions: components["schemas"]["FlowRun"][];
1394
1384
  };
1395
1385
  };
1396
1386
  };
1397
- /** @description The requestor presented a token with insufficient scopes.
1398
- * */
1387
+ /** @description The requestor presented a token with insufficient scopes. */
1399
1388
  403: {
1400
1389
  headers: {
1401
1390
  [name: string]: unknown;
1402
1391
  };
1403
1392
  content?: never;
1404
1393
  };
1405
- /** @description The Flow does not exist or the requestor did not have access to
1394
+ /**
1395
+ * @description The Flow does not exist or the requestor did not have access to
1406
1396
  * enumerate the Flow's Actions.
1407
- * */
1397
+ */
1408
1398
  404: {
1409
1399
  headers: {
1410
1400
  [name: string]: unknown;
@@ -1434,17 +1424,17 @@ export interface paths {
1434
1424
  * the *\/actions endpoint, the response will list the Runs under a
1435
1425
  * "actions" key. If hitting the *\/runs endpoint, the response will list
1436
1426
  * the Runs under a "runs" key.
1437
- *
1438
1427
  */
1439
1428
  get: {
1440
1429
  parameters: {
1441
1430
  query?: {
1442
- /** @description An opaque token used to iterate through pages of returned Actions.
1431
+ /**
1432
+ * @description An opaque token used to iterate through pages of returned Actions.
1443
1433
  * If provided, all other query arguments will be ignored.
1444
1434
  * The marker encodes all state in a given query,
1445
1435
  * therefore it's unnecessary to provide query arguments
1446
1436
  * once an initial marker has been received.
1447
- * */
1437
+ */
1448
1438
  marker?: string;
1449
1439
  /**
1450
1440
  * @deprecated
@@ -1454,12 +1444,10 @@ export interface paths {
1454
1444
  * pagination_token encodes all state in a given query, therefore it's
1455
1445
  * unnecessary to provide query arguments once an initial token has been
1456
1446
  * received.
1457
- *
1458
1447
  */
1459
1448
  pagination_token?: string;
1460
1449
  /**
1461
1450
  * @description The number of results to return in a single paged response.
1462
- *
1463
1451
  * @example 50
1464
1452
  */
1465
1453
  per_page?: number;
@@ -1473,7 +1461,6 @@ export interface paths {
1473
1461
  * user has on the Action dictates the operations they can perform.
1474
1462
  * If multiple roles are specified, the user will have at least one of
1475
1463
  * the specified roles on each Action returned.
1476
- *
1477
1464
  * @example [
1478
1465
  * "run_owner",
1479
1466
  * "run_managers"
@@ -1490,7 +1477,6 @@ export interface paths {
1490
1477
  * manager will also include all Runs for which the user
1491
1478
  * has "run_monitor" role as well. If not provided, only Runs
1492
1479
  * for which the caller has "run_owner" role will be returned.
1493
- *
1494
1480
  * @example run_manager
1495
1481
  */
1496
1482
  filter_role?: "run_monitor" | "run_manager" | "run_owner";
@@ -1500,7 +1486,6 @@ export interface paths {
1500
1486
  * multiple statuses are specified, each Action returned will be in one
1501
1487
  * of the specified states. By default, Actions in any state will be
1502
1488
  * returned.
1503
- *
1504
1489
  * @example [
1505
1490
  * "FAILED",
1506
1491
  * "INACTIVE"
@@ -1511,7 +1496,6 @@ export interface paths {
1511
1496
  * @description Performs a case insensitive string based search on the Actions'
1512
1497
  * label fields. If multiple values are specified, each Action returned
1513
1498
  * is guaranteed to contain at least one of the strings in its label.
1514
- *
1515
1499
  * @example [
1516
1500
  * "science",
1517
1501
  * "tests"
@@ -1523,7 +1507,6 @@ export interface paths {
1523
1507
  * Actions which have parent Flow's with a matching title(s). If
1524
1508
  * multiple values are specified, each Action returned will have a
1525
1509
  * parent Flow with a title matching at least one of the strings.
1526
- *
1527
1510
  * @example [
1528
1511
  * "globus",
1529
1512
  * "tests"
@@ -1535,7 +1518,6 @@ export interface paths {
1535
1518
  * initiated from the specified Flow ID(s). If multiple values are
1536
1519
  * specified, each Run returned will have been initiated from at least
1537
1520
  * one of the specified Flow IDs.
1538
- *
1539
1521
  * @example [
1540
1522
  * "00000000-19d9-4f5b-9329-22ed12d4d3dd",
1541
1523
  * "11111111-19a5-4d19-998e-0709c40321e9"
@@ -1559,7 +1541,6 @@ export interface paths {
1559
1541
  *
1560
1542
  * Note that runs which are still executing will not have a completion time
1561
1543
  * and will be automatically excluded if this filter is applied.
1562
- *
1563
1544
  * @example 2021-03-09T21:52:14,2021-03-09T21:53
1564
1545
  */
1565
1546
  filter_completion_time?: components["parameters"]["filter_completion_time"];
@@ -1577,7 +1558,6 @@ export interface paths {
1577
1558
  *
1578
1559
  * Results will contain runs which began between the first datetime
1579
1560
  * onwards, up to (but not including) the second datetime.
1580
- *
1581
1561
  * @example 2021-03-09T21:52:14,2021-03-09T21:53
1582
1562
  */
1583
1563
  filter_start_time?: components["parameters"]["filter_start_time"];
@@ -1616,7 +1596,6 @@ export interface paths {
1616
1596
  *
1617
1597
  * - `ASC`
1618
1598
  * - `DESC`
1619
- *
1620
1599
  * @example [
1621
1600
  * "start_time ASC",
1622
1601
  * "id DESC"
@@ -1637,10 +1616,11 @@ export interface paths {
1637
1616
  };
1638
1617
  content: {
1639
1618
  "application/json": {
1640
- /** @description An opaque pagination token for iterating through returned
1619
+ /**
1620
+ * @description An opaque pagination token for iterating through returned
1641
1621
  * Actions. If there are no more entries, this field will not
1642
1622
  * exist.
1643
- * */
1623
+ */
1644
1624
  marker?: string;
1645
1625
  has_next_page: boolean;
1646
1626
  actions?: components["schemas"]["FlowRun"][];
@@ -1648,17 +1628,17 @@ export interface paths {
1648
1628
  };
1649
1629
  };
1650
1630
  };
1651
- /** @description The requestor presented a token with insufficient scopes.
1652
- * */
1631
+ /** @description The requestor presented a token with insufficient scopes. */
1653
1632
  403: {
1654
1633
  headers: {
1655
1634
  [name: string]: unknown;
1656
1635
  };
1657
1636
  content?: never;
1658
1637
  };
1659
- /** @description The Flow does not exist or the requestor did not have access to
1638
+ /**
1639
+ * @description The Flow does not exist or the requestor did not have access to
1660
1640
  * enumerate the Actions.
1661
- * */
1641
+ */
1662
1642
  404: {
1663
1643
  headers: {
1664
1644
  [name: string]: unknown;
@@ -1688,7 +1668,6 @@ export interface paths {
1688
1668
  /**
1689
1669
  * Get details about a run
1690
1670
  * @description Get details about a run.
1691
- *
1692
1671
  */
1693
1672
  get: {
1694
1673
  parameters: {
@@ -1696,7 +1675,6 @@ export interface paths {
1696
1675
  /**
1697
1676
  * @description If present and set to a true value,
1698
1677
  * metadata about the associated flow will be included.
1699
- *
1700
1678
  * @example true
1701
1679
  */
1702
1680
  include_flow_description?: true | true | false | false;
@@ -1719,17 +1697,17 @@ export interface paths {
1719
1697
  "application/json": components["schemas"]["FlowRunWithFlowEmbed"];
1720
1698
  };
1721
1699
  };
1722
- /** @description The requestor presented a token with insufficient scopes.
1723
- * */
1700
+ /** @description The requestor presented a token with insufficient scopes. */
1724
1701
  403: {
1725
1702
  headers: {
1726
1703
  [name: string]: unknown;
1727
1704
  };
1728
1705
  content?: never;
1729
1706
  };
1730
- /** @description The Run does not exist or the requestor did not have access to
1707
+ /**
1708
+ * @description The Run does not exist or the requestor did not have access to
1731
1709
  * view the Run's status.
1732
- * */
1710
+ */
1733
1711
  404: {
1734
1712
  headers: {
1735
1713
  [name: string]: unknown;
@@ -1745,7 +1723,6 @@ export interface paths {
1745
1723
  * By default only the Run initiator is able to modify a Run's metadata.
1746
1724
  * Note that delegating manage access to a principal will allow them
1747
1725
  * to further alter the principals with monitor and manage access.
1748
- *
1749
1726
  */
1750
1727
  put: {
1751
1728
  parameters: {
@@ -1772,43 +1749,44 @@ export interface paths {
1772
1749
  "application/json": components["schemas"]["FlowRun"];
1773
1750
  };
1774
1751
  };
1775
- /** @description The requestor presented a token with insufficient scopes.
1776
- * */
1752
+ /** @description The requestor presented a token with insufficient scopes. */
1777
1753
  403: {
1778
1754
  headers: {
1779
1755
  [name: string]: unknown;
1780
1756
  };
1781
1757
  content?: never;
1782
1758
  };
1783
- /** @description The Run does not exist or the requestor did not have access to
1759
+ /**
1760
+ * @description The Run does not exist or the requestor did not have access to
1784
1761
  * modify the Run.
1785
- * */
1762
+ */
1786
1763
  404: {
1787
1764
  headers: {
1788
1765
  [name: string]: unknown;
1789
1766
  };
1790
1767
  content?: never;
1791
1768
  };
1792
- /** @description The request's JSON body did not pass schema validation.
1793
- * */
1769
+ /** @description The request's JSON body did not pass schema validation. */
1794
1770
  422: {
1795
1771
  headers: {
1796
1772
  [name: string]: unknown;
1797
1773
  };
1798
1774
  content?: never;
1799
1775
  };
1800
- /** @description An upstream service has imposed rate limiting.
1776
+ /**
1777
+ * @description An upstream service has imposed rate limiting.
1801
1778
  * The requestor may resubmit the API request.
1802
- * */
1779
+ */
1803
1780
  429: {
1804
1781
  headers: {
1805
1782
  [name: string]: unknown;
1806
1783
  };
1807
1784
  content?: never;
1808
1785
  };
1809
- /** @description An unknown upstream service error occurred.
1786
+ /**
1787
+ * @description An unknown upstream service error occurred.
1810
1788
  * The problem may be resolved by re-submitting the API request.
1811
- * */
1789
+ */
1812
1790
  502: {
1813
1791
  headers: {
1814
1792
  [name: string]: unknown;
@@ -1840,7 +1818,6 @@ export interface paths {
1840
1818
  *
1841
1819
  * This route allows users to view the Flow definition and input schema
1842
1820
  * that were used to start a given Run.
1843
- *
1844
1821
  */
1845
1822
  get: {
1846
1823
  parameters: {
@@ -1863,16 +1840,14 @@ export interface paths {
1863
1840
  "application/json": components["schemas"]["GetRunDefinitionResponse"];
1864
1841
  };
1865
1842
  };
1866
- /** @description The requestor presented a token with insufficient scopes.
1867
- * */
1843
+ /** @description The requestor presented a token with insufficient scopes. */
1868
1844
  403: {
1869
1845
  headers: {
1870
1846
  [name: string]: unknown;
1871
1847
  };
1872
1848
  content?: never;
1873
1849
  };
1874
- /** @description The Run does not exist or the requestor did not have access to view the Run.
1875
- * */
1850
+ /** @description The Run does not exist or the requestor did not have access to view the Run. */
1876
1851
  404: {
1877
1852
  headers: {
1878
1853
  [name: string]: unknown;
@@ -1941,7 +1916,6 @@ export interface components {
1941
1916
  * If this parameter is used when updating a flow,
1942
1917
  * runs that are currently executing will continue to use the definition
1943
1918
  * that they were initially started with.
1944
- *
1945
1919
  */
1946
1920
  FlowDefinition: {
1947
1921
  Comment?: string;
@@ -1951,34 +1925,28 @@ export interface components {
1951
1925
  };
1952
1926
  };
1953
1927
  FlowRun: {
1954
- /** @description The ID for a particular Flow invocation. Analogous to a run_id.
1955
- * */
1928
+ /** @description The ID for a particular Flow invocation. Analogous to a run_id. */
1956
1929
  action_id: string;
1957
- /** @description The ID for a particular Flow invocation. Analogous to an action_id.
1958
- * */
1930
+ /** @description The ID for a particular Flow invocation. Analogous to an action_id. */
1959
1931
  run_id: string;
1960
- /** @description The Flow to which this Run belongs.
1961
- * */
1932
+ /** @description The Flow to which this Run belongs. */
1962
1933
  flow_id: string;
1963
1934
  /**
1964
1935
  * Format: date-time
1965
1936
  * @description A timezone-aware ISO8601 format string that represents the time at
1966
1937
  * which the last update to this Run's Flow occurred.
1967
- *
1968
1938
  */
1969
1939
  flow_last_updated: string;
1970
1940
  /**
1971
1941
  * Format: date-time
1972
1942
  * @description A timezone-aware ISO8601 format string that represents the time at
1973
1943
  * which this Run started.
1974
- *
1975
1944
  */
1976
1945
  start_time: string;
1977
1946
  /**
1978
1947
  * Format: date-time
1979
1948
  * @description A timezone-aware ISO8601 format string that represents the time at
1980
1949
  * which this Run reached a completed status.
1981
- *
1982
1950
  */
1983
1951
  completion_time: string;
1984
1952
  label: components["schemas"]["Label"];
@@ -1988,16 +1956,16 @@ export interface components {
1988
1956
  */
1989
1957
  status: "SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE";
1990
1958
  display_status?: string;
1991
- /** @description Details about the run execution. This is null for runs of High Assurance
1959
+ /**
1960
+ * @description Details about the run execution. This is null for runs of High Assurance
1992
1961
  * flows when listing runs.
1993
- * */
1962
+ */
1994
1963
  details: Record<string, unknown> | null;
1995
1964
  run_owner: components["schemas"]["PrincipalURN"];
1996
1965
  run_monitors?: components["schemas"]["RunMonitors"];
1997
1966
  run_managers?: components["schemas"]["RunManagers"];
1998
1967
  /**
1999
1968
  * @description The role the requesting user has on the Run.
2000
- *
2001
1969
  * @enum {string}
2002
1970
  */
2003
1971
  user_role: "run_monitor" | "run_manager" | "run_owner";
@@ -2006,20 +1974,16 @@ export interface components {
2006
1974
  ValidateRun: {
2007
1975
  /**
2008
1976
  * @description A message indicating the validation was successful
2009
- *
2010
1977
  * @example success
2011
1978
  */
2012
1979
  message: string;
2013
1980
  };
2014
1981
  GetRunDefinitionResponse: {
2015
- /** @description The Flow used to start the Run.
2016
- * */
1982
+ /** @description The Flow used to start the Run. */
2017
1983
  flow_id: string;
2018
- /** @description The definition of the Flow at the time the Run was started.
2019
- * */
1984
+ /** @description The definition of the Flow at the time the Run was started. */
2020
1985
  definition: Record<string, unknown>;
2021
- /** @description The input schema of the Flow at the time the Run was started.
2022
- * */
1986
+ /** @description The input schema of the Flow at the time the Run was started. */
2023
1987
  input_schema: Record<string, unknown>;
2024
1988
  };
2025
1989
  FlowEmbed: {
@@ -2030,33 +1994,30 @@ export interface components {
2030
1994
  * Format: date-time
2031
1995
  * @description A timezone-aware ISO8601 format string that represents the time at
2032
1996
  * which the Flow was created.
2033
- *
2034
1997
  */
2035
1998
  created_at: string;
2036
1999
  /**
2037
2000
  * Format: date-time
2038
2001
  * @description A timezone-aware ISO8601 format string that represents the time at
2039
2002
  * which the Flow was last updated.
2040
- *
2041
2003
  */
2042
2004
  updated_at?: string;
2043
2005
  /**
2044
2006
  * Format: date-time
2045
2007
  * @description A timezone-aware ISO8601 format string that represents the time at
2046
2008
  * which the Flow was deleted (not present if the Flow has not been deleted).
2047
- *
2048
2009
  */
2049
2010
  deleted_at?: string;
2050
- /** @description A non-unique, human-friendly name used for displaying the Flow to end users.
2051
- * */
2011
+ /** @description A non-unique, human-friendly name used for displaying the Flow to end users. */
2052
2012
  title: string;
2053
2013
  /** @description A concise summary of the Flow's purpose. */
2054
2014
  subtitle?: string;
2055
2015
  /** @description A detailed description of the Flow for end user display. */
2056
2016
  description?: string;
2057
- /** @description A set of terms used to categorize the Flow which may be used in
2017
+ /**
2018
+ * @description A set of terms used to categorize the Flow which may be used in
2058
2019
  * query and discovery operations.
2059
- * */
2020
+ */
2060
2021
  keywords?: string[];
2061
2022
  };
2062
2023
  FlowRunWithFlowEmbed: components["schemas"]["FlowRun"] & {
@@ -2075,7 +2036,6 @@ export interface components {
2075
2036
  ActivityNotificationPolicy: {
2076
2037
  /**
2077
2038
  * @description The set of statuses on which to notify the run's owner by email.
2078
- *
2079
2039
  * @default [
2080
2040
  * "INACTIVE"
2081
2041
  * ]
@@ -2105,7 +2065,6 @@ export interface components {
2105
2065
  *
2106
2066
  * Only users with the "run_manager" role will be able to view this list.
2107
2067
  * Users with only the "run_monitor" role will see an empty list.
2108
- *
2109
2068
  */
2110
2069
  RunManagers: components["schemas"]["PrincipalURN"][];
2111
2070
  /**
@@ -2116,7 +2075,6 @@ export interface components {
2116
2075
  *
2117
2076
  * Only users with the "run_manager" role will be able to view this list.
2118
2077
  * Users with only the "run_monitor" role will see an empty list.
2119
- *
2120
2078
  */
2121
2079
  RunMonitors: components["schemas"]["PrincipalURN"][];
2122
2080
  /**
@@ -2128,7 +2086,6 @@ export interface components {
2128
2086
  *
2129
2087
  * When updating a run, existing tags will be overwritten.
2130
2088
  * This means that an empty array will delete all existing tags.
2131
- *
2132
2089
  * @example [
2133
2090
  * "Experiment:xDA202",
2134
2091
  * "Site:Nautilus",
@@ -2139,7 +2096,6 @@ export interface components {
2139
2096
  /**
2140
2097
  * @description A URN representation of an Identity in Globus either of a user from
2141
2098
  * Globus Auth or a group from Globus Groups.
2142
- *
2143
2099
  * @example urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c
2144
2100
  */
2145
2101
  PrincipalURN: string;
@@ -2279,26 +2235,23 @@ export interface components {
2279
2235
  FlowResponse: {
2280
2236
  /** @description The unique identifier for the Flow. */
2281
2237
  id?: string;
2282
- /** @description The flow definition. This is null for High Assurance flows when listing flows.
2283
- * */
2238
+ /** @description The flow definition. This is null for High Assurance flows when listing flows. */
2284
2239
  definition?: components["schemas"]["FlowDefinition"];
2285
- /** @description A JSON Schema compliant definition of the format of the `body` field
2240
+ /**
2241
+ * @description A JSON Schema compliant definition of the format of the `body` field
2286
2242
  * when requesting a Flow be run. This is null for High Assurance flows when listing flows.
2287
- * */
2243
+ */
2288
2244
  input_schema?: Record<string, unknown> | null;
2289
2245
  /**
2290
2246
  * Format: uri
2291
2247
  * @description The scope of any bearer token to be used on authenticated accesses
2292
2248
  * to the Flow.
2293
- *
2294
2249
  */
2295
2250
  globus_auth_scope?: string;
2296
- /** @description A list of scopes according to RunAs values as defined in the Flow.
2297
- * */
2251
+ /** @description A list of scopes according to RunAs values as defined in the Flow. */
2298
2252
  globus_auth_scopes_by_RunAs?: string[];
2299
2253
  /**
2300
2254
  * @description The role the requesting user has on the Flow.
2301
- *
2302
2255
  * @enum {string}
2303
2256
  */
2304
2257
  user_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner";
@@ -2308,7 +2261,6 @@ export interface components {
2308
2261
  * definition. Only calling users with the "administrator"
2309
2262
  * role will be provided this list. Otherwise, the value
2310
2263
  * will always be an empty list.
2311
- *
2312
2264
  * @example [
2313
2265
  * "public",
2314
2266
  * "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
@@ -2322,7 +2274,6 @@ export interface components {
2322
2274
  * who can initiate a run of the Flow. Only calling users
2323
2275
  * with the "administrator" role will be provided this
2324
2276
  * list. Otherwise, the value will always be an empty list.
2325
- *
2326
2277
  * @example [
2327
2278
  * "all_authenticated_users",
2328
2279
  * "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
@@ -2330,47 +2281,49 @@ export interface components {
2330
2281
  * ]
2331
2282
  */
2332
2283
  flow_starters?: components["schemas"]["PrincipalURN"][];
2333
- /** @description The set of Principal URN values of users who may perform
2284
+ /**
2285
+ * @description The set of Principal URN values of users who may perform
2334
2286
  * administrative operations, including updating the
2335
2287
  * description itself. Only calling users with the
2336
2288
  * "administrator" role will be provided this
2337
2289
  * list. Otherwise, the value will always be an empty list.
2338
- * */
2290
+ */
2339
2291
  flow_administrators?: components["schemas"]["PrincipalURN"][];
2340
2292
  flow_owner?: components["schemas"]["PrincipalURN"];
2341
2293
  /**
2342
2294
  * Format: date-time
2343
2295
  * @description A timezone-aware ISO8601 format string that represents the time at
2344
2296
  * which the Flow was created.
2345
- *
2346
2297
  */
2347
2298
  created_at?: string;
2348
2299
  /**
2349
2300
  * Format: date-time
2350
2301
  * @description A timezone-aware ISO8601 format string that represents the time at
2351
2302
  * which the Flow was last updated.
2352
- *
2353
2303
  */
2354
2304
  updated_at?: string;
2355
2305
  synchronous?: boolean;
2356
- /** @description True if the Flow supports the /log operation providing detailed
2306
+ /**
2307
+ * @description True if the Flow supports the /log operation providing detailed
2357
2308
  * information on the intermediate states of a Flow invocation.
2358
- * */
2309
+ */
2359
2310
  log_supported?: boolean;
2360
2311
  types?: ("Action" | "Event")[];
2361
2312
  /** @enum {string} */
2362
2313
  api_version?: "1.0";
2363
- /** @description A non-unique, human-friendly name used for displaying the Flow
2314
+ /**
2315
+ * @description A non-unique, human-friendly name used for displaying the Flow
2364
2316
  * to end users.
2365
- * */
2317
+ */
2366
2318
  title?: string;
2367
2319
  /** @description A concise summary of the Flow's purpose. */
2368
2320
  subtitle?: string;
2369
2321
  /** @description A detailed description of the Flow for end user display. */
2370
2322
  description?: string;
2371
- /** @description A set of terms used to categorize the Flow which may be used in
2323
+ /**
2324
+ * @description A set of terms used to categorize the Flow which may be used in
2372
2325
  * query and discovery operations.
2373
- * */
2326
+ */
2374
2327
  keywords?: string[];
2375
2328
  principal_urn?: components["schemas"]["PrincipalURN"];
2376
2329
  /** @description The Flow's Globus Auth username. */
@@ -2379,13 +2332,13 @@ export interface components {
2379
2332
  * Format: uri
2380
2333
  * @description The web-addressable location at which this Flow can be referenced
2381
2334
  * and run from.
2382
- *
2383
2335
  */
2384
2336
  flow_url?: string;
2385
- /** @description Indicates whether this flow is High Assurance. High Assurance flows have
2337
+ /**
2338
+ * @description Indicates whether this flow is High Assurance. High Assurance flows have
2386
2339
  * sensitive fields (definition, input_schema) omitted from list responses
2387
2340
  * for security purposes.
2388
- * */
2341
+ */
2389
2342
  is_high_assurance?: boolean;
2390
2343
  /**
2391
2344
  * Format: uuid
@@ -2393,7 +2346,6 @@ export interface components {
2393
2346
  * subscription_id is present, the Flow may be
2394
2347
  * accepted, but may have limits on how long or how
2395
2348
  * much it can be used.
2396
- *
2397
2349
  */
2398
2350
  subscription_id?: string;
2399
2351
  };
@@ -2401,8 +2353,7 @@ export interface components {
2401
2353
  scopes?: components["schemas"]["FlowScopes"];
2402
2354
  };
2403
2355
  FlowValidationErrorResponse: {
2404
- /** @description A unique identifier for the validation error, used for debugging.
2405
- * */
2356
+ /** @description A unique identifier for the validation error, used for debugging. */
2406
2357
  debug_id: string;
2407
2358
  error: {
2408
2359
  /** @description A readable keyword describing the failure. */
@@ -2438,11 +2389,12 @@ export interface components {
2438
2389
  };
2439
2390
  };
2440
2391
  responses: {
2441
- /** @description The requested operation was accepted.
2392
+ /**
2393
+ * @description The requested operation was accepted.
2442
2394
  *
2443
2395
  * The operation may have been completed, or may be completed at a later time.
2444
2396
  * A follow-up API request may be needed to confirm the status of the operation.
2445
- * */
2397
+ */
2446
2398
  HTTP202Response: {
2447
2399
  headers: {
2448
2400
  [name: string]: unknown;
@@ -2505,7 +2457,6 @@ export interface components {
2505
2457
  *
2506
2458
  * Note that runs which are still executing will not have a completion time
2507
2459
  * and will be automatically excluded if this filter is applied.
2508
- *
2509
2460
  * @example 2021-03-09T21:52:14,2021-03-09T21:53
2510
2461
  */
2511
2462
  filter_completion_time: string;
@@ -2523,7 +2474,6 @@ export interface components {
2523
2474
  *
2524
2475
  * Results will contain runs which began between the first datetime
2525
2476
  * onwards, up to (but not including) the second datetime.
2526
- *
2527
2477
  * @example 2021-03-09T21:52:14,2021-03-09T21:53
2528
2478
  */
2529
2479
  filter_start_time: string;
@@ -2564,7 +2514,6 @@ export interface components {
2564
2514
  *
2565
2515
  * - `ASC`
2566
2516
  * - `DESC`
2567
- *
2568
2517
  * @example [
2569
2518
  * "title ASC",
2570
2519
  * "id DESC"
@@ -2606,7 +2555,6 @@ export interface components {
2606
2555
  *
2607
2556
  * - `ASC`
2608
2557
  * - `DESC`
2609
- *
2610
2558
  * @example [
2611
2559
  * "start_time ASC",
2612
2560
  * "id DESC"