@globus/sdk 6.1.0 → 6.2.0-canary.113.06d76db
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 +27 -5
- package/dist/cjs/core/authorization/index.js +314 -11
- package/dist/cjs/core/authorization/index.js.map +4 -4
- package/dist/cjs/core/info/index.js +1 -1
- package/dist/cjs/core/info/index.js.map +1 -1
- package/dist/cjs/index.js +2062 -269
- package/dist/cjs/index.js.map +4 -4
- package/dist/cjs/services/globus-connect-server/client.js +259 -10
- package/dist/cjs/services/globus-connect-server/client.js.map +4 -4
- package/dist/esm/core/info/version.d.ts +1 -1
- package/dist/esm/core/info/version.js +1 -1
- package/dist/esm/open-api/types/compute.d.ts +421 -159
- package/dist/esm/open-api/types/compute.d.ts.map +1 -1
- package/dist/esm/open-api/types/flows.d.ts +605 -380
- package/dist/esm/open-api/types/flows.d.ts.map +1 -1
- package/dist/esm/open-api/types/gcs/v5.4.d.ts +3251 -2374
- package/dist/esm/open-api/types/gcs/v5.4.d.ts.map +1 -1
- package/dist/esm/open-api/types/search.d.ts +580 -145
- package/dist/esm/open-api/types/search.d.ts.map +1 -1
- package/dist/esm/open-api/types/timers.d.ts +25 -16
- package/dist/esm/open-api/types/timers.d.ts.map +1 -1
- package/dist/esm/open-api/types/transfer.d.ts +807 -0
- package/dist/esm/open-api/types/transfer.d.ts.map +1 -0
- package/dist/esm/open-api/types/transfer.js +2 -0
- package/dist/esm/open-api/types/transfer.js.map +1 -0
- package/dist/esm/package.json +1 -1
- package/dist/esm/services/auth/config.d.ts +1 -0
- package/dist/esm/services/auth/config.d.ts.map +1 -1
- package/dist/esm/services/auth/config.js +1 -0
- package/dist/esm/services/auth/config.js.map +1 -1
- package/dist/esm/services/auth/index.d.ts +2 -4
- package/dist/esm/services/auth/index.d.ts.map +1 -1
- package/dist/esm/services/auth/index.js +2 -12
- package/dist/esm/services/auth/index.js.map +1 -1
- package/dist/esm/services/auth/service/developers/clients/credentials.d.ts +69 -0
- package/dist/esm/services/auth/service/developers/clients/credentials.d.ts.map +1 -0
- package/dist/esm/services/auth/service/developers/clients/credentials.js +66 -0
- package/dist/esm/services/auth/service/developers/clients/credentials.js.map +1 -0
- package/dist/esm/services/auth/service/developers/clients/index.d.ts +137 -0
- package/dist/esm/services/auth/service/developers/clients/index.d.ts.map +1 -0
- package/dist/esm/services/auth/service/developers/clients/index.js +128 -0
- package/dist/esm/services/auth/service/developers/clients/index.js.map +1 -0
- package/dist/esm/services/auth/service/developers/clients/scopes.d.ts +38 -0
- package/dist/esm/services/auth/service/developers/clients/scopes.d.ts.map +1 -0
- package/dist/esm/services/auth/service/developers/clients/scopes.js +47 -0
- package/dist/esm/services/auth/service/developers/clients/scopes.js.map +1 -0
- package/dist/esm/services/auth/service/developers/index.d.ts +8 -0
- package/dist/esm/services/auth/service/developers/index.d.ts.map +1 -0
- package/dist/esm/services/auth/service/developers/index.js +5 -0
- package/dist/esm/services/auth/service/developers/index.js.map +1 -0
- package/dist/esm/services/auth/service/developers/policies.d.ts +95 -0
- package/dist/esm/services/auth/service/developers/policies.d.ts.map +1 -0
- package/dist/esm/services/auth/service/developers/policies.js +103 -0
- package/dist/esm/services/auth/service/developers/policies.js.map +1 -0
- package/dist/esm/services/auth/service/developers/projects.d.ts +114 -0
- package/dist/esm/services/auth/service/developers/projects.d.ts.map +1 -0
- package/dist/esm/services/auth/service/developers/projects.js +108 -0
- package/dist/esm/services/auth/service/developers/projects.js.map +1 -0
- package/dist/esm/services/auth/service/developers/scopes.d.ts +97 -0
- package/dist/esm/services/auth/service/developers/scopes.d.ts.map +1 -0
- package/dist/esm/services/auth/service/developers/scopes.js +81 -0
- package/dist/esm/services/auth/service/developers/scopes.js.map +1 -0
- package/dist/esm/services/auth/service/identities/consents.d.ts +15 -4
- package/dist/esm/services/auth/service/identities/consents.d.ts.map +1 -1
- package/dist/esm/services/auth/service/identities/consents.js +12 -1
- package/dist/esm/services/auth/service/identities/consents.js.map +1 -1
- package/dist/esm/services/auth/service/identities/index.d.ts +66 -5
- package/dist/esm/services/auth/service/identities/index.d.ts.map +1 -1
- package/dist/esm/services/auth/service/identities/index.js +18 -2
- package/dist/esm/services/auth/service/identities/index.js.map +1 -1
- package/dist/esm/services/auth/service/oauth2/token.d.ts +8 -8
- package/dist/esm/services/auth/service/oauth2/token.d.ts.map +1 -1
- package/dist/esm/services/auth/tokens.d.ts +5 -0
- package/dist/esm/services/auth/tokens.d.ts.map +1 -0
- package/dist/esm/services/auth/tokens.js +13 -0
- package/dist/esm/services/auth/tokens.js.map +1 -0
- package/dist/esm/services/compute/index.d.ts +1 -1
- package/dist/esm/services/compute/index.js +1 -1
- package/dist/esm/services/compute/service/endpoints.d.ts +87 -16
- package/dist/esm/services/compute/service/endpoints.d.ts.map +1 -1
- package/dist/esm/services/compute/service/endpoints.js +34 -0
- package/dist/esm/services/compute/service/endpoints.js.map +1 -1
- package/dist/esm/services/factory.d.ts +81 -0
- package/dist/esm/services/factory.d.ts.map +1 -0
- package/dist/esm/services/factory.js +78 -0
- package/dist/esm/services/factory.js.map +1 -0
- package/dist/esm/services/flows/service/flows.d.ts +194 -18
- package/dist/esm/services/flows/service/flows.d.ts.map +1 -1
- package/dist/esm/services/flows/service/flows.js +47 -0
- package/dist/esm/services/flows/service/flows.js.map +1 -1
- package/dist/esm/services/flows/service/runs.d.ts +145 -24
- package/dist/esm/services/flows/service/runs.d.ts.map +1 -1
- package/dist/esm/services/flows/service/runs.js +45 -0
- package/dist/esm/services/flows/service/runs.js.map +1 -1
- package/dist/esm/services/globus-connect-server/client.d.ts +2088 -4
- package/dist/esm/services/globus-connect-server/client.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/client.js +52 -0
- package/dist/esm/services/globus-connect-server/client.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/collections.d.ts +1019 -0
- package/dist/esm/services/globus-connect-server/service/collections.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/collections.js +36 -0
- package/dist/esm/services/globus-connect-server/service/collections.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/endpoint.d.ts +282 -0
- package/dist/esm/services/globus-connect-server/service/endpoint.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/endpoint.js +33 -0
- package/dist/esm/services/globus-connect-server/service/endpoint.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/nodes.d.ts +240 -0
- package/dist/esm/services/globus-connect-server/service/nodes.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/nodes.js +28 -0
- package/dist/esm/services/globus-connect-server/service/nodes.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/roles.d.ts +137 -0
- package/dist/esm/services/globus-connect-server/service/roles.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/roles.js +20 -0
- package/dist/esm/services/globus-connect-server/service/roles.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts +287 -0
- package/dist/esm/services/globus-connect-server/service/storage-gateways.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/storage-gateways.js +28 -0
- package/dist/esm/services/globus-connect-server/service/storage-gateways.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/user-credentials.d.ts +205 -0
- package/dist/esm/services/globus-connect-server/service/user-credentials.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/user-credentials.js +28 -0
- package/dist/esm/services/globus-connect-server/service/user-credentials.js.map +1 -1
- package/dist/esm/services/globus-connect-server/service/versioning.d.ts +35 -0
- package/dist/esm/services/globus-connect-server/service/versioning.d.ts.map +1 -1
- package/dist/esm/services/globus-connect-server/service/versioning.js +6 -0
- package/dist/esm/services/globus-connect-server/service/versioning.js.map +1 -1
- package/dist/esm/services/groups/service/groups.d.ts +161 -15
- package/dist/esm/services/groups/service/groups.d.ts.map +1 -1
- package/dist/esm/services/groups/service/groups.js +39 -0
- package/dist/esm/services/groups/service/groups.js.map +1 -1
- package/dist/esm/services/groups/service/membership.d.ts +28 -5
- package/dist/esm/services/groups/service/membership.d.ts.map +1 -1
- package/dist/esm/services/groups/service/membership.js +13 -1
- package/dist/esm/services/groups/service/membership.js.map +1 -1
- package/dist/esm/services/groups/service/policies.d.ts +37 -9
- package/dist/esm/services/groups/service/policies.d.ts.map +1 -1
- package/dist/esm/services/groups/service/policies.js +18 -1
- package/dist/esm/services/groups/service/policies.js.map +1 -1
- package/dist/esm/services/search/config.d.ts.map +1 -1
- package/dist/esm/services/search/config.js.map +1 -1
- package/dist/esm/services/search/index.d.ts +1 -0
- package/dist/esm/services/search/index.d.ts.map +1 -1
- package/dist/esm/services/search/index.js +1 -0
- package/dist/esm/services/search/index.js.map +1 -1
- package/dist/esm/services/search/service/entry.d.ts +24 -4
- package/dist/esm/services/search/service/entry.d.ts.map +1 -1
- package/dist/esm/services/search/service/entry.js +18 -0
- package/dist/esm/services/search/service/entry.js.map +1 -1
- package/dist/esm/services/search/service/query.d.ts +107 -49
- package/dist/esm/services/search/service/query.d.ts.map +1 -1
- package/dist/esm/services/search/service/query.js +21 -0
- package/dist/esm/services/search/service/query.js.map +1 -1
- package/dist/esm/services/search/service/roles.d.ts +29 -13
- package/dist/esm/services/search/service/roles.d.ts.map +1 -1
- package/dist/esm/services/search/service/roles.js +24 -0
- package/dist/esm/services/search/service/roles.js.map +1 -1
- package/dist/esm/services/search/service/search-index.d.ts +43 -18
- package/dist/esm/services/search/service/search-index.d.ts.map +1 -1
- package/dist/esm/services/search/service/search-index.js +41 -0
- package/dist/esm/services/search/service/search-index.js.map +1 -1
- package/dist/esm/services/search/service/subject.d.ts +23 -4
- package/dist/esm/services/search/service/subject.d.ts.map +1 -1
- package/dist/esm/services/search/service/subject.js +18 -0
- package/dist/esm/services/search/service/subject.js.map +1 -1
- package/dist/esm/services/search/service/task.d.ts +69 -0
- package/dist/esm/services/search/service/task.d.ts.map +1 -0
- package/dist/esm/services/search/service/task.js +58 -0
- package/dist/esm/services/search/service/task.js.map +1 -0
- package/dist/esm/services/shared.d.ts +1 -2
- package/dist/esm/services/shared.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/timers/service/jobs/index.d.ts +161 -20
- package/dist/esm/services/timers/service/jobs/index.d.ts.map +1 -1
- package/dist/esm/services/timers/service/jobs/index.js +46 -6
- package/dist/esm/services/timers/service/jobs/index.js.map +1 -1
- package/dist/esm/services/timers/service/timer.d.ts +15 -2
- package/dist/esm/services/timers/service/timer.d.ts.map +1 -1
- package/dist/esm/services/timers/service/timer.js +12 -0
- package/dist/esm/services/timers/service/timer.js.map +1 -1
- package/dist/esm/services/transfer/config.js +1 -1
- package/dist/esm/services/transfer/config.js.map +1 -1
- package/dist/esm/services/transfer/index.d.ts +9 -0
- package/dist/esm/services/transfer/index.d.ts.map +1 -1
- package/dist/esm/services/transfer/index.js +6 -1
- package/dist/esm/services/transfer/index.js.map +1 -1
- package/dist/esm/services/transfer/service/access.d.ts +69 -22
- package/dist/esm/services/transfer/service/access.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/access.js +35 -0
- package/dist/esm/services/transfer/service/access.js.map +1 -1
- package/dist/esm/services/transfer/service/collection-bookmarks.d.ts +53 -15
- package/dist/esm/services/transfer/service/collection-bookmarks.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/collection-bookmarks.js +35 -0
- package/dist/esm/services/transfer/service/collection-bookmarks.js.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts +40 -12
- package/dist/esm/services/transfer/service/endpoint-manager/endpoint.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/endpoint.js +27 -0
- package/dist/esm/services/transfer/service/endpoint-manager/endpoint.js.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.d.ts +58 -15
- package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.js +35 -0
- package/dist/esm/services/transfer/service/endpoint-manager/pause-rule.js.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/task.d.ts +105 -27
- package/dist/esm/services/transfer/service/endpoint-manager/task.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-manager/task.js +61 -0
- package/dist/esm/services/transfer/service/endpoint-manager/task.js.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-search.d.ts +15 -3
- package/dist/esm/services/transfer/service/endpoint-search.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint-search.js +12 -0
- package/dist/esm/services/transfer/service/endpoint-search.js.map +1 -1
- package/dist/esm/services/transfer/service/endpoint.d.ts +36 -12
- package/dist/esm/services/transfer/service/endpoint.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/endpoint.js +38 -0
- package/dist/esm/services/transfer/service/endpoint.js.map +1 -1
- package/dist/esm/services/transfer/service/file-operations.d.ts +73 -25
- package/dist/esm/services/transfer/service/file-operations.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/file-operations.js +47 -0
- package/dist/esm/services/transfer/service/file-operations.js.map +1 -1
- package/dist/esm/services/transfer/service/roles.d.ts +51 -17
- package/dist/esm/services/transfer/service/roles.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/roles.js +29 -0
- package/dist/esm/services/transfer/service/roles.js.map +1 -1
- package/dist/esm/services/transfer/service/stream-access-point.d.ts +46 -0
- package/dist/esm/services/transfer/service/stream-access-point.d.ts.map +1 -0
- package/dist/esm/services/transfer/service/stream-access-point.js +42 -0
- package/dist/esm/services/transfer/service/stream-access-point.js.map +1 -0
- package/dist/esm/services/transfer/service/task-submission.d.ts +22 -4
- package/dist/esm/services/transfer/service/task-submission.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/task-submission.js +32 -0
- package/dist/esm/services/transfer/service/task-submission.js.map +1 -1
- package/dist/esm/services/transfer/service/task.d.ts +85 -33
- package/dist/esm/services/transfer/service/task.d.ts.map +1 -1
- package/dist/esm/services/transfer/service/task.js +55 -0
- package/dist/esm/services/transfer/service/task.js.map +1 -1
- package/dist/esm/services/transfer/service/tunnel.d.ts +140 -0
- package/dist/esm/services/transfer/service/tunnel.d.ts.map +1 -0
- package/dist/esm/services/transfer/service/tunnel.js +133 -0
- package/dist/esm/services/transfer/service/tunnel.js.map +1 -0
- package/dist/esm/services/transfer/types.d.ts +3 -1
- package/dist/esm/services/transfer/types.d.ts.map +1 -1
- package/dist/esm/services/types.d.ts +3 -5
- 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 +4 -4
- package/package.json +7 -5
|
@@ -10,39 +10,27 @@ 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
|
-
/**
|
|
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
|
-
* */
|
|
24
|
-
marker?: string;
|
|
25
|
-
/**
|
|
26
|
-
* @description The number of results to return in a single paged response.
|
|
27
|
-
*
|
|
28
|
-
* @example 50
|
|
29
23
|
*/
|
|
24
|
+
marker?: string;
|
|
25
|
+
/** @description The number of results to return in a single paged response. */
|
|
30
26
|
per_page?: number;
|
|
31
|
-
/**
|
|
32
|
-
* @description The page of results to return.
|
|
33
|
-
* @example 2
|
|
34
|
-
*/
|
|
27
|
+
/** @description The page of results to return. */
|
|
35
28
|
page?: number;
|
|
36
29
|
/**
|
|
37
30
|
* @description Return Flows for which the user has the supplied role. The role the
|
|
38
31
|
* user has on the Flow dictates the operations they can perform. If
|
|
39
32
|
* multiple roles are specified, the user will have at least one of the
|
|
40
33
|
* specified roles on each Flow returned.
|
|
41
|
-
*
|
|
42
|
-
* @example [
|
|
43
|
-
* "flow_owner",
|
|
44
|
-
* "flow_viewers"
|
|
45
|
-
* ]
|
|
46
34
|
*/
|
|
47
35
|
filter_roles?: ("flow_owner" | "flow_viewers" | "flow_starters" | "flow_administrators" | "run_managers" | "run_monitors")[];
|
|
48
36
|
/**
|
|
@@ -55,8 +43,6 @@ export interface paths {
|
|
|
55
43
|
* include all Flows for which the user has "flow_viewer" role as
|
|
56
44
|
* well. If not provided, only Flows for which the caller has
|
|
57
45
|
* "flow_owner" role will be returned.
|
|
58
|
-
*
|
|
59
|
-
* @example flow_starter
|
|
60
46
|
*/
|
|
61
47
|
filter_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner" | "run_manager" | "run_monitor";
|
|
62
48
|
/**
|
|
@@ -64,22 +50,12 @@ export interface paths {
|
|
|
64
50
|
* scope string fields. If multiple values are specified, each Flow
|
|
65
51
|
* returned is guaranteed to contain at least one of the strings in its
|
|
66
52
|
* scope strings.
|
|
67
|
-
*
|
|
68
|
-
* @example [
|
|
69
|
-
* "0abc",
|
|
70
|
-
* "100"
|
|
71
|
-
* ]
|
|
72
53
|
*/
|
|
73
54
|
filter_scope_string?: string[];
|
|
74
55
|
/**
|
|
75
56
|
* @description Performs a case insensitive substring based search on the Flows' title
|
|
76
57
|
* field. If multiple values are specified, each Flow returned
|
|
77
58
|
* is guaranteed to contain at least one of the strings in its title.
|
|
78
|
-
*
|
|
79
|
-
* @example [
|
|
80
|
-
* "hello",
|
|
81
|
-
* "science"
|
|
82
|
-
* ]
|
|
83
59
|
*/
|
|
84
60
|
filter_title?: string[];
|
|
85
61
|
/**
|
|
@@ -87,11 +63,6 @@ export interface paths {
|
|
|
87
63
|
* subtitle field. If multiple values are specified, each Flow returned
|
|
88
64
|
* is guaranteed to contain at least one of the strings in its
|
|
89
65
|
* subtitle.
|
|
90
|
-
*
|
|
91
|
-
* @example [
|
|
92
|
-
* "hello",
|
|
93
|
-
* "science"
|
|
94
|
-
* ]
|
|
95
66
|
*/
|
|
96
67
|
filter_subtitle?: string[];
|
|
97
68
|
/**
|
|
@@ -99,11 +70,6 @@ export interface paths {
|
|
|
99
70
|
* description field. If multiple values are specified, each Flow returned
|
|
100
71
|
* is guaranteed to contain at least one of the strings in its
|
|
101
72
|
* description.
|
|
102
|
-
*
|
|
103
|
-
* @example [
|
|
104
|
-
* "hello",
|
|
105
|
-
* "science"
|
|
106
|
-
* ]
|
|
107
73
|
*/
|
|
108
74
|
filter_description?: string[];
|
|
109
75
|
/**
|
|
@@ -111,11 +77,6 @@ export interface paths {
|
|
|
111
77
|
* keywords field. If multiple values are specified, each Flow returned
|
|
112
78
|
* is guaranteed to contain at least one of the substrings as a
|
|
113
79
|
* keyword.
|
|
114
|
-
*
|
|
115
|
-
* @example [
|
|
116
|
-
* "hello",
|
|
117
|
-
* "science"
|
|
118
|
-
* ]
|
|
119
80
|
*/
|
|
120
81
|
filter_keywords?: string[];
|
|
121
82
|
/**
|
|
@@ -130,10 +91,6 @@ export interface paths {
|
|
|
130
91
|
* - description
|
|
131
92
|
* - id
|
|
132
93
|
* - flow_administrators
|
|
133
|
-
*
|
|
134
|
-
* @example [
|
|
135
|
-
* "globus"
|
|
136
|
-
* ]
|
|
137
94
|
*/
|
|
138
95
|
filter_fulltext?: string[];
|
|
139
96
|
/**
|
|
@@ -173,11 +130,6 @@ export interface paths {
|
|
|
173
130
|
*
|
|
174
131
|
* - `ASC`
|
|
175
132
|
* - `DESC`
|
|
176
|
-
*
|
|
177
|
-
* @example [
|
|
178
|
-
* "title ASC",
|
|
179
|
-
* "id DESC"
|
|
180
|
-
* ]
|
|
181
133
|
*/
|
|
182
134
|
orderby?: components["parameters"]["list_flows_orderby"];
|
|
183
135
|
};
|
|
@@ -187,9 +139,10 @@ export interface paths {
|
|
|
187
139
|
};
|
|
188
140
|
requestBody?: never;
|
|
189
141
|
responses: {
|
|
190
|
-
/**
|
|
142
|
+
/**
|
|
143
|
+
* @description The requestor has successfully authenticated and queried the Flow's
|
|
191
144
|
* service for the Flows available for them.
|
|
192
|
-
|
|
145
|
+
*/
|
|
193
146
|
200: {
|
|
194
147
|
headers: {
|
|
195
148
|
[name: string]: unknown;
|
|
@@ -199,24 +152,23 @@ export interface paths {
|
|
|
199
152
|
flows?: components["schemas"]["FlowResponse"][];
|
|
200
153
|
/** @description The number of Flows returned. */
|
|
201
154
|
limit?: number;
|
|
202
|
-
/**
|
|
155
|
+
/**
|
|
156
|
+
* @description An opaque pagination token for iterating through returned
|
|
203
157
|
* Flows.
|
|
204
|
-
|
|
158
|
+
*/
|
|
205
159
|
marker?: string;
|
|
206
160
|
has_next_page?: boolean;
|
|
207
161
|
};
|
|
208
162
|
};
|
|
209
163
|
};
|
|
210
|
-
/** @description There was an issue parsing the query parameters.
|
|
211
|
-
* */
|
|
164
|
+
/** @description There was an issue parsing the query parameters. */
|
|
212
165
|
400: {
|
|
213
166
|
headers: {
|
|
214
167
|
[name: string]: unknown;
|
|
215
168
|
};
|
|
216
169
|
content?: never;
|
|
217
170
|
};
|
|
218
|
-
/** @description The requestor presented a token with insufficient scopes.
|
|
219
|
-
* */
|
|
171
|
+
/** @description The requestor presented a token with insufficient scopes. */
|
|
220
172
|
403: {
|
|
221
173
|
headers: {
|
|
222
174
|
[name: string]: unknown;
|
|
@@ -241,24 +193,25 @@ export interface paths {
|
|
|
241
193
|
content: {
|
|
242
194
|
"application/json": {
|
|
243
195
|
definition: components["schemas"]["FlowDefinition"];
|
|
244
|
-
/**
|
|
196
|
+
/**
|
|
197
|
+
* @description A non-unique, human-friendly name used for displaying the provider
|
|
245
198
|
* to end users.
|
|
246
|
-
|
|
199
|
+
*/
|
|
247
200
|
title?: string;
|
|
248
201
|
/** @description A concise summary of the provider’s purpose. */
|
|
249
202
|
subtitle?: string;
|
|
250
203
|
/** @description A detailed description of the provider for end user display. */
|
|
251
204
|
description?: string;
|
|
252
|
-
/**
|
|
205
|
+
/**
|
|
206
|
+
* @description A set of terms used to categorize the provider which may be used in
|
|
253
207
|
* query and discovery operations. Maximum total length of all
|
|
254
208
|
* keywords is 1024 characters.
|
|
255
|
-
|
|
209
|
+
*/
|
|
256
210
|
keywords?: string[];
|
|
257
211
|
/**
|
|
258
212
|
* @description A set of Principal URNs, or the value "public",
|
|
259
213
|
* indicating the identity of users and/or groups
|
|
260
214
|
* who can view the flow.
|
|
261
|
-
*
|
|
262
215
|
* @example [
|
|
263
216
|
* "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
|
|
264
217
|
* "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
|
|
@@ -268,7 +221,6 @@ export interface paths {
|
|
|
268
221
|
/**
|
|
269
222
|
* @description A set of Principal URNs, or the value "all_authenticated_users",
|
|
270
223
|
* indicating the identity of users who can start the flow.
|
|
271
|
-
*
|
|
272
224
|
* @example [
|
|
273
225
|
* "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
|
|
274
226
|
* "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
|
|
@@ -279,16 +231,16 @@ export interface paths {
|
|
|
279
231
|
* @description The set of Principal URN values of users who may perform
|
|
280
232
|
* administrative operations, including updating the description
|
|
281
233
|
* itself, on the flow.
|
|
282
|
-
*
|
|
283
234
|
* @example [
|
|
284
235
|
* "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
|
|
285
236
|
* "urn:globus:groups:id:fdb38a24-03c1-11e3-86f7-12313809f035"
|
|
286
237
|
* ]
|
|
287
238
|
*/
|
|
288
239
|
flow_administrators?: components["schemas"]["PrincipalURN"][];
|
|
289
|
-
/**
|
|
240
|
+
/**
|
|
241
|
+
* @description A published JSON Schema which input to the Flow must conform
|
|
290
242
|
* to.
|
|
291
|
-
|
|
243
|
+
*/
|
|
292
244
|
input_schema?: Record<string, unknown>;
|
|
293
245
|
run_managers?: components["schemas"]["RunManagers"];
|
|
294
246
|
run_monitors?: components["schemas"]["RunMonitors"];
|
|
@@ -298,16 +250,16 @@ export interface paths {
|
|
|
298
250
|
*
|
|
299
251
|
* If no subscription is specified, the flow may be created
|
|
300
252
|
* but may have limits on how long or how much it can be used.
|
|
301
|
-
*
|
|
302
253
|
*/
|
|
303
254
|
subscription_id?: string;
|
|
304
255
|
};
|
|
305
256
|
};
|
|
306
257
|
};
|
|
307
258
|
responses: {
|
|
308
|
-
/**
|
|
259
|
+
/**
|
|
260
|
+
* @description The Flow definition was successfully deployed onto the Flows
|
|
309
261
|
* service.
|
|
310
|
-
|
|
262
|
+
*/
|
|
311
263
|
201: {
|
|
312
264
|
headers: {
|
|
313
265
|
[name: string]: unknown;
|
|
@@ -316,16 +268,14 @@ export interface paths {
|
|
|
316
268
|
"application/json": components["schemas"]["FlowResponse"];
|
|
317
269
|
};
|
|
318
270
|
};
|
|
319
|
-
/** @description The requestor attempted to deploy a malformed Flow.
|
|
320
|
-
* */
|
|
271
|
+
/** @description The requestor attempted to deploy a malformed Flow. */
|
|
321
272
|
400: {
|
|
322
273
|
headers: {
|
|
323
274
|
[name: string]: unknown;
|
|
324
275
|
};
|
|
325
276
|
content?: never;
|
|
326
277
|
};
|
|
327
|
-
/** @description The requestor is not authorized to deploy a Flow.
|
|
328
|
-
* */
|
|
278
|
+
/** @description The requestor is not authorized to deploy a Flow. */
|
|
329
279
|
403: {
|
|
330
280
|
headers: {
|
|
331
281
|
[name: string]: unknown;
|
|
@@ -364,15 +314,13 @@ export interface paths {
|
|
|
364
314
|
content: {
|
|
365
315
|
"application/json": {
|
|
366
316
|
definition: components["schemas"]["FlowDefinition"];
|
|
367
|
-
/** @description A JSON Schema describing valid input to the flow.
|
|
368
|
-
* */
|
|
317
|
+
/** @description A JSON Schema describing valid input to the flow. */
|
|
369
318
|
input_schema?: Record<string, unknown>;
|
|
370
319
|
};
|
|
371
320
|
};
|
|
372
321
|
};
|
|
373
322
|
responses: {
|
|
374
|
-
/** @description The flow passed all validation checks.
|
|
375
|
-
* */
|
|
323
|
+
/** @description The flow passed all validation checks. */
|
|
376
324
|
200: {
|
|
377
325
|
headers: {
|
|
378
326
|
[name: string]: unknown;
|
|
@@ -381,32 +329,28 @@ export interface paths {
|
|
|
381
329
|
"application/json": components["schemas"]["FlowValidationResponse"];
|
|
382
330
|
};
|
|
383
331
|
};
|
|
384
|
-
/** @description The requestor attempted to validate a malformed flow.
|
|
385
|
-
* */
|
|
332
|
+
/** @description The requestor attempted to validate a malformed flow. */
|
|
386
333
|
400: {
|
|
387
334
|
headers: {
|
|
388
335
|
[name: string]: unknown;
|
|
389
336
|
};
|
|
390
337
|
content?: never;
|
|
391
338
|
};
|
|
392
|
-
/** @description The requestor is not authorized to validate a flow.
|
|
393
|
-
* */
|
|
339
|
+
/** @description The requestor is not authorized to validate a flow. */
|
|
394
340
|
403: {
|
|
395
341
|
headers: {
|
|
396
342
|
[name: string]: unknown;
|
|
397
343
|
};
|
|
398
344
|
content?: never;
|
|
399
345
|
};
|
|
400
|
-
/** @description A conflict was found in the flow definition or input schema.
|
|
401
|
-
* */
|
|
346
|
+
/** @description A conflict was found in the flow definition or input schema. */
|
|
402
347
|
409: {
|
|
403
348
|
headers: {
|
|
404
349
|
[name: string]: unknown;
|
|
405
350
|
};
|
|
406
351
|
content?: never;
|
|
407
352
|
};
|
|
408
|
-
/** @description The flow definition or input schema failed validation checks.
|
|
409
|
-
* */
|
|
353
|
+
/** @description The flow definition or input schema failed validation checks. */
|
|
410
354
|
422: {
|
|
411
355
|
headers: {
|
|
412
356
|
[name: string]: unknown;
|
|
@@ -449,9 +393,10 @@ export interface paths {
|
|
|
449
393
|
};
|
|
450
394
|
requestBody?: never;
|
|
451
395
|
responses: {
|
|
452
|
-
/**
|
|
396
|
+
/**
|
|
397
|
+
* @description The requestor has successfully authenticated and queried the Flow's
|
|
453
398
|
* service for a specific Flow definition.
|
|
454
|
-
|
|
399
|
+
*/
|
|
455
400
|
200: {
|
|
456
401
|
headers: {
|
|
457
402
|
[name: string]: unknown;
|
|
@@ -460,18 +405,20 @@ export interface paths {
|
|
|
460
405
|
"application/json": components["schemas"]["FlowResponse"];
|
|
461
406
|
};
|
|
462
407
|
};
|
|
463
|
-
/**
|
|
408
|
+
/**
|
|
409
|
+
* @description The requestor attempted to retrieve a Flow definition for which they
|
|
464
410
|
* did not have access.
|
|
465
|
-
|
|
411
|
+
*/
|
|
466
412
|
403: {
|
|
467
413
|
headers: {
|
|
468
414
|
[name: string]: unknown;
|
|
469
415
|
};
|
|
470
416
|
content?: never;
|
|
471
417
|
};
|
|
472
|
-
/**
|
|
418
|
+
/**
|
|
419
|
+
* @description The requestor attempted to retrieve a non-existent Flow, or the
|
|
473
420
|
* requestor did not have permissions to view a Flow.
|
|
474
|
-
|
|
421
|
+
*/
|
|
475
422
|
404: {
|
|
476
423
|
headers: {
|
|
477
424
|
[name: string]: unknown;
|
|
@@ -498,35 +445,36 @@ export interface paths {
|
|
|
498
445
|
content: {
|
|
499
446
|
"application/json": {
|
|
500
447
|
definition?: components["schemas"]["FlowDefinition"];
|
|
501
|
-
/**
|
|
448
|
+
/**
|
|
449
|
+
* @description A JSON schema document.
|
|
502
450
|
*
|
|
503
451
|
* When starting the flow, input keys and values must conform to the schema.
|
|
504
452
|
* The Globus Web App uses the input schema to created a guided input page when starting the flow.
|
|
505
|
-
|
|
453
|
+
*/
|
|
506
454
|
input_schema?: Record<string, unknown>;
|
|
507
|
-
/** @description A non-unique, human-friendly name used for displaying the flow to end users.
|
|
508
|
-
* */
|
|
455
|
+
/** @description A non-unique, human-friendly name used for displaying the flow to end users. */
|
|
509
456
|
title?: string;
|
|
510
|
-
/** @description A short summary of the flow's purpose or functionality.
|
|
511
|
-
* */
|
|
457
|
+
/** @description A short summary of the flow's purpose or functionality. */
|
|
512
458
|
subtitle?: string;
|
|
513
|
-
/** @description Arbitrary text to describe the Flow.
|
|
514
|
-
* */
|
|
459
|
+
/** @description Arbitrary text to describe the Flow. */
|
|
515
460
|
description?: string;
|
|
516
|
-
/**
|
|
461
|
+
/**
|
|
462
|
+
* @description If provided, the value must be the calling user's Globus Auth identity URN,
|
|
517
463
|
* and the user must be a flow administrator.
|
|
518
464
|
*
|
|
519
465
|
* It is not possible for non-administrators to take ownership of a flow.
|
|
520
466
|
* Also, it is currently not possible to assign ownership to another user.
|
|
521
|
-
|
|
467
|
+
*/
|
|
522
468
|
flow_owner?: string;
|
|
523
|
-
/**
|
|
469
|
+
/**
|
|
470
|
+
* @description A list of Globus Auth identity and group URNs that may administer the flow.
|
|
524
471
|
*
|
|
525
472
|
* Flow administrators are able to see the full flow definition,
|
|
526
473
|
* including any parameters listed in a "__Private_Parameters" value.
|
|
527
|
-
|
|
474
|
+
*/
|
|
528
475
|
flow_administrators?: string[];
|
|
529
|
-
/**
|
|
476
|
+
/**
|
|
477
|
+
* @description A list of Globus Auth identity and group URNs that may start the flow.
|
|
530
478
|
*
|
|
531
479
|
* It is possible to make a flow available for use to all authenticated users
|
|
532
480
|
* -- including those outside your organization or domain --
|
|
@@ -534,9 +482,10 @@ export interface paths {
|
|
|
534
482
|
*
|
|
535
483
|
* Parameters listed in "__Private_Parameters" values in the definition
|
|
536
484
|
* will be removed from the definition when it is viewed by a flow starter.
|
|
537
|
-
|
|
485
|
+
*/
|
|
538
486
|
flow_starters?: string[];
|
|
539
|
-
/**
|
|
487
|
+
/**
|
|
488
|
+
* @description A list of Globus Auth identity and group URNs that may see the flow,
|
|
540
489
|
* including its definition and input schema.
|
|
541
490
|
*
|
|
542
491
|
* It is possible to make a flow available for viewing to all users
|
|
@@ -545,10 +494,9 @@ export interface paths {
|
|
|
545
494
|
*
|
|
546
495
|
* Parameters listed in "__Private_Parameters" values in the definition
|
|
547
496
|
* will be removed from the definition when it is viewed by a flow starter.
|
|
548
|
-
|
|
497
|
+
*/
|
|
549
498
|
flow_viewers?: string[];
|
|
550
|
-
/** @description A list of keywords that can be used for grouping or identifying flows.
|
|
551
|
-
* */
|
|
499
|
+
/** @description A list of keywords that can be used for grouping or identifying flows. */
|
|
552
500
|
keywords?: string[];
|
|
553
501
|
run_managers?: components["schemas"]["RunManagers"];
|
|
554
502
|
run_monitors?: components["schemas"]["RunMonitors"];
|
|
@@ -557,9 +505,10 @@ export interface paths {
|
|
|
557
505
|
};
|
|
558
506
|
};
|
|
559
507
|
responses: {
|
|
560
|
-
/**
|
|
508
|
+
/**
|
|
509
|
+
* @description The requestor has successfully authenticated and updated the target
|
|
561
510
|
* Flow definition.
|
|
562
|
-
|
|
511
|
+
*/
|
|
563
512
|
200: {
|
|
564
513
|
headers: {
|
|
565
514
|
[name: string]: unknown;
|
|
@@ -568,27 +517,30 @@ export interface paths {
|
|
|
568
517
|
"application/json": components["schemas"]["FlowResponse"];
|
|
569
518
|
};
|
|
570
519
|
};
|
|
571
|
-
/**
|
|
520
|
+
/**
|
|
521
|
+
* @description The Flow definition update failed due to an attempt to perform a
|
|
572
522
|
* malformed update.
|
|
573
|
-
|
|
523
|
+
*/
|
|
574
524
|
400: {
|
|
575
525
|
headers: {
|
|
576
526
|
[name: string]: unknown;
|
|
577
527
|
};
|
|
578
528
|
content?: never;
|
|
579
529
|
};
|
|
580
|
-
/**
|
|
530
|
+
/**
|
|
531
|
+
* @description The requestor attempted to update a Flow for which they did not have
|
|
581
532
|
* access.
|
|
582
|
-
|
|
533
|
+
*/
|
|
583
534
|
403: {
|
|
584
535
|
headers: {
|
|
585
536
|
[name: string]: unknown;
|
|
586
537
|
};
|
|
587
538
|
content?: never;
|
|
588
539
|
};
|
|
589
|
-
/**
|
|
540
|
+
/**
|
|
541
|
+
* @description The requestor attempted to update a non-existent Flow, or the
|
|
590
542
|
* requestor did not have permissions to update a Flow.
|
|
591
|
-
|
|
543
|
+
*/
|
|
592
544
|
404: {
|
|
593
545
|
headers: {
|
|
594
546
|
[name: string]: unknown;
|
|
@@ -614,9 +566,10 @@ export interface paths {
|
|
|
614
566
|
};
|
|
615
567
|
requestBody?: never;
|
|
616
568
|
responses: {
|
|
617
|
-
/**
|
|
569
|
+
/**
|
|
570
|
+
* @description The requestor has successfully removed the Flow from the Flows
|
|
618
571
|
* service.
|
|
619
|
-
|
|
572
|
+
*/
|
|
620
573
|
200: {
|
|
621
574
|
headers: {
|
|
622
575
|
[name: string]: unknown;
|
|
@@ -625,18 +578,20 @@ export interface paths {
|
|
|
625
578
|
"application/json": components["schemas"]["FlowResponse"];
|
|
626
579
|
};
|
|
627
580
|
};
|
|
628
|
-
/**
|
|
581
|
+
/**
|
|
582
|
+
* @description The requestor attempted to modify a Flow for which they did not have
|
|
629
583
|
* access.
|
|
630
|
-
|
|
584
|
+
*/
|
|
631
585
|
403: {
|
|
632
586
|
headers: {
|
|
633
587
|
[name: string]: unknown;
|
|
634
588
|
};
|
|
635
589
|
content?: never;
|
|
636
590
|
};
|
|
637
|
-
/**
|
|
591
|
+
/**
|
|
592
|
+
* @description The requestor attempted to remove a non-existent Flow, or the
|
|
638
593
|
* requestor did not have permissions to remove the Flow.
|
|
639
|
-
|
|
594
|
+
*/
|
|
640
595
|
404: {
|
|
641
596
|
headers: {
|
|
642
597
|
[name: string]: unknown;
|
|
@@ -698,25 +653,24 @@ export interface paths {
|
|
|
698
653
|
"application/json": components["schemas"]["FlowRun"];
|
|
699
654
|
};
|
|
700
655
|
};
|
|
701
|
-
/** @description The Run's input failed validation against the Flow's input schema.
|
|
702
|
-
* */
|
|
656
|
+
/** @description The Run's input failed validation against the Flow's input schema. */
|
|
703
657
|
400: {
|
|
704
658
|
headers: {
|
|
705
659
|
[name: string]: unknown;
|
|
706
660
|
};
|
|
707
661
|
content?: never;
|
|
708
662
|
};
|
|
709
|
-
/** @description The requestor presented a token with insufficient scopes.
|
|
710
|
-
* */
|
|
663
|
+
/** @description The requestor presented a token with insufficient scopes. */
|
|
711
664
|
403: {
|
|
712
665
|
headers: {
|
|
713
666
|
[name: string]: unknown;
|
|
714
667
|
};
|
|
715
668
|
content?: never;
|
|
716
669
|
};
|
|
717
|
-
/**
|
|
670
|
+
/**
|
|
671
|
+
* @description The requestor did not have access to run the provided Flow, or the
|
|
718
672
|
* Flow does not exist.
|
|
719
|
-
|
|
673
|
+
*/
|
|
720
674
|
404: {
|
|
721
675
|
headers: {
|
|
722
676
|
[name: string]: unknown;
|
|
@@ -730,19 +684,21 @@ export interface paths {
|
|
|
730
684
|
};
|
|
731
685
|
content?: never;
|
|
732
686
|
};
|
|
733
|
-
/**
|
|
687
|
+
/**
|
|
688
|
+
* @description An upstream service has imposed rate limiting.
|
|
734
689
|
* The requestor may resubmit the API request.
|
|
735
|
-
|
|
690
|
+
*/
|
|
736
691
|
429: {
|
|
737
692
|
headers: {
|
|
738
693
|
[name: string]: unknown;
|
|
739
694
|
};
|
|
740
695
|
content?: never;
|
|
741
696
|
};
|
|
742
|
-
/**
|
|
697
|
+
/**
|
|
698
|
+
* @description An upstream service returned an uncorrectable error.
|
|
743
699
|
* The error may or may not occur if the API request is submitted again.
|
|
744
700
|
* It may be possible to resubmit the API request.
|
|
745
|
-
|
|
701
|
+
*/
|
|
746
702
|
502: {
|
|
747
703
|
headers: {
|
|
748
704
|
[name: string]: unknown;
|
|
@@ -777,7 +733,6 @@ export interface paths {
|
|
|
777
733
|
*
|
|
778
734
|
* If validation passes, then it is likely that the flow can be started
|
|
779
735
|
* with the same inputs and Globus Auth token.
|
|
780
|
-
*
|
|
781
736
|
*/
|
|
782
737
|
post: {
|
|
783
738
|
parameters: {
|
|
@@ -802,11 +757,12 @@ export interface paths {
|
|
|
802
757
|
};
|
|
803
758
|
};
|
|
804
759
|
responses: {
|
|
805
|
-
/**
|
|
760
|
+
/**
|
|
761
|
+
* @description The inputs and Globus Auth token passed validation.
|
|
806
762
|
*
|
|
807
763
|
* It is likely that the user or client will be able to start the flow
|
|
808
764
|
* using the same Globus Auth token and input values.
|
|
809
|
-
|
|
765
|
+
*/
|
|
810
766
|
200: {
|
|
811
767
|
headers: {
|
|
812
768
|
[name: string]: unknown;
|
|
@@ -815,17 +771,17 @@ export interface paths {
|
|
|
815
771
|
"application/json": components["schemas"]["ValidateRun"];
|
|
816
772
|
};
|
|
817
773
|
};
|
|
818
|
-
/** @description The input body failed validation against the flow's input schema.
|
|
819
|
-
* */
|
|
774
|
+
/** @description The input body failed validation against the flow's input schema. */
|
|
820
775
|
400: {
|
|
821
776
|
headers: {
|
|
822
777
|
[name: string]: unknown;
|
|
823
778
|
};
|
|
824
779
|
content?: never;
|
|
825
780
|
};
|
|
826
|
-
/**
|
|
781
|
+
/**
|
|
782
|
+
* @description The user or client is not allowed to run the flow,
|
|
827
783
|
* or the Globus Auth token is missing required scopes.
|
|
828
|
-
|
|
784
|
+
*/
|
|
829
785
|
403: {
|
|
830
786
|
headers: {
|
|
831
787
|
[name: string]: unknown;
|
|
@@ -877,54 +833,60 @@ export interface paths {
|
|
|
877
833
|
"application/json": components["schemas"]["FlowRun"];
|
|
878
834
|
};
|
|
879
835
|
};
|
|
880
|
-
/**
|
|
836
|
+
/**
|
|
837
|
+
* @description The requestor is not authorized to access the run or flow,
|
|
881
838
|
* or has not provided access tokens with sufficient privileges.
|
|
882
|
-
|
|
839
|
+
*/
|
|
883
840
|
403: {
|
|
884
841
|
headers: {
|
|
885
842
|
[name: string]: unknown;
|
|
886
843
|
};
|
|
887
844
|
content?: never;
|
|
888
845
|
};
|
|
889
|
-
/**
|
|
846
|
+
/**
|
|
847
|
+
* @description The requested Run or Flow was not found. Or, the requestor did not
|
|
890
848
|
* have access to view the Run.
|
|
891
|
-
|
|
849
|
+
*/
|
|
892
850
|
404: {
|
|
893
851
|
headers: {
|
|
894
852
|
[name: string]: unknown;
|
|
895
853
|
};
|
|
896
854
|
content?: never;
|
|
897
855
|
};
|
|
898
|
-
/**
|
|
856
|
+
/**
|
|
857
|
+
* @description The requestor attempted to remove the state for a Run which had
|
|
899
858
|
* not yet reached a completed status.
|
|
900
|
-
|
|
859
|
+
*/
|
|
901
860
|
409: {
|
|
902
861
|
headers: {
|
|
903
862
|
[name: string]: unknown;
|
|
904
863
|
};
|
|
905
864
|
content?: never;
|
|
906
865
|
};
|
|
907
|
-
/**
|
|
866
|
+
/**
|
|
867
|
+
* @description An upstream service rate-limited the request to release the Run.
|
|
908
868
|
* The requestor may re-submit the request at a later time.
|
|
909
|
-
|
|
869
|
+
*/
|
|
910
870
|
429: {
|
|
911
871
|
headers: {
|
|
912
872
|
[name: string]: unknown;
|
|
913
873
|
};
|
|
914
874
|
content?: never;
|
|
915
875
|
};
|
|
916
|
-
/**
|
|
876
|
+
/**
|
|
877
|
+
* @description The run is in an unexpected state in the Flows service.
|
|
917
878
|
* Please contact Globus support.
|
|
918
|
-
|
|
879
|
+
*/
|
|
919
880
|
500: {
|
|
920
881
|
headers: {
|
|
921
882
|
[name: string]: unknown;
|
|
922
883
|
};
|
|
923
884
|
content?: never;
|
|
924
885
|
};
|
|
925
|
-
/**
|
|
886
|
+
/**
|
|
887
|
+
* @description A request to an upstream service failed for an unknown reason.
|
|
926
888
|
* The requestor can re-submit the request or contact Globus support.
|
|
927
|
-
|
|
889
|
+
*/
|
|
928
890
|
502: {
|
|
929
891
|
headers: {
|
|
930
892
|
[name: string]: unknown;
|
|
@@ -983,7 +945,6 @@ export interface paths {
|
|
|
983
945
|
* progress. Performing the resume operation may simply cause a
|
|
984
946
|
* poll to happen more quickly and thus allow the Action to
|
|
985
947
|
* resume more quickly.
|
|
986
|
-
*
|
|
987
948
|
*/
|
|
988
949
|
post: {
|
|
989
950
|
parameters: {
|
|
@@ -1008,9 +969,92 @@ export interface paths {
|
|
|
1008
969
|
"application/json": components["schemas"]["FlowRun"];
|
|
1009
970
|
};
|
|
1010
971
|
};
|
|
1011
|
-
/**
|
|
972
|
+
/**
|
|
973
|
+
* @description The requested Run or Flow was not found. Or, the requestor did not
|
|
1012
974
|
* have access to manage the Run.
|
|
1013
|
-
|
|
975
|
+
*/
|
|
976
|
+
404: {
|
|
977
|
+
headers: {
|
|
978
|
+
[name: string]: unknown;
|
|
979
|
+
};
|
|
980
|
+
content?: never;
|
|
981
|
+
};
|
|
982
|
+
};
|
|
983
|
+
};
|
|
984
|
+
delete?: never;
|
|
985
|
+
options?: never;
|
|
986
|
+
head?: never;
|
|
987
|
+
patch?: never;
|
|
988
|
+
trace?: never;
|
|
989
|
+
};
|
|
990
|
+
"/runs/{run_id}/resume": {
|
|
991
|
+
parameters: {
|
|
992
|
+
query?: never;
|
|
993
|
+
header?: never;
|
|
994
|
+
path: {
|
|
995
|
+
/** @description The run ID */
|
|
996
|
+
run_id: components["parameters"]["run_id"];
|
|
997
|
+
};
|
|
998
|
+
cookie?: never;
|
|
999
|
+
};
|
|
1000
|
+
get?: never;
|
|
1001
|
+
put?: never;
|
|
1002
|
+
/**
|
|
1003
|
+
* Resume a Run
|
|
1004
|
+
* @description Attempt to resume a Run, particularly when it has reached a
|
|
1005
|
+
* status of INACTIVE. A Flow Run may reach an INACTIVE status
|
|
1006
|
+
* when an Action type state within the Flow returns its status
|
|
1007
|
+
* as INACTIVE. The resume operation on the Flow Run provides a
|
|
1008
|
+
* hint that the cause of the Action becoming INACTIVE may have
|
|
1009
|
+
* been cleared, and thus the resume operation on the Action
|
|
1010
|
+
* Provider should be invoked to allow the Action state to resume
|
|
1011
|
+
* and thus resume the Flow Run.
|
|
1012
|
+
*
|
|
1013
|
+
* In the particular case that an Action state is INACTIVE with a
|
|
1014
|
+
* code value of "ConsentRequired" it is further assumed that the
|
|
1015
|
+
* Bearer token provided in the Authorization header on the
|
|
1016
|
+
* resume operation now carries sufficient consents to continue
|
|
1017
|
+
* the INACTIVE Action. Thus, the Flow service will use the
|
|
1018
|
+
* Bearer token to generate new dependent tokens for running the
|
|
1019
|
+
* Action and use these tokens to request that the Action be
|
|
1020
|
+
* resumed at the Action Provider.
|
|
1021
|
+
*
|
|
1022
|
+
* Note again that in reasons other than "ConsentRequired" for a
|
|
1023
|
+
* Flow or Action to go INACTIVE, the resume operation is just a
|
|
1024
|
+
* hint. For example, when the code is "ActivationRequired,"
|
|
1025
|
+
* indicating that a Globus collection or endpoint needs to be
|
|
1026
|
+
* Activated by the user, performing that Activation out-of-band
|
|
1027
|
+
* from the Flow will allow the Flow to proceed even without the
|
|
1028
|
+
* resume operation as the Action is periodically polled for
|
|
1029
|
+
* progress. Performing the resume operation may simply cause a
|
|
1030
|
+
* poll to happen more quickly and thus allow the Action to
|
|
1031
|
+
* resume more quickly.
|
|
1032
|
+
*/
|
|
1033
|
+
post: {
|
|
1034
|
+
parameters: {
|
|
1035
|
+
query?: never;
|
|
1036
|
+
header?: never;
|
|
1037
|
+
path: {
|
|
1038
|
+
/** @description The run ID */
|
|
1039
|
+
run_id: components["parameters"]["run_id"];
|
|
1040
|
+
};
|
|
1041
|
+
cookie?: never;
|
|
1042
|
+
};
|
|
1043
|
+
requestBody?: never;
|
|
1044
|
+
responses: {
|
|
1045
|
+
/** @description The request was successful. */
|
|
1046
|
+
200: {
|
|
1047
|
+
headers: {
|
|
1048
|
+
[name: string]: unknown;
|
|
1049
|
+
};
|
|
1050
|
+
content: {
|
|
1051
|
+
"application/json": components["schemas"]["FlowRun"];
|
|
1052
|
+
};
|
|
1053
|
+
};
|
|
1054
|
+
/**
|
|
1055
|
+
* @description The requested Run or Flow was not found.
|
|
1056
|
+
* Or, the requestor did not have access to manage the Run.
|
|
1057
|
+
*/
|
|
1014
1058
|
404: {
|
|
1015
1059
|
headers: {
|
|
1016
1060
|
[name: string]: unknown;
|
|
@@ -1025,7 +1069,6 @@ export interface paths {
|
|
|
1025
1069
|
patch?: never;
|
|
1026
1070
|
trace?: never;
|
|
1027
1071
|
};
|
|
1028
|
-
"/runs/{run_id}/resume": paths["/flows/{flow_id}/{run_id}/resume"];
|
|
1029
1072
|
"/runs/{run_id}/cancel": {
|
|
1030
1073
|
parameters: {
|
|
1031
1074
|
query?: never;
|
|
@@ -1063,18 +1106,20 @@ export interface paths {
|
|
|
1063
1106
|
"application/json": components["schemas"]["FlowRun"];
|
|
1064
1107
|
};
|
|
1065
1108
|
};
|
|
1066
|
-
/**
|
|
1109
|
+
/**
|
|
1110
|
+
* @description The requested Run or Flow was not found. Or, the requestor did not
|
|
1067
1111
|
* have access to view the Run.
|
|
1068
|
-
|
|
1112
|
+
*/
|
|
1069
1113
|
404: {
|
|
1070
1114
|
headers: {
|
|
1071
1115
|
[name: string]: unknown;
|
|
1072
1116
|
};
|
|
1073
1117
|
content?: never;
|
|
1074
1118
|
};
|
|
1075
|
-
/**
|
|
1119
|
+
/**
|
|
1120
|
+
* @description The service encountered an Upstream error when attempting to cancel
|
|
1076
1121
|
* the Run.
|
|
1077
|
-
|
|
1122
|
+
*/
|
|
1078
1123
|
502: {
|
|
1079
1124
|
headers: {
|
|
1080
1125
|
[name: string]: unknown;
|
|
@@ -1094,11 +1139,15 @@ export interface paths {
|
|
|
1094
1139
|
query?: {
|
|
1095
1140
|
/** @description An integer limit on the number of log records returned. */
|
|
1096
1141
|
limit?: number;
|
|
1097
|
-
/** @description A flag to indicate if log records should be returned in reverse order.
|
|
1098
|
-
* */
|
|
1142
|
+
/** @description A flag to indicate if log records should be returned in reverse order. */
|
|
1099
1143
|
reverse_order?: boolean;
|
|
1100
|
-
/** @description
|
|
1101
|
-
|
|
1144
|
+
/** @description An opaque token used to iterate through pages of returned log records. */
|
|
1145
|
+
marker?: string;
|
|
1146
|
+
/**
|
|
1147
|
+
* @deprecated
|
|
1148
|
+
* @description A token used to iterate through pages of returned log records.
|
|
1149
|
+
* ("marker" is now the preferred name for this parameter.)
|
|
1150
|
+
*/
|
|
1102
1151
|
pagination_token?: string;
|
|
1103
1152
|
};
|
|
1104
1153
|
header?: never;
|
|
@@ -1113,18 +1162,21 @@ export interface paths {
|
|
|
1113
1162
|
/**
|
|
1114
1163
|
* Get execution details on a Run
|
|
1115
1164
|
* @description Retrieve detailed execution information for a particular Flow Run
|
|
1116
|
-
*
|
|
1117
1165
|
*/
|
|
1118
1166
|
get: {
|
|
1119
1167
|
parameters: {
|
|
1120
1168
|
query?: {
|
|
1121
1169
|
/** @description An integer limit on the number of log records returned. */
|
|
1122
1170
|
limit?: number;
|
|
1123
|
-
/** @description A flag to indicate if log records should be returned in reverse order.
|
|
1124
|
-
* */
|
|
1171
|
+
/** @description A flag to indicate if log records should be returned in reverse order. */
|
|
1125
1172
|
reverse_order?: boolean;
|
|
1126
|
-
/** @description
|
|
1127
|
-
|
|
1173
|
+
/** @description An opaque token used to iterate through pages of returned log records. */
|
|
1174
|
+
marker?: string;
|
|
1175
|
+
/**
|
|
1176
|
+
* @deprecated
|
|
1177
|
+
* @description A token used to iterate through pages of returned log records.
|
|
1178
|
+
* ("marker" is now the preferred name for this parameter.)
|
|
1179
|
+
*/
|
|
1128
1180
|
pagination_token?: string;
|
|
1129
1181
|
};
|
|
1130
1182
|
header?: never;
|
|
@@ -1147,27 +1199,115 @@ export interface paths {
|
|
|
1147
1199
|
"application/json": {
|
|
1148
1200
|
/** @description The number of log states returned. */
|
|
1149
1201
|
limit: number;
|
|
1150
|
-
/**
|
|
1202
|
+
/**
|
|
1203
|
+
* @description An opaque pagination token for iterating through returned
|
|
1151
1204
|
* records. If there are no more entries, this field will not
|
|
1152
1205
|
* exist.
|
|
1153
|
-
|
|
1206
|
+
*/
|
|
1154
1207
|
marker?: string;
|
|
1155
1208
|
has_next_page: boolean;
|
|
1156
1209
|
entries: Record<string, unknown>[];
|
|
1157
1210
|
};
|
|
1158
1211
|
};
|
|
1159
1212
|
};
|
|
1160
|
-
/** @description There was an issue parsing the query parameters.
|
|
1161
|
-
* */
|
|
1213
|
+
/** @description There was an issue parsing the query parameters. */
|
|
1162
1214
|
400: {
|
|
1163
1215
|
headers: {
|
|
1164
1216
|
[name: string]: unknown;
|
|
1165
1217
|
};
|
|
1166
1218
|
content?: never;
|
|
1167
1219
|
};
|
|
1168
|
-
/**
|
|
1220
|
+
/**
|
|
1221
|
+
* @description The requested Action or Flow was not found. Or, the
|
|
1169
1222
|
* requestor did not have access to view the Action.
|
|
1170
|
-
|
|
1223
|
+
*/
|
|
1224
|
+
404: {
|
|
1225
|
+
headers: {
|
|
1226
|
+
[name: string]: unknown;
|
|
1227
|
+
};
|
|
1228
|
+
content?: never;
|
|
1229
|
+
};
|
|
1230
|
+
};
|
|
1231
|
+
};
|
|
1232
|
+
put?: never;
|
|
1233
|
+
post?: never;
|
|
1234
|
+
delete?: never;
|
|
1235
|
+
options?: never;
|
|
1236
|
+
head?: never;
|
|
1237
|
+
patch?: never;
|
|
1238
|
+
trace?: never;
|
|
1239
|
+
};
|
|
1240
|
+
"/runs/{run_id}/log": {
|
|
1241
|
+
parameters: {
|
|
1242
|
+
query?: {
|
|
1243
|
+
/** @description An integer limit on the number of log records returned. */
|
|
1244
|
+
limit?: number;
|
|
1245
|
+
/** @description A flag to indicate if log records should be returned in reverse order. */
|
|
1246
|
+
reverse_order?: boolean;
|
|
1247
|
+
/** @description A token used to iterate through pages of returned log records. */
|
|
1248
|
+
pagination_token?: string;
|
|
1249
|
+
};
|
|
1250
|
+
header?: never;
|
|
1251
|
+
path: {
|
|
1252
|
+
/** @description The run ID */
|
|
1253
|
+
run_id: components["parameters"]["run_id"];
|
|
1254
|
+
};
|
|
1255
|
+
cookie?: never;
|
|
1256
|
+
};
|
|
1257
|
+
/**
|
|
1258
|
+
* Get execution details on a Run
|
|
1259
|
+
* @description Retrieve detailed execution information for a particular Flow Run
|
|
1260
|
+
*/
|
|
1261
|
+
get: {
|
|
1262
|
+
parameters: {
|
|
1263
|
+
query?: {
|
|
1264
|
+
/** @description An integer limit on the number of log records returned. */
|
|
1265
|
+
limit?: number;
|
|
1266
|
+
/** @description A flag to indicate if log records should be returned in reverse order. */
|
|
1267
|
+
reverse_order?: boolean;
|
|
1268
|
+
/** @description A token used to iterate through pages of returned log records. */
|
|
1269
|
+
pagination_token?: string;
|
|
1270
|
+
};
|
|
1271
|
+
header?: never;
|
|
1272
|
+
path: {
|
|
1273
|
+
/** @description The run ID */
|
|
1274
|
+
run_id: components["parameters"]["run_id"];
|
|
1275
|
+
};
|
|
1276
|
+
cookie?: never;
|
|
1277
|
+
};
|
|
1278
|
+
requestBody?: never;
|
|
1279
|
+
responses: {
|
|
1280
|
+
/** @description The request was successfully received. */
|
|
1281
|
+
200: {
|
|
1282
|
+
headers: {
|
|
1283
|
+
[name: string]: unknown;
|
|
1284
|
+
};
|
|
1285
|
+
content: {
|
|
1286
|
+
"application/json": {
|
|
1287
|
+
/** @description The number of log states returned. */
|
|
1288
|
+
limit: number;
|
|
1289
|
+
/**
|
|
1290
|
+
* @description An opaque pagination token for iterating through returned
|
|
1291
|
+
* records. If there are no more entries, this field will not
|
|
1292
|
+
* exist.
|
|
1293
|
+
*/
|
|
1294
|
+
marker?: string;
|
|
1295
|
+
has_next_page: boolean;
|
|
1296
|
+
entries: Record<string, unknown>[];
|
|
1297
|
+
};
|
|
1298
|
+
};
|
|
1299
|
+
};
|
|
1300
|
+
/** @description There was an issue parsing the query parameters. */
|
|
1301
|
+
400: {
|
|
1302
|
+
headers: {
|
|
1303
|
+
[name: string]: unknown;
|
|
1304
|
+
};
|
|
1305
|
+
content?: never;
|
|
1306
|
+
};
|
|
1307
|
+
/**
|
|
1308
|
+
* @description The requested Run or Flow was not found.
|
|
1309
|
+
* Or, the requestor did not have access to view the Run.
|
|
1310
|
+
*/
|
|
1171
1311
|
404: {
|
|
1172
1312
|
headers: {
|
|
1173
1313
|
[name: string]: unknown;
|
|
@@ -1184,7 +1324,6 @@ export interface paths {
|
|
|
1184
1324
|
patch?: never;
|
|
1185
1325
|
trace?: never;
|
|
1186
1326
|
};
|
|
1187
|
-
"/runs/{run_id}/log": paths["/flows/{flow_id}/runs/{run_id}/log"];
|
|
1188
1327
|
"/flows/{flow_id}/runs": {
|
|
1189
1328
|
parameters: {
|
|
1190
1329
|
query?: never;
|
|
@@ -1201,17 +1340,17 @@ export interface paths {
|
|
|
1201
1340
|
* the *\/actions endpoint, the response will list the Runs under a
|
|
1202
1341
|
* "actions" key. If hitting the *\/runs endpoint, the response will list
|
|
1203
1342
|
* the Runs under a "runs" key.
|
|
1204
|
-
*
|
|
1205
1343
|
*/
|
|
1206
1344
|
get: {
|
|
1207
1345
|
parameters: {
|
|
1208
1346
|
query?: {
|
|
1209
|
-
/**
|
|
1347
|
+
/**
|
|
1348
|
+
* @description An opaque token used to iterate through pages of returned Actions.
|
|
1210
1349
|
* If provided, all other query arguments will be ignored.
|
|
1211
1350
|
* The marker encodes all state in a given query,
|
|
1212
1351
|
* therefore it's unnecessary to provide query arguments
|
|
1213
1352
|
* once an initial marker has been received.
|
|
1214
|
-
|
|
1353
|
+
*/
|
|
1215
1354
|
marker?: string;
|
|
1216
1355
|
/**
|
|
1217
1356
|
* @deprecated
|
|
@@ -1221,29 +1360,17 @@ export interface paths {
|
|
|
1221
1360
|
* pagination_token encodes all state in a given query, therefore it's
|
|
1222
1361
|
* unnecessary to provide query arguments once an initial token has been
|
|
1223
1362
|
* received.
|
|
1224
|
-
*
|
|
1225
1363
|
*/
|
|
1226
1364
|
pagination_token?: string;
|
|
1227
|
-
/**
|
|
1228
|
-
* @description The number of results to return in a single paged response.
|
|
1229
|
-
*
|
|
1230
|
-
* @example 50
|
|
1231
|
-
*/
|
|
1365
|
+
/** @description The number of results to return in a single paged response. */
|
|
1232
1366
|
per_page?: number;
|
|
1233
|
-
/**
|
|
1234
|
-
* @description The page of results to return.
|
|
1235
|
-
* @example 2
|
|
1236
|
-
*/
|
|
1367
|
+
/** @description The page of results to return. */
|
|
1237
1368
|
page?: number;
|
|
1238
1369
|
/**
|
|
1239
1370
|
* @description Return Actions for which the user has the supplied role. The role the
|
|
1240
1371
|
* user has on the Action dictates the operations they can perform.
|
|
1241
1372
|
* If multiple roles are specified, the user will have at least one of
|
|
1242
1373
|
* the specified roles on each Action returned.
|
|
1243
|
-
*
|
|
1244
|
-
* @example [
|
|
1245
|
-
* "run_manager"
|
|
1246
|
-
* ]
|
|
1247
1374
|
*/
|
|
1248
1375
|
filter_roles?: ("run_owner" | "run_manager" | "run_monitor" | "flow_run_manager" | "flow_run_monitor")[];
|
|
1249
1376
|
/**
|
|
@@ -1256,10 +1383,6 @@ export interface paths {
|
|
|
1256
1383
|
* manager will also include all Actions for which the user
|
|
1257
1384
|
* has "run_monitor" role as well. If not provided, only Actions
|
|
1258
1385
|
* for which the caller has "run_owner" role will be returned.
|
|
1259
|
-
*
|
|
1260
|
-
* @example [
|
|
1261
|
-
* "run_manager"
|
|
1262
|
-
* ]
|
|
1263
1386
|
*/
|
|
1264
1387
|
filter_role?: "run_monitor" | "run_manager" | "run_owner" | "flow_run_manager" | "flow_run_monitor";
|
|
1265
1388
|
/**
|
|
@@ -1268,22 +1391,12 @@ export interface paths {
|
|
|
1268
1391
|
* multiple statuses are specified, each Action returned will be in one
|
|
1269
1392
|
* of the specified states. By default, Actions in any state will be
|
|
1270
1393
|
* returned.
|
|
1271
|
-
*
|
|
1272
|
-
* @example [
|
|
1273
|
-
* "FAILED",
|
|
1274
|
-
* "INACTIVE"
|
|
1275
|
-
* ]
|
|
1276
1394
|
*/
|
|
1277
1395
|
filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
|
|
1278
1396
|
/**
|
|
1279
1397
|
* @description Performs a case insensitive string based search on the Actions'
|
|
1280
1398
|
* label fields. If multiple values are specified, each Action returned
|
|
1281
1399
|
* is guaranteed to contain at least one of the strings in its label.
|
|
1282
|
-
*
|
|
1283
|
-
* @example [
|
|
1284
|
-
* "science",
|
|
1285
|
-
* "tests"
|
|
1286
|
-
* ]
|
|
1287
1400
|
*/
|
|
1288
1401
|
filter_label?: string[];
|
|
1289
1402
|
/**
|
|
@@ -1303,8 +1416,6 @@ export interface paths {
|
|
|
1303
1416
|
*
|
|
1304
1417
|
* Note that runs which are still executing will not have a completion time
|
|
1305
1418
|
* and will be automatically excluded if this filter is applied.
|
|
1306
|
-
*
|
|
1307
|
-
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
1308
1419
|
*/
|
|
1309
1420
|
filter_completion_time?: components["parameters"]["filter_completion_time"];
|
|
1310
1421
|
/**
|
|
@@ -1321,8 +1432,6 @@ export interface paths {
|
|
|
1321
1432
|
*
|
|
1322
1433
|
* Results will contain runs which began between the first datetime
|
|
1323
1434
|
* onwards, up to (but not including) the second datetime.
|
|
1324
|
-
*
|
|
1325
|
-
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
1326
1435
|
*/
|
|
1327
1436
|
filter_start_time?: components["parameters"]["filter_start_time"];
|
|
1328
1437
|
/**
|
|
@@ -1360,11 +1469,6 @@ export interface paths {
|
|
|
1360
1469
|
*
|
|
1361
1470
|
* - `ASC`
|
|
1362
1471
|
* - `DESC`
|
|
1363
|
-
*
|
|
1364
|
-
* @example [
|
|
1365
|
-
* "start_time ASC",
|
|
1366
|
-
* "id DESC"
|
|
1367
|
-
* ]
|
|
1368
1472
|
*/
|
|
1369
1473
|
orderby?: components["parameters"]["list_runs_orderby"];
|
|
1370
1474
|
};
|
|
@@ -1384,27 +1488,28 @@ export interface paths {
|
|
|
1384
1488
|
};
|
|
1385
1489
|
content: {
|
|
1386
1490
|
"application/json": {
|
|
1387
|
-
/**
|
|
1491
|
+
/**
|
|
1492
|
+
* @description An opaque pagination token for iterating through returned
|
|
1388
1493
|
* Actions. If there are no more entries, this field will not
|
|
1389
1494
|
* exist.
|
|
1390
|
-
|
|
1495
|
+
*/
|
|
1391
1496
|
marker?: string;
|
|
1392
1497
|
has_next_page: boolean;
|
|
1393
1498
|
actions: components["schemas"]["FlowRun"][];
|
|
1394
1499
|
};
|
|
1395
1500
|
};
|
|
1396
1501
|
};
|
|
1397
|
-
/** @description The requestor presented a token with insufficient scopes.
|
|
1398
|
-
* */
|
|
1502
|
+
/** @description The requestor presented a token with insufficient scopes. */
|
|
1399
1503
|
403: {
|
|
1400
1504
|
headers: {
|
|
1401
1505
|
[name: string]: unknown;
|
|
1402
1506
|
};
|
|
1403
1507
|
content?: never;
|
|
1404
1508
|
};
|
|
1405
|
-
/**
|
|
1509
|
+
/**
|
|
1510
|
+
* @description The Flow does not exist or the requestor did not have access to
|
|
1406
1511
|
* enumerate the Flow's Actions.
|
|
1407
|
-
|
|
1512
|
+
*/
|
|
1408
1513
|
404: {
|
|
1409
1514
|
headers: {
|
|
1410
1515
|
[name: string]: unknown;
|
|
@@ -1434,17 +1539,17 @@ export interface paths {
|
|
|
1434
1539
|
* the *\/actions endpoint, the response will list the Runs under a
|
|
1435
1540
|
* "actions" key. If hitting the *\/runs endpoint, the response will list
|
|
1436
1541
|
* the Runs under a "runs" key.
|
|
1437
|
-
*
|
|
1438
1542
|
*/
|
|
1439
1543
|
get: {
|
|
1440
1544
|
parameters: {
|
|
1441
1545
|
query?: {
|
|
1442
|
-
/**
|
|
1546
|
+
/**
|
|
1547
|
+
* @description An opaque token used to iterate through pages of returned Actions.
|
|
1443
1548
|
* If provided, all other query arguments will be ignored.
|
|
1444
1549
|
* The marker encodes all state in a given query,
|
|
1445
1550
|
* therefore it's unnecessary to provide query arguments
|
|
1446
1551
|
* once an initial marker has been received.
|
|
1447
|
-
|
|
1552
|
+
*/
|
|
1448
1553
|
marker?: string;
|
|
1449
1554
|
/**
|
|
1450
1555
|
* @deprecated
|
|
@@ -1454,30 +1559,17 @@ export interface paths {
|
|
|
1454
1559
|
* pagination_token encodes all state in a given query, therefore it's
|
|
1455
1560
|
* unnecessary to provide query arguments once an initial token has been
|
|
1456
1561
|
* received.
|
|
1457
|
-
*
|
|
1458
1562
|
*/
|
|
1459
1563
|
pagination_token?: string;
|
|
1460
|
-
/**
|
|
1461
|
-
* @description The number of results to return in a single paged response.
|
|
1462
|
-
*
|
|
1463
|
-
* @example 50
|
|
1464
|
-
*/
|
|
1564
|
+
/** @description The number of results to return in a single paged response. */
|
|
1465
1565
|
per_page?: number;
|
|
1466
|
-
/**
|
|
1467
|
-
* @description The page of results to return.
|
|
1468
|
-
* @example 2
|
|
1469
|
-
*/
|
|
1566
|
+
/** @description The page of results to return. */
|
|
1470
1567
|
page?: number;
|
|
1471
1568
|
/**
|
|
1472
1569
|
* @description Return Runs for which the user has the supplied role. The role the
|
|
1473
1570
|
* user has on the Action dictates the operations they can perform.
|
|
1474
1571
|
* If multiple roles are specified, the user will have at least one of
|
|
1475
1572
|
* the specified roles on each Action returned.
|
|
1476
|
-
*
|
|
1477
|
-
* @example [
|
|
1478
|
-
* "run_owner",
|
|
1479
|
-
* "run_managers"
|
|
1480
|
-
* ]
|
|
1481
1573
|
*/
|
|
1482
1574
|
filter_roles?: ("run_owner" | "run_managers" | "run_monitors" | "flow_run_managers" | "flow_run_monitors")[];
|
|
1483
1575
|
/**
|
|
@@ -1490,8 +1582,6 @@ export interface paths {
|
|
|
1490
1582
|
* manager will also include all Runs for which the user
|
|
1491
1583
|
* has "run_monitor" role as well. If not provided, only Runs
|
|
1492
1584
|
* for which the caller has "run_owner" role will be returned.
|
|
1493
|
-
*
|
|
1494
|
-
* @example run_manager
|
|
1495
1585
|
*/
|
|
1496
1586
|
filter_role?: "run_monitor" | "run_manager" | "run_owner";
|
|
1497
1587
|
/**
|
|
@@ -1500,22 +1590,12 @@ export interface paths {
|
|
|
1500
1590
|
* multiple statuses are specified, each Action returned will be in one
|
|
1501
1591
|
* of the specified states. By default, Actions in any state will be
|
|
1502
1592
|
* returned.
|
|
1503
|
-
*
|
|
1504
|
-
* @example [
|
|
1505
|
-
* "FAILED",
|
|
1506
|
-
* "INACTIVE"
|
|
1507
|
-
* ]
|
|
1508
1593
|
*/
|
|
1509
1594
|
filter_status?: ("SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE")[];
|
|
1510
1595
|
/**
|
|
1511
1596
|
* @description Performs a case insensitive string based search on the Actions'
|
|
1512
1597
|
* label fields. If multiple values are specified, each Action returned
|
|
1513
1598
|
* is guaranteed to contain at least one of the strings in its label.
|
|
1514
|
-
*
|
|
1515
|
-
* @example [
|
|
1516
|
-
* "science",
|
|
1517
|
-
* "tests"
|
|
1518
|
-
* ]
|
|
1519
1599
|
*/
|
|
1520
1600
|
filter_label?: string[];
|
|
1521
1601
|
/**
|
|
@@ -1523,11 +1603,6 @@ export interface paths {
|
|
|
1523
1603
|
* Actions which have parent Flow's with a matching title(s). If
|
|
1524
1604
|
* multiple values are specified, each Action returned will have a
|
|
1525
1605
|
* parent Flow with a title matching at least one of the strings.
|
|
1526
|
-
*
|
|
1527
|
-
* @example [
|
|
1528
|
-
* "globus",
|
|
1529
|
-
* "tests"
|
|
1530
|
-
* ]
|
|
1531
1606
|
*/
|
|
1532
1607
|
filter_flow_title?: string[];
|
|
1533
1608
|
/**
|
|
@@ -1535,11 +1610,6 @@ export interface paths {
|
|
|
1535
1610
|
* initiated from the specified Flow ID(s). If multiple values are
|
|
1536
1611
|
* specified, each Run returned will have been initiated from at least
|
|
1537
1612
|
* one of the specified Flow IDs.
|
|
1538
|
-
*
|
|
1539
|
-
* @example [
|
|
1540
|
-
* "00000000-19d9-4f5b-9329-22ed12d4d3dd",
|
|
1541
|
-
* "11111111-19a5-4d19-998e-0709c40321e9"
|
|
1542
|
-
* ]
|
|
1543
1613
|
*/
|
|
1544
1614
|
filter_flow_id?: string[];
|
|
1545
1615
|
/**
|
|
@@ -1559,8 +1629,6 @@ export interface paths {
|
|
|
1559
1629
|
*
|
|
1560
1630
|
* Note that runs which are still executing will not have a completion time
|
|
1561
1631
|
* and will be automatically excluded if this filter is applied.
|
|
1562
|
-
*
|
|
1563
|
-
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
1564
1632
|
*/
|
|
1565
1633
|
filter_completion_time?: components["parameters"]["filter_completion_time"];
|
|
1566
1634
|
/**
|
|
@@ -1577,8 +1645,6 @@ export interface paths {
|
|
|
1577
1645
|
*
|
|
1578
1646
|
* Results will contain runs which began between the first datetime
|
|
1579
1647
|
* onwards, up to (but not including) the second datetime.
|
|
1580
|
-
*
|
|
1581
|
-
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
1582
1648
|
*/
|
|
1583
1649
|
filter_start_time?: components["parameters"]["filter_start_time"];
|
|
1584
1650
|
/**
|
|
@@ -1616,11 +1682,6 @@ export interface paths {
|
|
|
1616
1682
|
*
|
|
1617
1683
|
* - `ASC`
|
|
1618
1684
|
* - `DESC`
|
|
1619
|
-
*
|
|
1620
|
-
* @example [
|
|
1621
|
-
* "start_time ASC",
|
|
1622
|
-
* "id DESC"
|
|
1623
|
-
* ]
|
|
1624
1685
|
*/
|
|
1625
1686
|
orderby?: components["parameters"]["list_runs_orderby"];
|
|
1626
1687
|
};
|
|
@@ -1637,10 +1698,11 @@ export interface paths {
|
|
|
1637
1698
|
};
|
|
1638
1699
|
content: {
|
|
1639
1700
|
"application/json": {
|
|
1640
|
-
/**
|
|
1701
|
+
/**
|
|
1702
|
+
* @description An opaque pagination token for iterating through returned
|
|
1641
1703
|
* Actions. If there are no more entries, this field will not
|
|
1642
1704
|
* exist.
|
|
1643
|
-
|
|
1705
|
+
*/
|
|
1644
1706
|
marker?: string;
|
|
1645
1707
|
has_next_page: boolean;
|
|
1646
1708
|
actions?: components["schemas"]["FlowRun"][];
|
|
@@ -1648,17 +1710,17 @@ export interface paths {
|
|
|
1648
1710
|
};
|
|
1649
1711
|
};
|
|
1650
1712
|
};
|
|
1651
|
-
/** @description The requestor presented a token with insufficient scopes.
|
|
1652
|
-
* */
|
|
1713
|
+
/** @description The requestor presented a token with insufficient scopes. */
|
|
1653
1714
|
403: {
|
|
1654
1715
|
headers: {
|
|
1655
1716
|
[name: string]: unknown;
|
|
1656
1717
|
};
|
|
1657
1718
|
content?: never;
|
|
1658
1719
|
};
|
|
1659
|
-
/**
|
|
1720
|
+
/**
|
|
1721
|
+
* @description The Flow does not exist or the requestor did not have access to
|
|
1660
1722
|
* enumerate the Actions.
|
|
1661
|
-
|
|
1723
|
+
*/
|
|
1662
1724
|
404: {
|
|
1663
1725
|
headers: {
|
|
1664
1726
|
[name: string]: unknown;
|
|
@@ -1688,7 +1750,6 @@ export interface paths {
|
|
|
1688
1750
|
/**
|
|
1689
1751
|
* Get details about a run
|
|
1690
1752
|
* @description Get details about a run.
|
|
1691
|
-
*
|
|
1692
1753
|
*/
|
|
1693
1754
|
get: {
|
|
1694
1755
|
parameters: {
|
|
@@ -1696,8 +1757,6 @@ export interface paths {
|
|
|
1696
1757
|
/**
|
|
1697
1758
|
* @description If present and set to a true value,
|
|
1698
1759
|
* metadata about the associated flow will be included.
|
|
1699
|
-
*
|
|
1700
|
-
* @example true
|
|
1701
1760
|
*/
|
|
1702
1761
|
include_flow_description?: true | true | false | false;
|
|
1703
1762
|
};
|
|
@@ -1719,17 +1778,17 @@ export interface paths {
|
|
|
1719
1778
|
"application/json": components["schemas"]["FlowRunWithFlowEmbed"];
|
|
1720
1779
|
};
|
|
1721
1780
|
};
|
|
1722
|
-
/** @description The requestor presented a token with insufficient scopes.
|
|
1723
|
-
* */
|
|
1781
|
+
/** @description The requestor presented a token with insufficient scopes. */
|
|
1724
1782
|
403: {
|
|
1725
1783
|
headers: {
|
|
1726
1784
|
[name: string]: unknown;
|
|
1727
1785
|
};
|
|
1728
1786
|
content?: never;
|
|
1729
1787
|
};
|
|
1730
|
-
/**
|
|
1788
|
+
/**
|
|
1789
|
+
* @description The Run does not exist or the requestor did not have access to
|
|
1731
1790
|
* view the Run's status.
|
|
1732
|
-
|
|
1791
|
+
*/
|
|
1733
1792
|
404: {
|
|
1734
1793
|
headers: {
|
|
1735
1794
|
[name: string]: unknown;
|
|
@@ -1745,7 +1804,6 @@ export interface paths {
|
|
|
1745
1804
|
* By default only the Run initiator is able to modify a Run's metadata.
|
|
1746
1805
|
* Note that delegating manage access to a principal will allow them
|
|
1747
1806
|
* to further alter the principals with monitor and manage access.
|
|
1748
|
-
*
|
|
1749
1807
|
*/
|
|
1750
1808
|
put: {
|
|
1751
1809
|
parameters: {
|
|
@@ -1772,43 +1830,44 @@ export interface paths {
|
|
|
1772
1830
|
"application/json": components["schemas"]["FlowRun"];
|
|
1773
1831
|
};
|
|
1774
1832
|
};
|
|
1775
|
-
/** @description The requestor presented a token with insufficient scopes.
|
|
1776
|
-
* */
|
|
1833
|
+
/** @description The requestor presented a token with insufficient scopes. */
|
|
1777
1834
|
403: {
|
|
1778
1835
|
headers: {
|
|
1779
1836
|
[name: string]: unknown;
|
|
1780
1837
|
};
|
|
1781
1838
|
content?: never;
|
|
1782
1839
|
};
|
|
1783
|
-
/**
|
|
1840
|
+
/**
|
|
1841
|
+
* @description The Run does not exist or the requestor did not have access to
|
|
1784
1842
|
* modify the Run.
|
|
1785
|
-
|
|
1843
|
+
*/
|
|
1786
1844
|
404: {
|
|
1787
1845
|
headers: {
|
|
1788
1846
|
[name: string]: unknown;
|
|
1789
1847
|
};
|
|
1790
1848
|
content?: never;
|
|
1791
1849
|
};
|
|
1792
|
-
/** @description The request's JSON body did not pass schema validation.
|
|
1793
|
-
* */
|
|
1850
|
+
/** @description The request's JSON body did not pass schema validation. */
|
|
1794
1851
|
422: {
|
|
1795
1852
|
headers: {
|
|
1796
1853
|
[name: string]: unknown;
|
|
1797
1854
|
};
|
|
1798
1855
|
content?: never;
|
|
1799
1856
|
};
|
|
1800
|
-
/**
|
|
1857
|
+
/**
|
|
1858
|
+
* @description An upstream service has imposed rate limiting.
|
|
1801
1859
|
* The requestor may resubmit the API request.
|
|
1802
|
-
|
|
1860
|
+
*/
|
|
1803
1861
|
429: {
|
|
1804
1862
|
headers: {
|
|
1805
1863
|
[name: string]: unknown;
|
|
1806
1864
|
};
|
|
1807
1865
|
content?: never;
|
|
1808
1866
|
};
|
|
1809
|
-
/**
|
|
1867
|
+
/**
|
|
1868
|
+
* @description An unknown upstream service error occurred.
|
|
1810
1869
|
* The problem may be resolved by re-submitting the API request.
|
|
1811
|
-
|
|
1870
|
+
*/
|
|
1812
1871
|
502: {
|
|
1813
1872
|
headers: {
|
|
1814
1873
|
[name: string]: unknown;
|
|
@@ -1840,7 +1899,6 @@ export interface paths {
|
|
|
1840
1899
|
*
|
|
1841
1900
|
* This route allows users to view the Flow definition and input schema
|
|
1842
1901
|
* that were used to start a given Run.
|
|
1843
|
-
*
|
|
1844
1902
|
*/
|
|
1845
1903
|
get: {
|
|
1846
1904
|
parameters: {
|
|
@@ -1863,16 +1921,14 @@ export interface paths {
|
|
|
1863
1921
|
"application/json": components["schemas"]["GetRunDefinitionResponse"];
|
|
1864
1922
|
};
|
|
1865
1923
|
};
|
|
1866
|
-
/** @description The requestor presented a token with insufficient scopes.
|
|
1867
|
-
* */
|
|
1924
|
+
/** @description The requestor presented a token with insufficient scopes. */
|
|
1868
1925
|
403: {
|
|
1869
1926
|
headers: {
|
|
1870
1927
|
[name: string]: unknown;
|
|
1871
1928
|
};
|
|
1872
1929
|
content?: never;
|
|
1873
1930
|
};
|
|
1874
|
-
/** @description The Run does not exist or the requestor did not have access to view the Run.
|
|
1875
|
-
* */
|
|
1931
|
+
/** @description The Run does not exist or the requestor did not have access to view the Run. */
|
|
1876
1932
|
404: {
|
|
1877
1933
|
headers: {
|
|
1878
1934
|
[name: string]: unknown;
|
|
@@ -1930,6 +1986,144 @@ export interface paths {
|
|
|
1930
1986
|
patch?: never;
|
|
1931
1987
|
trace?: never;
|
|
1932
1988
|
};
|
|
1989
|
+
"/registered_apis": {
|
|
1990
|
+
parameters: {
|
|
1991
|
+
query?: never;
|
|
1992
|
+
header?: never;
|
|
1993
|
+
path?: never;
|
|
1994
|
+
cookie?: never;
|
|
1995
|
+
};
|
|
1996
|
+
/**
|
|
1997
|
+
* List Registered APIs
|
|
1998
|
+
* @description Retrieve a listing of Registered APIs available to a user
|
|
1999
|
+
* according to the permissions (role) they have on the Registered API.
|
|
2000
|
+
*/
|
|
2001
|
+
get: {
|
|
2002
|
+
parameters: {
|
|
2003
|
+
query?: {
|
|
2004
|
+
/**
|
|
2005
|
+
* @description An opaque token used to iterate through pages of returned Registered APIs.
|
|
2006
|
+
* If provided, all other query arguments will be ignored.
|
|
2007
|
+
* The marker encodes all state in a given query,
|
|
2008
|
+
* therefore it's unnecessary to provide query arguments
|
|
2009
|
+
* once an initial marker has been received.
|
|
2010
|
+
*/
|
|
2011
|
+
marker?: string;
|
|
2012
|
+
/** @description The number of results to return in a single paged response. */
|
|
2013
|
+
per_page?: number;
|
|
2014
|
+
/**
|
|
2015
|
+
* @description Return Registered APIs for which the user has one of the supplied roles.
|
|
2016
|
+
* The role the user has on the Registered API dictates the operations they
|
|
2017
|
+
* can perform. If multiple roles are specified (comma-separated), the user
|
|
2018
|
+
* will have at least one of the specified roles on each Registered API returned.
|
|
2019
|
+
* If not provided, only Registered APIs for which the caller has "owner"
|
|
2020
|
+
* role will be returned.
|
|
2021
|
+
*/
|
|
2022
|
+
filter_roles?: ("owner" | "administrator" | "viewer")[];
|
|
2023
|
+
/**
|
|
2024
|
+
* @description Ordering criteria to apply to the list of Registered APIs.
|
|
2025
|
+
*
|
|
2026
|
+
* This field is a comma-separated list of sort criteria,
|
|
2027
|
+
* and follows this syntax:
|
|
2028
|
+
*
|
|
2029
|
+
* ```
|
|
2030
|
+
* CRITERION1[,CRITERION2[,...]]
|
|
2031
|
+
* ```
|
|
2032
|
+
*
|
|
2033
|
+
* and each individual `CRITERION` follows this syntax:
|
|
2034
|
+
*
|
|
2035
|
+
* ```
|
|
2036
|
+
* FIELD ORDERING
|
|
2037
|
+
* ```
|
|
2038
|
+
*
|
|
2039
|
+
* The first value, `FIELD`, indicates the field to sort by;
|
|
2040
|
+
* the second value, `ORDERING`, indicates the sorting order.
|
|
2041
|
+
*
|
|
2042
|
+
* When additional comma-separated criteria are added,
|
|
2043
|
+
* the first criterion will be used to sort the data;
|
|
2044
|
+
* subsequent criteria will be applied for ties.
|
|
2045
|
+
*
|
|
2046
|
+
* Supported fields are:
|
|
2047
|
+
*
|
|
2048
|
+
* - `id`
|
|
2049
|
+
* - `name`
|
|
2050
|
+
* - `created_timestamp`
|
|
2051
|
+
* - `updated_timestamp`
|
|
2052
|
+
*
|
|
2053
|
+
* Supported orderings are:
|
|
2054
|
+
*
|
|
2055
|
+
* - `ASC`
|
|
2056
|
+
* - `DESC`
|
|
2057
|
+
*/
|
|
2058
|
+
orderby?: components["parameters"]["list_registered_apis_orderby"];
|
|
2059
|
+
};
|
|
2060
|
+
header?: never;
|
|
2061
|
+
path?: never;
|
|
2062
|
+
cookie?: never;
|
|
2063
|
+
};
|
|
2064
|
+
requestBody?: never;
|
|
2065
|
+
responses: {
|
|
2066
|
+
/**
|
|
2067
|
+
* @description The requestor has successfully authenticated and queried the Flows
|
|
2068
|
+
* service for the Registered APIs available for them.
|
|
2069
|
+
*/
|
|
2070
|
+
200: {
|
|
2071
|
+
headers: {
|
|
2072
|
+
[name: string]: unknown;
|
|
2073
|
+
};
|
|
2074
|
+
content: {
|
|
2075
|
+
"application/json": {
|
|
2076
|
+
registered_apis: components["schemas"]["RegisteredApiSummary"][];
|
|
2077
|
+
/** @description The number of Registered APIs returned. */
|
|
2078
|
+
limit: number;
|
|
2079
|
+
/**
|
|
2080
|
+
* @description An opaque pagination token for iterating through returned
|
|
2081
|
+
* Registered APIs. Null if there are no more pages.
|
|
2082
|
+
*/
|
|
2083
|
+
marker?: string | null;
|
|
2084
|
+
/** @description Whether there are more results available. */
|
|
2085
|
+
has_next_page: boolean;
|
|
2086
|
+
};
|
|
2087
|
+
};
|
|
2088
|
+
};
|
|
2089
|
+
/** @description There was an issue parsing the query parameters. */
|
|
2090
|
+
400: {
|
|
2091
|
+
headers: {
|
|
2092
|
+
[name: string]: unknown;
|
|
2093
|
+
};
|
|
2094
|
+
content?: never;
|
|
2095
|
+
};
|
|
2096
|
+
/** @description The requestor presented a token with insufficient scopes. */
|
|
2097
|
+
403: {
|
|
2098
|
+
headers: {
|
|
2099
|
+
[name: string]: unknown;
|
|
2100
|
+
};
|
|
2101
|
+
content?: never;
|
|
2102
|
+
};
|
|
2103
|
+
/** @description The requested resource was not found. */
|
|
2104
|
+
404: {
|
|
2105
|
+
headers: {
|
|
2106
|
+
[name: string]: unknown;
|
|
2107
|
+
};
|
|
2108
|
+
content?: never;
|
|
2109
|
+
};
|
|
2110
|
+
/** @description The request's query parameters did not pass validation. */
|
|
2111
|
+
422: {
|
|
2112
|
+
headers: {
|
|
2113
|
+
[name: string]: unknown;
|
|
2114
|
+
};
|
|
2115
|
+
content?: never;
|
|
2116
|
+
};
|
|
2117
|
+
};
|
|
2118
|
+
};
|
|
2119
|
+
put?: never;
|
|
2120
|
+
post?: never;
|
|
2121
|
+
delete?: never;
|
|
2122
|
+
options?: never;
|
|
2123
|
+
head?: never;
|
|
2124
|
+
patch?: never;
|
|
2125
|
+
trace?: never;
|
|
2126
|
+
};
|
|
1933
2127
|
}
|
|
1934
2128
|
export type webhooks = Record<string, never>;
|
|
1935
2129
|
export interface components {
|
|
@@ -1941,7 +2135,6 @@ export interface components {
|
|
|
1941
2135
|
* If this parameter is used when updating a flow,
|
|
1942
2136
|
* runs that are currently executing will continue to use the definition
|
|
1943
2137
|
* that they were initially started with.
|
|
1944
|
-
*
|
|
1945
2138
|
*/
|
|
1946
2139
|
FlowDefinition: {
|
|
1947
2140
|
Comment?: string;
|
|
@@ -1951,34 +2144,28 @@ export interface components {
|
|
|
1951
2144
|
};
|
|
1952
2145
|
};
|
|
1953
2146
|
FlowRun: {
|
|
1954
|
-
/** @description The ID for a particular Flow invocation. Analogous to a run_id.
|
|
1955
|
-
* */
|
|
2147
|
+
/** @description The ID for a particular Flow invocation. Analogous to a run_id. */
|
|
1956
2148
|
action_id: string;
|
|
1957
|
-
/** @description The ID for a particular Flow invocation. Analogous to an action_id.
|
|
1958
|
-
* */
|
|
2149
|
+
/** @description The ID for a particular Flow invocation. Analogous to an action_id. */
|
|
1959
2150
|
run_id: string;
|
|
1960
|
-
/** @description The Flow to which this Run belongs.
|
|
1961
|
-
* */
|
|
2151
|
+
/** @description The Flow to which this Run belongs. */
|
|
1962
2152
|
flow_id: string;
|
|
1963
2153
|
/**
|
|
1964
2154
|
* Format: date-time
|
|
1965
2155
|
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
1966
2156
|
* which the last update to this Run's Flow occurred.
|
|
1967
|
-
*
|
|
1968
2157
|
*/
|
|
1969
2158
|
flow_last_updated: string;
|
|
1970
2159
|
/**
|
|
1971
2160
|
* Format: date-time
|
|
1972
2161
|
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
1973
2162
|
* which this Run started.
|
|
1974
|
-
*
|
|
1975
2163
|
*/
|
|
1976
2164
|
start_time: string;
|
|
1977
2165
|
/**
|
|
1978
2166
|
* Format: date-time
|
|
1979
2167
|
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
1980
2168
|
* which this Run reached a completed status.
|
|
1981
|
-
*
|
|
1982
2169
|
*/
|
|
1983
2170
|
completion_time: string;
|
|
1984
2171
|
label: components["schemas"]["Label"];
|
|
@@ -1988,38 +2175,37 @@ export interface components {
|
|
|
1988
2175
|
*/
|
|
1989
2176
|
status: "SUCCEEDED" | "FAILED" | "ENDED" | "ACTIVE" | "INACTIVE";
|
|
1990
2177
|
display_status?: string;
|
|
1991
|
-
/**
|
|
2178
|
+
/**
|
|
2179
|
+
* @description Details about the run execution. This is null for runs of High Assurance
|
|
1992
2180
|
* flows when listing runs.
|
|
1993
|
-
|
|
2181
|
+
*/
|
|
1994
2182
|
details: Record<string, unknown> | null;
|
|
1995
2183
|
run_owner: components["schemas"]["PrincipalURN"];
|
|
1996
2184
|
run_monitors?: components["schemas"]["RunMonitors"];
|
|
1997
2185
|
run_managers?: components["schemas"]["RunManagers"];
|
|
1998
2186
|
/**
|
|
2187
|
+
* @deprecated
|
|
1999
2188
|
* @description The role the requesting user has on the Run.
|
|
2000
|
-
*
|
|
2001
2189
|
* @enum {string}
|
|
2002
2190
|
*/
|
|
2003
|
-
user_role: "run_monitor" | "run_manager" | "run_owner";
|
|
2191
|
+
user_role: "run_monitor" | "run_manager" | "run_owner" | "flow_run_monitor" | "flow_run_manager";
|
|
2192
|
+
/** @description The list of all roles the requesting user has on the Run. */
|
|
2193
|
+
user_roles?: ("run_monitor" | "run_manager" | "run_owner" | "flow_run_monitor" | "flow_run_manager")[];
|
|
2004
2194
|
tags: components["schemas"]["Tags"];
|
|
2005
2195
|
};
|
|
2006
2196
|
ValidateRun: {
|
|
2007
2197
|
/**
|
|
2008
2198
|
* @description A message indicating the validation was successful
|
|
2009
|
-
*
|
|
2010
2199
|
* @example success
|
|
2011
2200
|
*/
|
|
2012
2201
|
message: string;
|
|
2013
2202
|
};
|
|
2014
2203
|
GetRunDefinitionResponse: {
|
|
2015
|
-
/** @description The Flow used to start the Run.
|
|
2016
|
-
* */
|
|
2204
|
+
/** @description The Flow used to start the Run. */
|
|
2017
2205
|
flow_id: string;
|
|
2018
|
-
/** @description The definition of the Flow at the time the Run was started.
|
|
2019
|
-
* */
|
|
2206
|
+
/** @description The definition of the Flow at the time the Run was started. */
|
|
2020
2207
|
definition: Record<string, unknown>;
|
|
2021
|
-
/** @description The input schema of the Flow at the time the Run was started.
|
|
2022
|
-
* */
|
|
2208
|
+
/** @description The input schema of the Flow at the time the Run was started. */
|
|
2023
2209
|
input_schema: Record<string, unknown>;
|
|
2024
2210
|
};
|
|
2025
2211
|
FlowEmbed: {
|
|
@@ -2030,33 +2216,30 @@ export interface components {
|
|
|
2030
2216
|
* Format: date-time
|
|
2031
2217
|
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2032
2218
|
* which the Flow was created.
|
|
2033
|
-
*
|
|
2034
2219
|
*/
|
|
2035
2220
|
created_at: string;
|
|
2036
2221
|
/**
|
|
2037
2222
|
* Format: date-time
|
|
2038
2223
|
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2039
2224
|
* which the Flow was last updated.
|
|
2040
|
-
*
|
|
2041
2225
|
*/
|
|
2042
2226
|
updated_at?: string;
|
|
2043
2227
|
/**
|
|
2044
2228
|
* Format: date-time
|
|
2045
2229
|
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2046
2230
|
* which the Flow was deleted (not present if the Flow has not been deleted).
|
|
2047
|
-
*
|
|
2048
2231
|
*/
|
|
2049
2232
|
deleted_at?: string;
|
|
2050
|
-
/** @description A non-unique, human-friendly name used for displaying the Flow to end users.
|
|
2051
|
-
* */
|
|
2233
|
+
/** @description A non-unique, human-friendly name used for displaying the Flow to end users. */
|
|
2052
2234
|
title: string;
|
|
2053
2235
|
/** @description A concise summary of the Flow's purpose. */
|
|
2054
2236
|
subtitle?: string;
|
|
2055
2237
|
/** @description A detailed description of the Flow for end user display. */
|
|
2056
2238
|
description?: string;
|
|
2057
|
-
/**
|
|
2239
|
+
/**
|
|
2240
|
+
* @description A set of terms used to categorize the Flow which may be used in
|
|
2058
2241
|
* query and discovery operations.
|
|
2059
|
-
|
|
2242
|
+
*/
|
|
2060
2243
|
keywords?: string[];
|
|
2061
2244
|
};
|
|
2062
2245
|
FlowRunWithFlowEmbed: components["schemas"]["FlowRun"] & {
|
|
@@ -2075,7 +2258,6 @@ export interface components {
|
|
|
2075
2258
|
ActivityNotificationPolicy: {
|
|
2076
2259
|
/**
|
|
2077
2260
|
* @description The set of statuses on which to notify the run's owner by email.
|
|
2078
|
-
*
|
|
2079
2261
|
* @default [
|
|
2080
2262
|
* "INACTIVE"
|
|
2081
2263
|
* ]
|
|
@@ -2105,7 +2287,6 @@ export interface components {
|
|
|
2105
2287
|
*
|
|
2106
2288
|
* Only users with the "run_manager" role will be able to view this list.
|
|
2107
2289
|
* Users with only the "run_monitor" role will see an empty list.
|
|
2108
|
-
*
|
|
2109
2290
|
*/
|
|
2110
2291
|
RunManagers: components["schemas"]["PrincipalURN"][];
|
|
2111
2292
|
/**
|
|
@@ -2116,7 +2297,6 @@ export interface components {
|
|
|
2116
2297
|
*
|
|
2117
2298
|
* Only users with the "run_manager" role will be able to view this list.
|
|
2118
2299
|
* Users with only the "run_monitor" role will see an empty list.
|
|
2119
|
-
*
|
|
2120
2300
|
*/
|
|
2121
2301
|
RunMonitors: components["schemas"]["PrincipalURN"][];
|
|
2122
2302
|
/**
|
|
@@ -2128,7 +2308,6 @@ export interface components {
|
|
|
2128
2308
|
*
|
|
2129
2309
|
* When updating a run, existing tags will be overwritten.
|
|
2130
2310
|
* This means that an empty array will delete all existing tags.
|
|
2131
|
-
*
|
|
2132
2311
|
* @example [
|
|
2133
2312
|
* "Experiment:xDA202",
|
|
2134
2313
|
* "Site:Nautilus",
|
|
@@ -2139,7 +2318,6 @@ export interface components {
|
|
|
2139
2318
|
/**
|
|
2140
2319
|
* @description A URN representation of an Identity in Globus either of a user from
|
|
2141
2320
|
* Globus Auth or a group from Globus Groups.
|
|
2142
|
-
*
|
|
2143
2321
|
* @example urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c
|
|
2144
2322
|
*/
|
|
2145
2323
|
PrincipalURN: string;
|
|
@@ -2279,36 +2457,35 @@ export interface components {
|
|
|
2279
2457
|
FlowResponse: {
|
|
2280
2458
|
/** @description The unique identifier for the Flow. */
|
|
2281
2459
|
id?: string;
|
|
2282
|
-
/** @description The flow definition. This is null for High Assurance flows when listing flows.
|
|
2283
|
-
* */
|
|
2460
|
+
/** @description The flow definition. This is null for High Assurance flows when listing flows. */
|
|
2284
2461
|
definition?: components["schemas"]["FlowDefinition"];
|
|
2285
|
-
/**
|
|
2462
|
+
/**
|
|
2463
|
+
* @description A JSON Schema compliant definition of the format of the `body` field
|
|
2286
2464
|
* when requesting a Flow be run. This is null for High Assurance flows when listing flows.
|
|
2287
|
-
|
|
2465
|
+
*/
|
|
2288
2466
|
input_schema?: Record<string, unknown> | null;
|
|
2289
2467
|
/**
|
|
2290
2468
|
* Format: uri
|
|
2291
2469
|
* @description The scope of any bearer token to be used on authenticated accesses
|
|
2292
2470
|
* to the Flow.
|
|
2293
|
-
*
|
|
2294
2471
|
*/
|
|
2295
2472
|
globus_auth_scope?: string;
|
|
2296
|
-
/** @description A list of scopes according to RunAs values as defined in the Flow.
|
|
2297
|
-
* */
|
|
2473
|
+
/** @description A list of scopes according to RunAs values as defined in the Flow. */
|
|
2298
2474
|
globus_auth_scopes_by_RunAs?: string[];
|
|
2299
2475
|
/**
|
|
2476
|
+
* @deprecated
|
|
2300
2477
|
* @description The role the requesting user has on the Flow.
|
|
2301
|
-
*
|
|
2302
2478
|
* @enum {string}
|
|
2303
2479
|
*/
|
|
2304
|
-
user_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner";
|
|
2480
|
+
user_role?: "flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner" | "run_monitor" | "run_manager";
|
|
2481
|
+
/** @description The list of all roles the requesting user has on the Flow. */
|
|
2482
|
+
user_roles?: ("flow_viewer" | "flow_starter" | "flow_administrator" | "flow_owner" | "flow_run_monitor" | "flow_run_manager")[];
|
|
2305
2483
|
/**
|
|
2306
2484
|
* @description A set of Principal URN values, or the value "public"
|
|
2307
2485
|
* indicating the identity of users who can view the Flow
|
|
2308
2486
|
* definition. Only calling users with the "administrator"
|
|
2309
2487
|
* role will be provided this list. Otherwise, the value
|
|
2310
2488
|
* will always be an empty list.
|
|
2311
|
-
*
|
|
2312
2489
|
* @example [
|
|
2313
2490
|
* "public",
|
|
2314
2491
|
* "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
|
|
@@ -2322,7 +2499,6 @@ export interface components {
|
|
|
2322
2499
|
* who can initiate a run of the Flow. Only calling users
|
|
2323
2500
|
* with the "administrator" role will be provided this
|
|
2324
2501
|
* list. Otherwise, the value will always be an empty list.
|
|
2325
|
-
*
|
|
2326
2502
|
* @example [
|
|
2327
2503
|
* "all_authenticated_users",
|
|
2328
2504
|
* "urn:globus:auth:identity:46bd0f56-e24f-11e5-a510-131bef46955c",
|
|
@@ -2330,47 +2506,49 @@ export interface components {
|
|
|
2330
2506
|
* ]
|
|
2331
2507
|
*/
|
|
2332
2508
|
flow_starters?: components["schemas"]["PrincipalURN"][];
|
|
2333
|
-
/**
|
|
2509
|
+
/**
|
|
2510
|
+
* @description The set of Principal URN values of users who may perform
|
|
2334
2511
|
* administrative operations, including updating the
|
|
2335
2512
|
* description itself. Only calling users with the
|
|
2336
2513
|
* "administrator" role will be provided this
|
|
2337
2514
|
* list. Otherwise, the value will always be an empty list.
|
|
2338
|
-
|
|
2515
|
+
*/
|
|
2339
2516
|
flow_administrators?: components["schemas"]["PrincipalURN"][];
|
|
2340
2517
|
flow_owner?: components["schemas"]["PrincipalURN"];
|
|
2341
2518
|
/**
|
|
2342
2519
|
* Format: date-time
|
|
2343
2520
|
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2344
2521
|
* which the Flow was created.
|
|
2345
|
-
*
|
|
2346
2522
|
*/
|
|
2347
2523
|
created_at?: string;
|
|
2348
2524
|
/**
|
|
2349
2525
|
* Format: date-time
|
|
2350
2526
|
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2351
2527
|
* which the Flow was last updated.
|
|
2352
|
-
*
|
|
2353
2528
|
*/
|
|
2354
2529
|
updated_at?: string;
|
|
2355
2530
|
synchronous?: boolean;
|
|
2356
|
-
/**
|
|
2531
|
+
/**
|
|
2532
|
+
* @description True if the Flow supports the /log operation providing detailed
|
|
2357
2533
|
* information on the intermediate states of a Flow invocation.
|
|
2358
|
-
|
|
2534
|
+
*/
|
|
2359
2535
|
log_supported?: boolean;
|
|
2360
2536
|
types?: ("Action" | "Event")[];
|
|
2361
2537
|
/** @enum {string} */
|
|
2362
2538
|
api_version?: "1.0";
|
|
2363
|
-
/**
|
|
2539
|
+
/**
|
|
2540
|
+
* @description A non-unique, human-friendly name used for displaying the Flow
|
|
2364
2541
|
* to end users.
|
|
2365
|
-
|
|
2542
|
+
*/
|
|
2366
2543
|
title?: string;
|
|
2367
2544
|
/** @description A concise summary of the Flow's purpose. */
|
|
2368
2545
|
subtitle?: string;
|
|
2369
2546
|
/** @description A detailed description of the Flow for end user display. */
|
|
2370
2547
|
description?: string;
|
|
2371
|
-
/**
|
|
2548
|
+
/**
|
|
2549
|
+
* @description A set of terms used to categorize the Flow which may be used in
|
|
2372
2550
|
* query and discovery operations.
|
|
2373
|
-
|
|
2551
|
+
*/
|
|
2374
2552
|
keywords?: string[];
|
|
2375
2553
|
principal_urn?: components["schemas"]["PrincipalURN"];
|
|
2376
2554
|
/** @description The Flow's Globus Auth username. */
|
|
@@ -2379,13 +2557,13 @@ export interface components {
|
|
|
2379
2557
|
* Format: uri
|
|
2380
2558
|
* @description The web-addressable location at which this Flow can be referenced
|
|
2381
2559
|
* and run from.
|
|
2382
|
-
*
|
|
2383
2560
|
*/
|
|
2384
2561
|
flow_url?: string;
|
|
2385
|
-
/**
|
|
2562
|
+
/**
|
|
2563
|
+
* @description Indicates whether this flow is High Assurance. High Assurance flows have
|
|
2386
2564
|
* sensitive fields (definition, input_schema) omitted from list responses
|
|
2387
2565
|
* for security purposes.
|
|
2388
|
-
|
|
2566
|
+
*/
|
|
2389
2567
|
is_high_assurance?: boolean;
|
|
2390
2568
|
/**
|
|
2391
2569
|
* Format: uuid
|
|
@@ -2393,7 +2571,6 @@ export interface components {
|
|
|
2393
2571
|
* subscription_id is present, the Flow may be
|
|
2394
2572
|
* accepted, but may have limits on how long or how
|
|
2395
2573
|
* much it can be used.
|
|
2396
|
-
*
|
|
2397
2574
|
*/
|
|
2398
2575
|
subscription_id?: string;
|
|
2399
2576
|
};
|
|
@@ -2401,8 +2578,7 @@ export interface components {
|
|
|
2401
2578
|
scopes?: components["schemas"]["FlowScopes"];
|
|
2402
2579
|
};
|
|
2403
2580
|
FlowValidationErrorResponse: {
|
|
2404
|
-
/** @description A unique identifier for the validation error, used for debugging.
|
|
2405
|
-
* */
|
|
2581
|
+
/** @description A unique identifier for the validation error, used for debugging. */
|
|
2406
2582
|
debug_id: string;
|
|
2407
2583
|
error: {
|
|
2408
2584
|
/** @description A readable keyword describing the failure. */
|
|
@@ -2424,6 +2600,32 @@ export interface components {
|
|
|
2424
2600
|
FlowScopes: {
|
|
2425
2601
|
[key: string]: string[];
|
|
2426
2602
|
};
|
|
2603
|
+
RegisteredApiSummary: {
|
|
2604
|
+
/**
|
|
2605
|
+
* Format: uuid
|
|
2606
|
+
* @description The unique identifier for the Registered API.
|
|
2607
|
+
*/
|
|
2608
|
+
id: string;
|
|
2609
|
+
/**
|
|
2610
|
+
* @description A non-unique, human-friendly name used for displaying the
|
|
2611
|
+
* Registered API to end users.
|
|
2612
|
+
*/
|
|
2613
|
+
name: string;
|
|
2614
|
+
/** @description A detailed description of the Registered API. */
|
|
2615
|
+
description: string;
|
|
2616
|
+
/**
|
|
2617
|
+
* Format: date-time
|
|
2618
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2619
|
+
* which the Registered API was created.
|
|
2620
|
+
*/
|
|
2621
|
+
created_timestamp: string;
|
|
2622
|
+
/**
|
|
2623
|
+
* Format: date-time
|
|
2624
|
+
* @description A timezone-aware ISO8601 format string that represents the time at
|
|
2625
|
+
* which the Registered API was last updated.
|
|
2626
|
+
*/
|
|
2627
|
+
updated_timestamp: string;
|
|
2628
|
+
};
|
|
2427
2629
|
BatchRunUpdateOperation: {
|
|
2428
2630
|
tags?: string[];
|
|
2429
2631
|
run_managers?: components["schemas"]["PrincipalURN"][];
|
|
@@ -2438,11 +2640,12 @@ export interface components {
|
|
|
2438
2640
|
};
|
|
2439
2641
|
};
|
|
2440
2642
|
responses: {
|
|
2441
|
-
/**
|
|
2643
|
+
/**
|
|
2644
|
+
* @description The requested operation was accepted.
|
|
2442
2645
|
*
|
|
2443
2646
|
* The operation may have been completed, or may be completed at a later time.
|
|
2444
2647
|
* A follow-up API request may be needed to confirm the status of the operation.
|
|
2445
|
-
|
|
2648
|
+
*/
|
|
2446
2649
|
HTTP202Response: {
|
|
2447
2650
|
headers: {
|
|
2448
2651
|
[name: string]: unknown;
|
|
@@ -2505,8 +2708,6 @@ export interface components {
|
|
|
2505
2708
|
*
|
|
2506
2709
|
* Note that runs which are still executing will not have a completion time
|
|
2507
2710
|
* and will be automatically excluded if this filter is applied.
|
|
2508
|
-
*
|
|
2509
|
-
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
2510
2711
|
*/
|
|
2511
2712
|
filter_completion_time: string;
|
|
2512
2713
|
/**
|
|
@@ -2523,8 +2724,6 @@ export interface components {
|
|
|
2523
2724
|
*
|
|
2524
2725
|
* Results will contain runs which began between the first datetime
|
|
2525
2726
|
* onwards, up to (but not including) the second datetime.
|
|
2526
|
-
*
|
|
2527
|
-
* @example 2021-03-09T21:52:14,2021-03-09T21:53
|
|
2528
2727
|
*/
|
|
2529
2728
|
filter_start_time: string;
|
|
2530
2729
|
/**
|
|
@@ -2564,11 +2763,6 @@ export interface components {
|
|
|
2564
2763
|
*
|
|
2565
2764
|
* - `ASC`
|
|
2566
2765
|
* - `DESC`
|
|
2567
|
-
*
|
|
2568
|
-
* @example [
|
|
2569
|
-
* "title ASC",
|
|
2570
|
-
* "id DESC"
|
|
2571
|
-
* ]
|
|
2572
2766
|
*/
|
|
2573
2767
|
list_flows_orderby: string[];
|
|
2574
2768
|
/**
|
|
@@ -2606,13 +2800,44 @@ export interface components {
|
|
|
2606
2800
|
*
|
|
2607
2801
|
* - `ASC`
|
|
2608
2802
|
* - `DESC`
|
|
2609
|
-
*
|
|
2610
|
-
* @example [
|
|
2611
|
-
* "start_time ASC",
|
|
2612
|
-
* "id DESC"
|
|
2613
|
-
* ]
|
|
2614
2803
|
*/
|
|
2615
2804
|
list_runs_orderby: string[];
|
|
2805
|
+
/**
|
|
2806
|
+
* @description Ordering criteria to apply to the list of Registered APIs.
|
|
2807
|
+
*
|
|
2808
|
+
* This field is a comma-separated list of sort criteria,
|
|
2809
|
+
* and follows this syntax:
|
|
2810
|
+
*
|
|
2811
|
+
* ```
|
|
2812
|
+
* CRITERION1[,CRITERION2[,...]]
|
|
2813
|
+
* ```
|
|
2814
|
+
*
|
|
2815
|
+
* and each individual `CRITERION` follows this syntax:
|
|
2816
|
+
*
|
|
2817
|
+
* ```
|
|
2818
|
+
* FIELD ORDERING
|
|
2819
|
+
* ```
|
|
2820
|
+
*
|
|
2821
|
+
* The first value, `FIELD`, indicates the field to sort by;
|
|
2822
|
+
* the second value, `ORDERING`, indicates the sorting order.
|
|
2823
|
+
*
|
|
2824
|
+
* When additional comma-separated criteria are added,
|
|
2825
|
+
* the first criterion will be used to sort the data;
|
|
2826
|
+
* subsequent criteria will be applied for ties.
|
|
2827
|
+
*
|
|
2828
|
+
* Supported fields are:
|
|
2829
|
+
*
|
|
2830
|
+
* - `id`
|
|
2831
|
+
* - `name`
|
|
2832
|
+
* - `created_timestamp`
|
|
2833
|
+
* - `updated_timestamp`
|
|
2834
|
+
*
|
|
2835
|
+
* Supported orderings are:
|
|
2836
|
+
*
|
|
2837
|
+
* - `ASC`
|
|
2838
|
+
* - `DESC`
|
|
2839
|
+
*/
|
|
2840
|
+
list_registered_apis_orderby: string[];
|
|
2616
2841
|
};
|
|
2617
2842
|
requestBodies: never;
|
|
2618
2843
|
headers: never;
|