Skip to content

Commit 7df74bc

Browse files
github-actions[bot]github-actions
github-actions[bot]
and
github-actions
authored
chore(Flows): Updates OpenAPI generated types for Globus Service APIs (#558)
This PR was auto-generated by the `scheduled--generate-types` GitHub Action workflow. ### Continuous integration workflows were NOT run on the creation of this pull request. --- - [x] Update the title (scope) of this pull request to match the changes made. - [x] Close and reopen this pull request to trigger workflows. Co-authored-by: github-actions <[email protected]>
1 parent 2733448 commit 7df74bc

File tree

1 file changed

+85
-37
lines changed

1 file changed

+85
-37
lines changed

‎src/open-api/types/flows.ts‎

Lines changed: 85 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,10 @@ export interface paths {
3939
* multiple roles are specified, the user will have at least one of the
4040
* specified roles on each Flow returned.
4141
*
42-
* @example flow_owner,flow_viewers
42+
* @example [
43+
* "flow_owner",
44+
* "flow_viewers"
45+
* ]
4346
*/
4447
filter_roles?: ("flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators" | "run_managers" | "run_monitors")[];
4548
/**
@@ -62,15 +65,21 @@ export interface paths {
6265
* returned is guaranteed to contain at least one of the strings in its
6366
* scope strings.
6467
*
65-
* @example 0abc,100
68+
* @example [
69+
* "0abc",
70+
* "100"
71+
* ]
6672
*/
6773
filter_scope_string?: string[];
6874
/**
6975
* @description Performs a case insensitive substring based search on the Flows' title
7076
* field. If multiple values are specified, each Flow returned
7177
* is guaranteed to contain at least one of the strings in its title.
7278
*
73-
* @example hello,science
79+
* @example [
80+
* "hello",
81+
* "science"
82+
* ]
7483
*/
7584
filter_title?: string[];
7685
/**
@@ -79,7 +88,10 @@ export interface paths {
7988
* is guaranteed to contain at least one of the strings in its
8089
* subtitle.
8190
*
82-
* @example hello,science
91+
* @example [
92+
* "hello",
93+
* "science"
94+
* ]
8395
*/
8496
filter_subtitle?: string[];
8597
/**
@@ -88,7 +100,10 @@ export interface paths {
88100
* is guaranteed to contain at least one of the strings in its
89101
* description.
90102
*
91-
* @example hello,science
103+
* @example [
104+
* "hello",
105+
* "science"
106+
* ]
92107
*/
93108
filter_description?: string[];
94109
/**
@@ -97,7 +112,10 @@ export interface paths {
97112
* is guaranteed to contain at least one of the substrings as a
98113
* keyword.
99114
*
100-
* @example hello,science
115+
* @example [
116+
* "hello",
117+
* "science"
118+
* ]
101119
*/
102120
filter_keywords?: string[];
103121
/**
@@ -113,7 +131,9 @@ export interface paths {
113131
* - id
114132
* - flow_administrators
115133
*
116-
* @example globus
134+
* @example [
135+
* "globus"
136+
* ]
117137
*/
118138
filter_fulltext?: string[];
119139
/**
@@ -154,10 +174,10 @@ export interface paths {
154174
* - `ASC`
155175
* - `DESC`
156176
*
157-
* By default, the list of flows is sorted by the flows' `id` field
158-
* in ascending order, which is equivalent to `id ASC`.
159-
*
160-
* @example title ASC,id DESC
177+
* @example [
178+
* "title ASC",
179+
* "id DESC"
180+
* ]
161181
*/
162182
orderby?: components["parameters"]["list_flows_orderby"];
163183
};
@@ -651,7 +671,10 @@ export interface paths {
651671
* @description Return Flow's for which the user has the supplied role. The role the
652672
* user has on the Flow dictates the operations they can perform.
653673
*
654-
* @example flow_owner,flow_viewers
674+
* @example [
675+
* "flow_owner",
676+
* "flow_viewers"
677+
* ]
655678
*/
656679
roles?: ("flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators")[];
657680
};
@@ -1420,7 +1443,9 @@ export interface paths {
14201443
* If multiple roles are specified, the user will have at least one of
14211444
* the specified roles on each Action returned.
14221445
*
1423-
* @example run_manager
1446+
* @example [
1447+
* "run_manager"
1448+
* ]
14241449
*/
14251450
filter_roles?: ("run_owner" | "run_manager" | "run_monitor" | "flow_run_manager" | "flow_run_monitor")[];
14261451
/**
@@ -1434,7 +1459,9 @@ export interface paths {
14341459
* has "run_monitor" role as well. If not provided, only Actions
14351460
* for which the caller has "run_owner" role will be returned.
14361461
*
1437-
* @example run_manager
1462+
* @example [
1463+
* "run_manager"
1464+
* ]
14381465
*/
14391466
filter_role?: "run_monitor" | "run_manager" | "run_owner" | "flow_run_manager" | "flow_run_monitor";
14401467
/**
@@ -1444,15 +1471,21 @@ export interface paths {
14441471
* of the specified states. By default, Actions in any state will be
14451472
* returned.
14461473
*
1447-
* @example FAILED,INACTIVE
1474+
* @example [
1475+
* "FAILED",
1476+
* "INACTIVE"
1477+
* ]
14481478
*/
14491479
filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
14501480
/**
14511481
* @description Performs a case insensitive string based search on the Actions'
14521482
* label fields. If multiple values are specified, each Action returned
14531483
* is guaranteed to contain at least one of the strings in its label.
14541484
*
1455-
* @example science,tests
1485+
* @example [
1486+
* "science",
1487+
* "tests"
1488+
* ]
14561489
*/
14571490
filter_label?: string[];
14581491
/**
@@ -1530,10 +1563,10 @@ export interface paths {
15301563
* - `ASC`
15311564
* - `DESC`
15321565
*
1533-
* By default, the list of runs is sorted by the runs' `start_time` field
1534-
* in descending order, which is equivalent to `start_time DESC`.
1535-
*
1536-
* @example start_time ASC,id DESC
1566+
* @example [
1567+
* "start_time ASC",
1568+
* "id DESC"
1569+
* ]
15371570
*/
15381571
orderby?: components["parameters"]["list_runs_orderby"];
15391572
};
@@ -1644,7 +1677,10 @@ export interface paths {
16441677
* If multiple roles are specified, the user will have at least one of
16451678
* the specified roles on each Action returned.
16461679
*
1647-
* @example run_owner,run_managers
1680+
* @example [
1681+
* "run_owner",
1682+
* "run_managers"
1683+
* ]
16481684
*/
16491685
filter_roles?: ("run_owner" | "run_managers" | "run_monitors" | "flow_run_managers" | "flow_run_monitors")[];
16501686
/**
@@ -1668,15 +1704,21 @@ export interface paths {
16681704
* of the specified states. By default, Actions in any state will be
16691705
* returned.
16701706
*
1671-
* @example FAILED,INACTIVE
1707+
* @example [
1708+
* "FAILED",
1709+
* "INACTIVE"
1710+
* ]
16721711
*/
16731712
filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
16741713
/**
16751714
* @description Performs a case insensitive string based search on the Actions'
16761715
* label fields. If multiple values are specified, each Action returned
16771716
* is guaranteed to contain at least one of the strings in its label.
16781717
*
1679-
* @example science,tests
1718+
* @example [
1719+
* "science",
1720+
* "tests"
1721+
* ]
16801722
*/
16811723
filter_label?: string[];
16821724
/**
@@ -1685,7 +1727,10 @@ export interface paths {
16851727
* multiple values are specified, each Action returned will have a
16861728
* parent Flow with a title matching at least one of the strings.
16871729
*
1688-
* @example globus,tests
1730+
* @example [
1731+
* "globus",
1732+
* "tests"
1733+
* ]
16891734
*/
16901735
filter_flow_title?: string[];
16911736
/**
@@ -1694,7 +1739,10 @@ export interface paths {
16941739
* specified, each Run returned will have been initiated from at least
16951740
* one of the specified Flow IDs.
16961741
*
1697-
* @example 6086d817-19d9-4f5b-9329-22ed12d4d3dd,71a70751-19a5-4d19-998e-0709c40321e9
1742+
* @example [
1743+
* "00000000-19d9-4f5b-9329-22ed12d4d3dd",
1744+
* "11111111-19a5-4d19-998e-0709c40321e9"
1745+
* ]
16981746
*/
16991747
filter_flow_id?: string[];
17001748
/**
@@ -1772,10 +1820,10 @@ export interface paths {
17721820
* - `ASC`
17731821
* - `DESC`
17741822
*
1775-
* By default, the list of runs is sorted by the runs' `start_time` field
1776-
* in descending order, which is equivalent to `start_time DESC`.
1777-
*
1778-
* @example start_time ASC,id DESC
1823+
* @example [
1824+
* "start_time ASC",
1825+
* "id DESC"
1826+
* ]
17791827
*/
17801828
orderby?: components["parameters"]["list_runs_orderby"];
17811829
};
@@ -2710,10 +2758,10 @@ export interface components {
27102758
* - `ASC`
27112759
* - `DESC`
27122760
*
2713-
* By default, the list of flows is sorted by the flows' `id` field
2714-
* in ascending order, which is equivalent to `id ASC`.
2715-
*
2716-
* @example title ASC,id DESC
2761+
* @example [
2762+
* "title ASC",
2763+
* "id DESC"
2764+
* ]
27172765
*/
27182766
list_flows_orderby: string[];
27192767
/**
@@ -2752,10 +2800,10 @@ export interface components {
27522800
* - `ASC`
27532801
* - `DESC`
27542802
*
2755-
* By default, the list of runs is sorted by the runs' `start_time` field
2756-
* in descending order, which is equivalent to `start_time DESC`.
2757-
*
2758-
* @example start_time ASC,id DESC
2803+
* @example [
2804+
* "start_time ASC",
2805+
* "id DESC"
2806+
* ]
27592807
*/
27602808
list_runs_orderby: string[];
27612809
};

0 commit comments

Comments
 (0)