@flyteorg/flyteidl 1.5.21 → 1.10.7
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/gen/pb-js/flyteidl.d.ts +6480 -4250
- package/gen/pb-js/flyteidl.js +15117 -9702
- package/package.json +1 -1
- package/protos/buf.lock +7 -0
- package/protos/buf.yaml +1 -0
- package/protos/docs/admin/admin.rst +4 -4
- package/protos/docs/datacatalog/datacatalog.rst +1 -1
- package/protos/docs/service/index.rst +1 -1
- package/protos/flyteidl/admin/agent.proto +95 -6
- package/protos/flyteidl/admin/cluster_assignment.proto +1 -1
- package/protos/flyteidl/admin/common.proto +9 -1
- package/protos/flyteidl/admin/description_entity.proto +1 -1
- package/protos/flyteidl/admin/event.proto +1 -1
- package/protos/flyteidl/admin/execution.proto +10 -1
- package/protos/flyteidl/admin/launch_plan.proto +12 -4
- package/protos/flyteidl/admin/matchable_resource.proto +9 -3
- package/protos/flyteidl/admin/node_execution.proto +13 -1
- package/protos/flyteidl/admin/notification.proto +1 -1
- package/protos/flyteidl/admin/project.proto +7 -1
- package/protos/flyteidl/admin/project_attributes.proto +10 -1
- package/protos/flyteidl/admin/project_domain_attributes.proto +11 -2
- package/protos/flyteidl/admin/schedule.proto +1 -1
- package/protos/flyteidl/admin/signal.proto +2 -2
- package/protos/flyteidl/admin/task.proto +1 -1
- package/protos/flyteidl/admin/task_execution.proto +1 -1
- package/protos/flyteidl/admin/version.proto +1 -1
- package/protos/flyteidl/admin/workflow.proto +2 -2
- package/protos/flyteidl/admin/workflow_attributes.proto +10 -1
- package/protos/flyteidl/core/artifact_id.proto +90 -0
- package/protos/flyteidl/core/catalog.proto +3 -1
- package/protos/flyteidl/core/compiler.proto +12 -1
- package/protos/flyteidl/core/condition.proto +1 -1
- package/protos/flyteidl/core/dynamic_job.proto +1 -1
- package/protos/flyteidl/core/errors.proto +1 -1
- package/protos/flyteidl/core/execution.proto +1 -1
- package/protos/flyteidl/core/identifier.proto +7 -1
- package/protos/flyteidl/core/interface.proto +14 -1
- package/protos/flyteidl/core/literals.proto +4 -1
- package/protos/flyteidl/core/metrics.proto +15 -1
- package/protos/flyteidl/core/security.proto +1 -1
- package/protos/flyteidl/core/tasks.proto +33 -1
- package/protos/flyteidl/core/types.proto +7 -1
- package/protos/flyteidl/core/workflow.proto +28 -1
- package/protos/flyteidl/core/workflow_closure.proto +1 -1
- package/protos/flyteidl/datacatalog/datacatalog.proto +10 -2
- package/protos/flyteidl/event/cloudevents.proto +73 -0
- package/protos/flyteidl/event/event.proto +5 -1
- package/protos/flyteidl/plugins/array_job.proto +1 -1
- package/protos/flyteidl/plugins/dask.proto +1 -1
- package/protos/flyteidl/plugins/kubeflow/common.proto +1 -1
- package/protos/flyteidl/plugins/kubeflow/mpi.proto +1 -1
- package/protos/flyteidl/plugins/kubeflow/pytorch.proto +1 -1
- package/protos/flyteidl/plugins/kubeflow/tensorflow.proto +4 -1
- package/protos/flyteidl/plugins/mpi.proto +1 -1
- package/protos/flyteidl/plugins/presto.proto +1 -1
- package/protos/flyteidl/plugins/pytorch.proto +1 -1
- package/protos/flyteidl/plugins/qubole.proto +1 -1
- package/protos/flyteidl/plugins/ray.proto +7 -1
- package/protos/flyteidl/plugins/spark.proto +1 -1
- package/protos/flyteidl/plugins/tensorflow.proto +6 -2
- package/protos/flyteidl/plugins/waitable.proto +1 -1
- package/protos/flyteidl/service/admin.proto +398 -197
- package/protos/flyteidl/service/agent.proto +32 -2
- package/protos/flyteidl/service/auth.proto +8 -8
- package/protos/flyteidl/service/dataproxy.proto +12 -12
- package/protos/flyteidl/service/external_plugin_service.proto +1 -2
- package/protos/flyteidl/service/identity.proto +5 -5
- package/protos/flyteidl/service/signal.proto +30 -23
- package/protos/flyteidl/plugins/sagemaker/hyperparameter_tuning_job.proto +0 -83
- package/protos/flyteidl/plugins/sagemaker/parameter_ranges.proto +0 -61
- package/protos/flyteidl/plugins/sagemaker/training_job.proto +0 -119
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
syntax = "proto3";
|
|
2
2
|
package flyteidl.service;
|
|
3
3
|
|
|
4
|
-
option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/service";
|
|
4
|
+
option go_package = "github.com/flyteorg/flyte/flyteidl/gen/pb-go/flyteidl/service";
|
|
5
5
|
|
|
6
6
|
import "google/api/annotations.proto";
|
|
7
7
|
import "flyteidl/admin/project.proto";
|
|
@@ -19,7 +19,8 @@ import "flyteidl/admin/task_execution.proto";
|
|
|
19
19
|
import "flyteidl/admin/version.proto";
|
|
20
20
|
import "flyteidl/admin/common.proto";
|
|
21
21
|
import "flyteidl/admin/description_entity.proto";
|
|
22
|
-
|
|
22
|
+
import "protoc-gen-openapiv2/options/annotations.proto";
|
|
23
|
+
|
|
23
24
|
|
|
24
25
|
// The following defines an RPC service that is also served over HTTP via grpc-gateway.
|
|
25
26
|
// Standard response codes for both are defined here: https://github.com/grpc-ecosystem/grpc-gateway/blob/master/runtime/errors.go
|
|
@@ -29,42 +30,52 @@ service AdminService {
|
|
|
29
30
|
option (google.api.http) = {
|
|
30
31
|
post: "/api/v1/tasks"
|
|
31
32
|
body: "*"
|
|
33
|
+
additional_bindings {
|
|
34
|
+
post: "/api/v1/tasks/org/{id.org}"
|
|
35
|
+
body: "*"
|
|
36
|
+
}
|
|
32
37
|
};
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
38
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
39
|
+
description: "Create and register a task definition."
|
|
40
|
+
responses: {
|
|
41
|
+
key: "400"
|
|
42
|
+
value: {
|
|
43
|
+
description: "Returned for bad request that may have failed validation."
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
responses: {
|
|
47
|
+
key: "409"
|
|
48
|
+
value: {
|
|
49
|
+
description: "Returned for a request that references an identical entity that has already been registered."
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
};
|
|
48
53
|
}
|
|
49
54
|
|
|
50
55
|
// Fetch a :ref:`ref_flyteidl.admin.Task` definition.
|
|
51
56
|
rpc GetTask (flyteidl.admin.ObjectGetRequest) returns (flyteidl.admin.Task) {
|
|
52
57
|
option (google.api.http) = {
|
|
53
58
|
get: "/api/v1/tasks/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
59
|
+
additional_bindings {
|
|
60
|
+
get: "/api/v1/tasks/org/{id.org}/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
61
|
+
}
|
|
62
|
+
};
|
|
63
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
64
|
+
description: "Retrieve an existing task definition."
|
|
54
65
|
};
|
|
55
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
56
|
-
// description: "Retrieve an existing task definition."
|
|
57
|
-
// };
|
|
58
66
|
}
|
|
59
67
|
|
|
60
|
-
// Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of task objects.
|
|
68
|
+
// Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of task objects.
|
|
61
69
|
rpc ListTaskIds (flyteidl.admin.NamedEntityIdentifierListRequest) returns (flyteidl.admin.NamedEntityIdentifierList) {
|
|
62
70
|
option (google.api.http) = {
|
|
63
71
|
get: "/api/v1/task_ids/{project}/{domain}"
|
|
72
|
+
additional_bindings {
|
|
73
|
+
get: "/api/v1/tasks/org/{org}/{project}/{domain}"
|
|
74
|
+
}
|
|
75
|
+
};
|
|
76
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
77
|
+
description: "Fetch existing task definition identifiers matching input filters."
|
|
64
78
|
};
|
|
65
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
66
|
-
// description: "Fetch existing task definition identifiers matching input filters."
|
|
67
|
-
// };
|
|
68
79
|
}
|
|
69
80
|
|
|
70
81
|
// Fetch a list of :ref:`ref_flyteidl.admin.Task` definitions.
|
|
@@ -72,12 +83,18 @@ service AdminService {
|
|
|
72
83
|
option (google.api.http) = {
|
|
73
84
|
get: "/api/v1/tasks/{id.project}/{id.domain}/{id.name}"
|
|
74
85
|
additional_bindings {
|
|
75
|
-
get: "/api/v1/tasks/{id.project}/{id.domain}"
|
|
86
|
+
get: "/api/v1/tasks/org/{id.org}/{id.project}/{id.domain}/{id.name}",
|
|
87
|
+
}
|
|
88
|
+
additional_bindings {
|
|
89
|
+
get: "/api/v1/tasks/{id.project}/{id.domain}",
|
|
90
|
+
}
|
|
91
|
+
additional_bindings {
|
|
92
|
+
get: "/api/v1/tasks/org/{id.org}/{id.project}/{id.domain}",
|
|
76
93
|
}
|
|
77
94
|
};
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
95
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
96
|
+
description: "Fetch existing task definitions matching input filters."
|
|
97
|
+
};
|
|
81
98
|
}
|
|
82
99
|
|
|
83
100
|
// Create and upload a :ref:`ref_flyteidl.admin.Workflow` definition
|
|
@@ -85,40 +102,50 @@ service AdminService {
|
|
|
85
102
|
option (google.api.http) = {
|
|
86
103
|
post: "/api/v1/workflows"
|
|
87
104
|
body: "*"
|
|
105
|
+
additional_bindings {
|
|
106
|
+
post: "/api/v1/workflows/org/{id.org}"
|
|
107
|
+
body: "*"
|
|
108
|
+
}
|
|
109
|
+
};
|
|
110
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
111
|
+
description: "Create and register a workflow definition."
|
|
112
|
+
responses: {
|
|
113
|
+
key: "400"
|
|
114
|
+
value: {
|
|
115
|
+
description: "Returned for bad request that may have failed validation."
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
responses: {
|
|
119
|
+
key: "409"
|
|
120
|
+
value: {
|
|
121
|
+
description: "Returned for a request that references an identical entity that has already been registered."
|
|
122
|
+
}
|
|
123
|
+
}
|
|
88
124
|
};
|
|
89
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
90
|
-
// description: "Create and register a workflow definition."
|
|
91
|
-
// responses: {
|
|
92
|
-
// key: "400"
|
|
93
|
-
// value: {
|
|
94
|
-
// description: "Returned for bad request that may have failed validation."
|
|
95
|
-
// }
|
|
96
|
-
// }
|
|
97
|
-
// responses: {
|
|
98
|
-
// key: "409"
|
|
99
|
-
// value: {
|
|
100
|
-
// description: "Returned for a request that references an identical entity that has already been registered."
|
|
101
|
-
// }
|
|
102
|
-
// }
|
|
103
|
-
// };
|
|
104
125
|
}
|
|
105
126
|
|
|
106
127
|
// Fetch a :ref:`ref_flyteidl.admin.Workflow` definition.
|
|
107
128
|
rpc GetWorkflow (flyteidl.admin.ObjectGetRequest) returns (flyteidl.admin.Workflow) {
|
|
108
129
|
option (google.api.http) = {
|
|
109
130
|
get: "/api/v1/workflows/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
131
|
+
additional_bindings {
|
|
132
|
+
get: "/api/v1/workflows/org/{id.org}/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
133
|
+
}
|
|
134
|
+
};
|
|
135
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
136
|
+
description: "Retrieve an existing workflow definition."
|
|
110
137
|
};
|
|
111
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
112
|
-
// description: "Retrieve an existing workflow definition."
|
|
113
|
-
// };
|
|
114
138
|
}
|
|
115
139
|
|
|
116
140
|
// Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of workflow objects.
|
|
117
141
|
rpc ListWorkflowIds (flyteidl.admin.NamedEntityIdentifierListRequest) returns (flyteidl.admin.NamedEntityIdentifierList) {
|
|
118
142
|
option (google.api.http) = {
|
|
119
143
|
get: "/api/v1/workflow_ids/{project}/{domain}"
|
|
144
|
+
additional_bindings {
|
|
145
|
+
get: "/api/v1/workflows/org/{org}/{project}/{domain}"
|
|
146
|
+
}
|
|
120
147
|
};
|
|
121
|
-
// option (grpc.gateway.
|
|
148
|
+
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
122
149
|
// description: "Fetch an existing workflow definition identifiers matching input filters."
|
|
123
150
|
// };
|
|
124
151
|
}
|
|
@@ -128,12 +155,18 @@ service AdminService {
|
|
|
128
155
|
option (google.api.http) = {
|
|
129
156
|
get: "/api/v1/workflows/{id.project}/{id.domain}/{id.name}"
|
|
130
157
|
additional_bindings {
|
|
131
|
-
get: "/api/v1/workflows/{id.project}/{id.domain}"
|
|
158
|
+
get: "/api/v1/workflows/org/{id.org}/{id.project}/{id.domain}/{id.name}",
|
|
159
|
+
}
|
|
160
|
+
additional_bindings {
|
|
161
|
+
get: "/api/v1/workflows/{id.project}/{id.domain}",
|
|
162
|
+
}
|
|
163
|
+
additional_bindings {
|
|
164
|
+
get: "/api/v1/workflows/org/{id.org}/{id.project}/{id.domain}",
|
|
132
165
|
}
|
|
133
166
|
};
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
167
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
168
|
+
description: "Fetch existing workflow definitions matching input filters."
|
|
169
|
+
};
|
|
137
170
|
}
|
|
138
171
|
|
|
139
172
|
// Create and upload a :ref:`ref_flyteidl.admin.LaunchPlan` definition
|
|
@@ -141,91 +174,116 @@ service AdminService {
|
|
|
141
174
|
option (google.api.http) = {
|
|
142
175
|
post: "/api/v1/launch_plans"
|
|
143
176
|
body: "*"
|
|
177
|
+
additional_bindings {
|
|
178
|
+
post: "/api/v1/launch_plans/org/{id.org}"
|
|
179
|
+
body: "*"
|
|
180
|
+
}
|
|
181
|
+
};
|
|
182
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
183
|
+
description: "Create and register a launch plan definition."
|
|
184
|
+
responses: {
|
|
185
|
+
key: "400"
|
|
186
|
+
value: {
|
|
187
|
+
description: "Returned for bad request that may have failed validation."
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
responses: {
|
|
191
|
+
key: "409"
|
|
192
|
+
value: {
|
|
193
|
+
description: "Returned for a request that references an identical entity that has already been registered."
|
|
194
|
+
}
|
|
195
|
+
}
|
|
144
196
|
};
|
|
145
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
146
|
-
// description: "Create and register a launch plan definition."
|
|
147
|
-
// responses: {
|
|
148
|
-
// key: "400"
|
|
149
|
-
// value: {
|
|
150
|
-
// description: "Returned for bad request that may have failed validation."
|
|
151
|
-
// }
|
|
152
|
-
// }
|
|
153
|
-
// responses: {
|
|
154
|
-
// key: "409"
|
|
155
|
-
// value: {
|
|
156
|
-
// description: "Returned for a request that references an identical entity that has already been registered."
|
|
157
|
-
// }
|
|
158
|
-
// }
|
|
159
|
-
// };
|
|
160
197
|
}
|
|
161
198
|
|
|
162
199
|
// Fetch a :ref:`ref_flyteidl.admin.LaunchPlan` definition.
|
|
163
200
|
rpc GetLaunchPlan (flyteidl.admin.ObjectGetRequest) returns (flyteidl.admin.LaunchPlan) {
|
|
164
201
|
option (google.api.http) = {
|
|
165
202
|
get: "/api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
203
|
+
additional_bindings {
|
|
204
|
+
get: "/api/v1/launch_plans/org/{id.org}/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
205
|
+
}
|
|
206
|
+
};
|
|
207
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
208
|
+
description: "Retrieve an existing launch plan definition."
|
|
166
209
|
};
|
|
167
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
168
|
-
// description: "Retrieve an existing launch plan definition."
|
|
169
|
-
// };
|
|
170
210
|
}
|
|
171
211
|
|
|
172
212
|
// Fetch the active version of a :ref:`ref_flyteidl.admin.LaunchPlan`.
|
|
173
213
|
rpc GetActiveLaunchPlan (flyteidl.admin.ActiveLaunchPlanRequest) returns (flyteidl.admin.LaunchPlan) {
|
|
174
214
|
option (google.api.http) = {
|
|
175
215
|
get: "/api/v1/active_launch_plans/{id.project}/{id.domain}/{id.name}"
|
|
216
|
+
additional_bindings {
|
|
217
|
+
get: "/api/v1/active_launch_plans/org/{id.org}/{id.project}/{id.domain}/{id.name}"
|
|
218
|
+
}
|
|
219
|
+
};
|
|
220
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
221
|
+
description: "Retrieve the active launch plan version specified by input request filters."
|
|
176
222
|
};
|
|
177
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
178
|
-
// description: "Retrieve the active launch plan version specified by input request filters."
|
|
179
|
-
// };
|
|
180
223
|
}
|
|
181
224
|
|
|
182
225
|
// List active versions of :ref:`ref_flyteidl.admin.LaunchPlan`.
|
|
183
226
|
rpc ListActiveLaunchPlans (flyteidl.admin.ActiveLaunchPlanListRequest) returns (flyteidl.admin.LaunchPlanList) {
|
|
184
227
|
option (google.api.http) = {
|
|
185
228
|
get: "/api/v1/active_launch_plans/{project}/{domain}"
|
|
229
|
+
additional_bindings {
|
|
230
|
+
get: "/api/v1/active_launch_plans/org/{org}/{project}/{domain}"
|
|
231
|
+
}
|
|
232
|
+
};
|
|
233
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
234
|
+
description: "Fetch the active launch plan versions specified by input request filters."
|
|
186
235
|
};
|
|
187
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
188
|
-
// description: "Fetch the active launch plan versions specified by input request filters."
|
|
189
|
-
// };
|
|
190
236
|
}
|
|
191
237
|
|
|
192
238
|
// Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of launch plan objects.
|
|
193
239
|
rpc ListLaunchPlanIds (flyteidl.admin.NamedEntityIdentifierListRequest) returns (flyteidl.admin.NamedEntityIdentifierList) {
|
|
194
240
|
option (google.api.http) = {
|
|
195
241
|
get: "/api/v1/launch_plan_ids/{project}/{domain}"
|
|
242
|
+
additional_bindings {
|
|
243
|
+
get: "/api/v1/launch_plan_ids/org/{org}/{project}/{domain}"
|
|
244
|
+
}
|
|
245
|
+
};
|
|
246
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
247
|
+
description: "Fetch existing launch plan definition identifiers matching input filters."
|
|
196
248
|
};
|
|
197
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
198
|
-
// description: "Fetch existing launch plan definition identifiers matching input filters."
|
|
199
|
-
// };
|
|
200
249
|
}
|
|
201
250
|
|
|
202
251
|
// Fetch a list of :ref:`ref_flyteidl.admin.LaunchPlan` definitions.
|
|
203
252
|
rpc ListLaunchPlans (flyteidl.admin.ResourceListRequest) returns (flyteidl.admin.LaunchPlanList) {
|
|
204
253
|
option (google.api.http) = {
|
|
205
254
|
get: "/api/v1/launch_plans/{id.project}/{id.domain}/{id.name}"
|
|
255
|
+
additional_bindings {
|
|
256
|
+
get: "/api/v1/launch_plans/org/{id.org}/{id.project}/{id.domain}/{id.name}"
|
|
257
|
+
}
|
|
206
258
|
additional_bindings {
|
|
207
259
|
get: "/api/v1/launch_plans/{id.project}/{id.domain}"
|
|
208
260
|
}
|
|
261
|
+
additional_bindings {
|
|
262
|
+
get: "/api/v1/launch_plans/org/{id.org}/{id.project}/{id.domain}"
|
|
263
|
+
}
|
|
264
|
+
};
|
|
265
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
266
|
+
description: "Fetch existing launch plan definitions matching input filters."
|
|
209
267
|
};
|
|
210
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
211
|
-
// description: "Fetch existing launch plan definitions matching input filters."
|
|
212
|
-
// };
|
|
213
268
|
}
|
|
214
269
|
|
|
215
270
|
// Updates the status of a registered :ref:`ref_flyteidl.admin.LaunchPlan`.
|
|
216
271
|
rpc UpdateLaunchPlan (flyteidl.admin.LaunchPlanUpdateRequest) returns (flyteidl.admin.LaunchPlanUpdateResponse) {
|
|
217
272
|
option (google.api.http) = {
|
|
218
273
|
put: "/api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
274
|
+
additional_bindings {
|
|
275
|
+
put: "/api/v1/launch_plans/org/{id.org}/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
276
|
+
}
|
|
219
277
|
body: "*"
|
|
220
278
|
};
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
279
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
280
|
+
description: "Update the status of an existing launch plan definition. "
|
|
281
|
+
"At most one launch plan version for a given {project, domain, name} can be active at a time. "
|
|
282
|
+
"If this call sets a launch plan to active and existing version is already active, the result of this call will be that the "
|
|
283
|
+
"formerly active launch plan will be made inactive and specified launch plan in this request will be made active. "
|
|
284
|
+
"In the event that the formerly active launch plan had a schedule associated it with it, this schedule will be disabled. "
|
|
285
|
+
"If the reference launch plan in this request is being set to active and has a schedule associated with it, the schedule will be enabled."
|
|
286
|
+
};
|
|
229
287
|
}
|
|
230
288
|
|
|
231
289
|
// Triggers the creation of a :ref:`ref_flyteidl.admin.Execution`
|
|
@@ -233,10 +291,14 @@ service AdminService {
|
|
|
233
291
|
option (google.api.http) = {
|
|
234
292
|
post: "/api/v1/executions"
|
|
235
293
|
body: "*"
|
|
294
|
+
additional_bindings {
|
|
295
|
+
put: "/api/v1/executions/org/{org}"
|
|
296
|
+
body: "*"
|
|
297
|
+
}
|
|
298
|
+
};
|
|
299
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
300
|
+
description: "Create a workflow execution."
|
|
236
301
|
};
|
|
237
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
238
|
-
// description: "Create a workflow execution."
|
|
239
|
-
// };
|
|
240
302
|
}
|
|
241
303
|
|
|
242
304
|
// Triggers the creation of an identical :ref:`ref_flyteidl.admin.Execution`
|
|
@@ -244,10 +306,14 @@ service AdminService {
|
|
|
244
306
|
option (google.api.http) = {
|
|
245
307
|
post: "/api/v1/executions/relaunch"
|
|
246
308
|
body: "*"
|
|
309
|
+
additional_bindings {
|
|
310
|
+
post: "/api/v1/executions/org/{id.org}/relaunch"
|
|
311
|
+
body: "*"
|
|
312
|
+
}
|
|
313
|
+
};
|
|
314
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
315
|
+
description: "Relaunch a workflow execution."
|
|
247
316
|
};
|
|
248
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
249
|
-
// description: "Relaunch a workflow execution."
|
|
250
|
-
// };
|
|
251
317
|
}
|
|
252
318
|
|
|
253
319
|
// Recreates a previously-run workflow execution that will only start executing from the last known failure point.
|
|
@@ -259,24 +325,30 @@ service AdminService {
|
|
|
259
325
|
option (google.api.http) = {
|
|
260
326
|
post: "/api/v1/executions/recover"
|
|
261
327
|
body: "*"
|
|
328
|
+
additional_bindings {
|
|
329
|
+
post: "/api/v1/executions/org/{id.org}/recover"
|
|
330
|
+
body: "*"
|
|
331
|
+
}
|
|
332
|
+
};
|
|
333
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
334
|
+
description: "Recreates a previously-run workflow execution that will only start executing from the last known failure point. "
|
|
335
|
+
"In Recover mode, users cannot change any input parameters or update the version of the execution. "
|
|
336
|
+
"This is extremely useful to recover from system errors and byzantine faults like - Loss of K8s cluster, bugs in platform or instability, machine failures, "
|
|
337
|
+
"downstream system failures (downstream services), or simply to recover executions that failed because of retry exhaustion and should complete if tried again."
|
|
262
338
|
};
|
|
263
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
264
|
-
// description: "Recreates a previously-run workflow execution that will only start executing from the last known failure point. "
|
|
265
|
-
// "In Recover mode, users cannot change any input parameters or update the version of the execution. "
|
|
266
|
-
// "This is extremely useful to recover from system errors and byzantine faults like - Loss of K8s cluster, bugs in platform or instability, machine failures, "
|
|
267
|
-
// "downstream system failures (downstream services), or simply to recover executions that failed because of retry exhaustion and should complete if tried again."
|
|
268
|
-
|
|
269
|
-
// };
|
|
270
339
|
}
|
|
271
340
|
|
|
272
341
|
// Fetches a :ref:`ref_flyteidl.admin.Execution`.
|
|
273
342
|
rpc GetExecution (flyteidl.admin.WorkflowExecutionGetRequest) returns (flyteidl.admin.Execution) {
|
|
274
343
|
option (google.api.http) = {
|
|
275
344
|
get: "/api/v1/executions/{id.project}/{id.domain}/{id.name}"
|
|
345
|
+
additional_bindings {
|
|
346
|
+
get: "/api/v1/executions/org/{id.org}/{id.project}/{id.domain}/{id.name}"
|
|
347
|
+
}
|
|
348
|
+
};
|
|
349
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
350
|
+
description: "Retrieve an existing workflow execution."
|
|
276
351
|
};
|
|
277
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
278
|
-
// description: "Retrieve an existing workflow execution."
|
|
279
|
-
// };
|
|
280
352
|
}
|
|
281
353
|
|
|
282
354
|
// Update execution belonging to project domain :ref:`ref_flyteidl.admin.Execution`.
|
|
@@ -284,8 +356,12 @@ service AdminService {
|
|
|
284
356
|
option (google.api.http) = {
|
|
285
357
|
put: "/api/v1/executions/{id.project}/{id.domain}/{id.name}"
|
|
286
358
|
body: "*"
|
|
359
|
+
additional_bindings {
|
|
360
|
+
put: "/api/v1/executions/org/{id.org}/{id.project}/{id.domain}/{id.name}"
|
|
361
|
+
body: "*"
|
|
362
|
+
}
|
|
287
363
|
};
|
|
288
|
-
// option (grpc.gateway.
|
|
364
|
+
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
289
365
|
// description: "Update execution belonging to project domain."
|
|
290
366
|
// };
|
|
291
367
|
}
|
|
@@ -294,8 +370,11 @@ service AdminService {
|
|
|
294
370
|
rpc GetExecutionData (flyteidl.admin.WorkflowExecutionGetDataRequest) returns (flyteidl.admin.WorkflowExecutionGetDataResponse) {
|
|
295
371
|
option (google.api.http) = {
|
|
296
372
|
get: "/api/v1/data/executions/{id.project}/{id.domain}/{id.name}"
|
|
373
|
+
additional_bindings {
|
|
374
|
+
get: "/api/v1/data/org/{id.org}/executions/{id.project}/{id.domain}/{id.name}"
|
|
375
|
+
}
|
|
297
376
|
};
|
|
298
|
-
// option (grpc.gateway.
|
|
377
|
+
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
299
378
|
// description: "Retrieve input and output data from an existing workflow execution."
|
|
300
379
|
// };
|
|
301
380
|
};
|
|
@@ -304,8 +383,11 @@ service AdminService {
|
|
|
304
383
|
rpc ListExecutions (flyteidl.admin.ResourceListRequest) returns (flyteidl.admin.ExecutionList) {
|
|
305
384
|
option (google.api.http) = {
|
|
306
385
|
get: "/api/v1/executions/{id.project}/{id.domain}"
|
|
386
|
+
additional_bindings {
|
|
387
|
+
get: "/api/v1/executions/org/{id.org}/{id.project}/{id.domain}"
|
|
388
|
+
}
|
|
307
389
|
};
|
|
308
|
-
// option (grpc.gateway.
|
|
390
|
+
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
309
391
|
// description: "Fetch existing workflow executions matching input filters."
|
|
310
392
|
// };
|
|
311
393
|
}
|
|
@@ -315,8 +397,12 @@ service AdminService {
|
|
|
315
397
|
option (google.api.http) = {
|
|
316
398
|
delete: "/api/v1/executions/{id.project}/{id.domain}/{id.name}"
|
|
317
399
|
body: "*"
|
|
400
|
+
additional_bindings {
|
|
401
|
+
delete: "/api/v1/executions/org/{id.org}/{id.project}/{id.domain}/{id.name}"
|
|
402
|
+
body: "*"
|
|
403
|
+
}
|
|
318
404
|
};
|
|
319
|
-
// option (grpc.gateway.
|
|
405
|
+
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
320
406
|
// description: "Terminate the active workflow execution specified in the request."
|
|
321
407
|
// };
|
|
322
408
|
}
|
|
@@ -325,18 +411,37 @@ service AdminService {
|
|
|
325
411
|
rpc GetNodeExecution (flyteidl.admin.NodeExecutionGetRequest) returns (flyteidl.admin.NodeExecution) {
|
|
326
412
|
option (google.api.http) = {
|
|
327
413
|
get: "/api/v1/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}"
|
|
414
|
+
additional_bindings {
|
|
415
|
+
get: "/api/v1/node_executions/org/{id.execution_id.org}/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}"
|
|
416
|
+
}
|
|
328
417
|
};
|
|
329
|
-
// option (grpc.gateway.
|
|
418
|
+
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
330
419
|
// description: "Retrieve an existing node execution."
|
|
331
420
|
// };
|
|
332
421
|
}
|
|
333
422
|
|
|
423
|
+
// Fetches a :ref:`ref_flyteidl.admin.DynamicNodeWorkflowResponse`.
|
|
424
|
+
rpc GetDynamicNodeWorkflow (flyteidl.admin.GetDynamicNodeWorkflowRequest) returns (flyteidl.admin.DynamicNodeWorkflowResponse) {
|
|
425
|
+
option (google.api.http) = {
|
|
426
|
+
get: "/api/v1/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}/dynamic_workflow"
|
|
427
|
+
additional_bindings {
|
|
428
|
+
get: "/api/v1/node_executions/org/{id.execution_id.org}/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}/dynamic_workflow"
|
|
429
|
+
}
|
|
430
|
+
};
|
|
431
|
+
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
432
|
+
// description: "Retrieve a workflow closure from a dynamic node execution."
|
|
433
|
+
// };
|
|
434
|
+
}
|
|
435
|
+
|
|
334
436
|
// Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution`.
|
|
335
437
|
rpc ListNodeExecutions (flyteidl.admin.NodeExecutionListRequest) returns (flyteidl.admin.NodeExecutionList) {
|
|
336
438
|
option (google.api.http) = {
|
|
337
439
|
get: "/api/v1/node_executions/{workflow_execution_id.project}/{workflow_execution_id.domain}/{workflow_execution_id.name}"
|
|
440
|
+
additional_bindings {
|
|
441
|
+
get: "/api/v1/node_executions/org/{workflow_execution_id.org}/{workflow_execution_id.project}/{workflow_execution_id.domain}/{workflow_execution_id.name}"
|
|
442
|
+
}
|
|
338
443
|
};
|
|
339
|
-
// option (grpc.gateway.
|
|
444
|
+
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
340
445
|
// description: "Fetch existing node executions matching input filters."
|
|
341
446
|
// };
|
|
342
447
|
}
|
|
@@ -345,8 +450,11 @@ service AdminService {
|
|
|
345
450
|
rpc ListNodeExecutionsForTask (flyteidl.admin.NodeExecutionForTaskListRequest) returns (flyteidl.admin.NodeExecutionList) {
|
|
346
451
|
option (google.api.http) = {
|
|
347
452
|
get: "/api/v1/children/task_executions/{task_execution_id.node_execution_id.execution_id.project}/{task_execution_id.node_execution_id.execution_id.domain}/{task_execution_id.node_execution_id.execution_id.name}/{task_execution_id.node_execution_id.node_id}/{task_execution_id.task_id.project}/{task_execution_id.task_id.domain}/{task_execution_id.task_id.name}/{task_execution_id.task_id.version}/{task_execution_id.retry_attempt}"
|
|
453
|
+
additional_bindings {
|
|
454
|
+
get: "/api/v1/children/org/{task_execution_id.node_execution_id.execution_id.org}/task_executions/{task_execution_id.node_execution_id.execution_id.project}/{task_execution_id.node_execution_id.execution_id.domain}/{task_execution_id.node_execution_id.execution_id.name}/{task_execution_id.node_execution_id.node_id}/{task_execution_id.task_id.project}/{task_execution_id.task_id.domain}/{task_execution_id.task_id.name}/{task_execution_id.task_id.version}/{task_execution_id.retry_attempt}"
|
|
455
|
+
}
|
|
348
456
|
};
|
|
349
|
-
// option (grpc.gateway.
|
|
457
|
+
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
350
458
|
// description: "Fetch child node executions launched by the specified task execution."
|
|
351
459
|
// };
|
|
352
460
|
}
|
|
@@ -355,8 +463,11 @@ service AdminService {
|
|
|
355
463
|
rpc GetNodeExecutionData (flyteidl.admin.NodeExecutionGetDataRequest) returns (flyteidl.admin.NodeExecutionGetDataResponse) {
|
|
356
464
|
option (google.api.http) = {
|
|
357
465
|
get: "/api/v1/data/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}"
|
|
466
|
+
additional_bindings {
|
|
467
|
+
get: "/api/v1/data/org/{id.execution_id.org}/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}"
|
|
468
|
+
}
|
|
358
469
|
};
|
|
359
|
-
// option (grpc.gateway.
|
|
470
|
+
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
360
471
|
// description: "Retrieve input and output data from an existing node execution."
|
|
361
472
|
// };
|
|
362
473
|
};
|
|
@@ -366,33 +477,44 @@ service AdminService {
|
|
|
366
477
|
option (google.api.http) = {
|
|
367
478
|
post: "/api/v1/projects"
|
|
368
479
|
body: "*"
|
|
480
|
+
additional_bindings {
|
|
481
|
+
post: "/api/v1/projects/org/{project.org}"
|
|
482
|
+
body: "*"
|
|
483
|
+
}
|
|
369
484
|
};
|
|
370
|
-
// option (grpc.gateway.
|
|
485
|
+
// option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
371
486
|
// description: "Register a project."
|
|
372
487
|
// };
|
|
373
488
|
}
|
|
374
489
|
|
|
375
|
-
// Updates an existing :ref:`ref_flyteidl.admin.Project`
|
|
490
|
+
// Updates an existing :ref:`ref_flyteidl.admin.Project`
|
|
376
491
|
// flyteidl.admin.Project should be passed but the domains property should be empty;
|
|
377
492
|
// it will be ignored in the handler as domains cannot be updated via this API.
|
|
378
493
|
rpc UpdateProject (flyteidl.admin.Project) returns (flyteidl.admin.ProjectUpdateResponse) {
|
|
379
494
|
option (google.api.http) = {
|
|
380
495
|
put: "/api/v1/projects/{id}"
|
|
381
496
|
body: "*"
|
|
497
|
+
additional_bindings {
|
|
498
|
+
put: "/api/v1/projects/org/{org}/{id}"
|
|
499
|
+
body: "*"
|
|
500
|
+
}
|
|
501
|
+
};
|
|
502
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
503
|
+
description: "Update a project."
|
|
382
504
|
};
|
|
383
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
384
|
-
// description: "Update a project."
|
|
385
|
-
// };
|
|
386
505
|
}
|
|
387
506
|
|
|
388
|
-
// Fetches a list of :ref:`ref_flyteidl.admin.Project`
|
|
507
|
+
// Fetches a list of :ref:`ref_flyteidl.admin.Project`
|
|
389
508
|
rpc ListProjects (flyteidl.admin.ProjectListRequest) returns (flyteidl.admin.Projects) {
|
|
390
509
|
option (google.api.http) = {
|
|
391
510
|
get: "/api/v1/projects"
|
|
511
|
+
additional_bindings {
|
|
512
|
+
get: "/api/v1/projects/org/{org}"
|
|
513
|
+
}
|
|
514
|
+
};
|
|
515
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
516
|
+
description: "Fetch registered projects."
|
|
392
517
|
};
|
|
393
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
394
|
-
// description: "Fetch registered projects."
|
|
395
|
-
// };
|
|
396
518
|
}
|
|
397
519
|
|
|
398
520
|
// Indicates a :ref:`ref_flyteidl.event.WorkflowExecutionEvent` has occurred.
|
|
@@ -400,10 +522,14 @@ service AdminService {
|
|
|
400
522
|
option (google.api.http) = {
|
|
401
523
|
post: "/api/v1/events/workflows"
|
|
402
524
|
body: "*"
|
|
525
|
+
additional_bindings {
|
|
526
|
+
post: "/api/v1/events/org/{event.execution_id.org}/workflows"
|
|
527
|
+
body: "*"
|
|
528
|
+
}
|
|
529
|
+
};
|
|
530
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
531
|
+
description: "Create a workflow execution event recording a phase transition."
|
|
403
532
|
};
|
|
404
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
405
|
-
// description: "Create a workflow execution event recording a phase transition."
|
|
406
|
-
// };
|
|
407
533
|
}
|
|
408
534
|
|
|
409
535
|
// Indicates a :ref:`ref_flyteidl.event.NodeExecutionEvent` has occurred.
|
|
@@ -411,10 +537,14 @@ service AdminService {
|
|
|
411
537
|
option (google.api.http) = {
|
|
412
538
|
post: "/api/v1/events/nodes"
|
|
413
539
|
body: "*"
|
|
540
|
+
additional_bindings {
|
|
541
|
+
post: "/api/v1/events/org/{event.id.execution_id.org}/nodes"
|
|
542
|
+
body: "*"
|
|
543
|
+
}
|
|
544
|
+
};
|
|
545
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
546
|
+
description: "Create a node execution event recording a phase transition."
|
|
414
547
|
};
|
|
415
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
416
|
-
// description: "Create a node execution event recording a phase transition."
|
|
417
|
-
// };
|
|
418
548
|
}
|
|
419
549
|
|
|
420
550
|
// Indicates a :ref:`ref_flyteidl.event.TaskExecutionEvent` has occurred.
|
|
@@ -422,41 +552,54 @@ service AdminService {
|
|
|
422
552
|
option (google.api.http) = {
|
|
423
553
|
post: "/api/v1/events/tasks"
|
|
424
554
|
body: "*"
|
|
555
|
+
additional_bindings {
|
|
556
|
+
post: "/api/v1/events/org/{event.parent_node_execution_id.execution_id.org}/tasks"
|
|
557
|
+
body: "*"
|
|
558
|
+
}
|
|
559
|
+
};
|
|
560
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
561
|
+
description: "Create a task execution event recording a phase transition."
|
|
425
562
|
};
|
|
426
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
427
|
-
// description: "Create a task execution event recording a phase transition."
|
|
428
|
-
// };
|
|
429
563
|
}
|
|
430
564
|
|
|
431
565
|
// Fetches a :ref:`ref_flyteidl.admin.TaskExecution`.
|
|
432
566
|
rpc GetTaskExecution (flyteidl.admin.TaskExecutionGetRequest) returns (flyteidl.admin.TaskExecution) {
|
|
433
567
|
option (google.api.http) = {
|
|
434
|
-
|
|
568
|
+
get: "/api/v1/task_executions/{id.node_execution_id.execution_id.project}/{id.node_execution_id.execution_id.domain}/{id.node_execution_id.execution_id.name}/{id.node_execution_id.node_id}/{id.task_id.project}/{id.task_id.domain}/{id.task_id.name}/{id.task_id.version}/{id.retry_attempt}"
|
|
569
|
+
additional_bindings {
|
|
570
|
+
get: "/api/v1/task_executions/org/{id.node_execution_id.execution_id.org}/{id.node_execution_id.execution_id.project}/{id.node_execution_id.execution_id.domain}/{id.node_execution_id.execution_id.name}/{id.node_execution_id.node_id}/{id.task_id.project}/{id.task_id.domain}/{id.task_id.name}/{id.task_id.version}/{id.retry_attempt}"
|
|
571
|
+
}
|
|
572
|
+
};
|
|
573
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
574
|
+
description: "Retrieve an existing task execution."
|
|
435
575
|
};
|
|
436
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
437
|
-
// description: "Retrieve an existing task execution."
|
|
438
|
-
// };
|
|
439
576
|
}
|
|
440
577
|
|
|
441
578
|
// Fetches a list of :ref:`ref_flyteidl.admin.TaskExecution`.
|
|
442
579
|
rpc ListTaskExecutions (flyteidl.admin.TaskExecutionListRequest) returns (flyteidl.admin.TaskExecutionList) {
|
|
443
580
|
option (google.api.http) = {
|
|
444
|
-
|
|
581
|
+
get: "/api/v1/task_executions/{node_execution_id.execution_id.project}/{node_execution_id.execution_id.domain}/{node_execution_id.execution_id.name}/{node_execution_id.node_id}"
|
|
582
|
+
additional_bindings {
|
|
583
|
+
get: "/api/v1/task_executions/org/{node_execution_id.execution_id.org}/{node_execution_id.execution_id.project}/{node_execution_id.execution_id.domain}/{node_execution_id.execution_id.name}/{node_execution_id.node_id}"
|
|
584
|
+
}
|
|
585
|
+
};
|
|
586
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
587
|
+
description: "Fetch existing task executions matching input filters."
|
|
445
588
|
};
|
|
446
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
447
|
-
// description: "Fetch existing task executions matching input filters."
|
|
448
|
-
// };
|
|
449
589
|
|
|
450
590
|
}
|
|
451
591
|
|
|
452
592
|
// Fetches input and output data for a :ref:`ref_flyteidl.admin.TaskExecution`.
|
|
453
593
|
rpc GetTaskExecutionData (flyteidl.admin.TaskExecutionGetDataRequest) returns (flyteidl.admin.TaskExecutionGetDataResponse) {
|
|
454
594
|
option (google.api.http) = {
|
|
455
|
-
|
|
595
|
+
get: "/api/v1/data/task_executions/{id.node_execution_id.execution_id.project}/{id.node_execution_id.execution_id.domain}/{id.node_execution_id.execution_id.name}/{id.node_execution_id.node_id}/{id.task_id.project}/{id.task_id.domain}/{id.task_id.name}/{id.task_id.version}/{id.retry_attempt}"
|
|
596
|
+
additional_bindings {
|
|
597
|
+
get: "/api/v1/data/org/{id.node_execution_id.execution_id.org}/task_executions/{id.node_execution_id.execution_id.project}/{id.node_execution_id.execution_id.domain}/{id.node_execution_id.execution_id.name}/{id.node_execution_id.node_id}/{id.task_id.project}/{id.task_id.domain}/{id.task_id.name}/{id.task_id.version}/{id.retry_attempt}"
|
|
598
|
+
}
|
|
599
|
+
};
|
|
600
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
601
|
+
description: "Retrieve input and output data from an existing task execution."
|
|
456
602
|
};
|
|
457
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
458
|
-
// description: "Retrieve input and output data from an existing task execution."
|
|
459
|
-
// };
|
|
460
603
|
}
|
|
461
604
|
|
|
462
605
|
// Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
|
|
@@ -464,20 +607,27 @@ service AdminService {
|
|
|
464
607
|
option (google.api.http) = {
|
|
465
608
|
put: "/api/v1/project_domain_attributes/{attributes.project}/{attributes.domain}"
|
|
466
609
|
body: "*"
|
|
610
|
+
additional_bindings {
|
|
611
|
+
put: "/api/v1/project_domain_attributes/org/{attributes.org}/{attributes.project}/{attributes.domain}"
|
|
612
|
+
body: "*"
|
|
613
|
+
}
|
|
614
|
+
};
|
|
615
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
616
|
+
description: "Update the customized resource attributes associated with a project-domain combination"
|
|
467
617
|
};
|
|
468
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
469
|
-
// description: "Update the customized resource attributes associated with a project-domain combination"
|
|
470
|
-
// };
|
|
471
618
|
}
|
|
472
619
|
|
|
473
620
|
// Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
|
|
474
621
|
rpc GetProjectDomainAttributes (flyteidl.admin.ProjectDomainAttributesGetRequest) returns (flyteidl.admin.ProjectDomainAttributesGetResponse) {
|
|
475
622
|
option (google.api.http) = {
|
|
476
623
|
get: "/api/v1/project_domain_attributes/{project}/{domain}"
|
|
624
|
+
additional_bindings {
|
|
625
|
+
get: "/api/v1/project_domain_attributes/org/{org}/{project}/{domain}"
|
|
626
|
+
}
|
|
627
|
+
};
|
|
628
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
629
|
+
description: "Retrieve the customized resource attributes associated with a project-domain combination"
|
|
477
630
|
};
|
|
478
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
479
|
-
// description: "Retrieve the customized resource attributes associated with a project-domain combination"
|
|
480
|
-
// };
|
|
481
631
|
}
|
|
482
632
|
|
|
483
633
|
// Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
|
|
@@ -485,10 +635,14 @@ service AdminService {
|
|
|
485
635
|
option (google.api.http) = {
|
|
486
636
|
delete: "/api/v1/project_domain_attributes/{project}/{domain}"
|
|
487
637
|
body: "*"
|
|
638
|
+
additional_bindings {
|
|
639
|
+
delete: "/api/v1/project_domain_attributes/org/{org}/{project}/{domain}"
|
|
640
|
+
body: "*"
|
|
641
|
+
}
|
|
642
|
+
};
|
|
643
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
644
|
+
description: "Delete the customized resource attributes associated with a project-domain combination"
|
|
488
645
|
};
|
|
489
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
490
|
-
// description: "Delete the customized resource attributes associated with a project-domain combination"
|
|
491
|
-
// };
|
|
492
646
|
}
|
|
493
647
|
|
|
494
648
|
// Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` at the project level
|
|
@@ -496,20 +650,27 @@ service AdminService {
|
|
|
496
650
|
option (google.api.http) = {
|
|
497
651
|
put: "/api/v1/project_attributes/{attributes.project}"
|
|
498
652
|
body: "*"
|
|
653
|
+
additional_bindings {
|
|
654
|
+
put: "/api/v1/project_domain_attributes/org/{attributes.org}/{attributes.project}"
|
|
655
|
+
body: "*"
|
|
656
|
+
}
|
|
657
|
+
};
|
|
658
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
659
|
+
description: "Update the customized resource attributes associated with a project"
|
|
499
660
|
};
|
|
500
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
501
|
-
// description: "Update the customized resource attributes associated with a project"
|
|
502
|
-
// };
|
|
503
661
|
}
|
|
504
662
|
|
|
505
663
|
// Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
|
|
506
664
|
rpc GetProjectAttributes (flyteidl.admin.ProjectAttributesGetRequest) returns (flyteidl.admin.ProjectAttributesGetResponse) {
|
|
507
665
|
option (google.api.http) = {
|
|
508
666
|
get: "/api/v1/project_attributes/{project}"
|
|
667
|
+
additional_bindings {
|
|
668
|
+
get: "/api/v1/project_domain_attributes/org/{org}/{project}"
|
|
669
|
+
}
|
|
670
|
+
};
|
|
671
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
672
|
+
description: "Retrieve the customized resource attributes associated with a project"
|
|
509
673
|
};
|
|
510
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
511
|
-
// description: "Retrieve the customized resource attributes associated with a project"
|
|
512
|
-
// };
|
|
513
674
|
}
|
|
514
675
|
|
|
515
676
|
// Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
|
|
@@ -517,30 +678,41 @@ service AdminService {
|
|
|
517
678
|
option (google.api.http) = {
|
|
518
679
|
delete: "/api/v1/project_attributes/{project}"
|
|
519
680
|
body: "*"
|
|
681
|
+
additional_bindings {
|
|
682
|
+
delete: "/api/v1/project_domain_attributes/org/{org}/{project}"
|
|
683
|
+
body: "*"
|
|
684
|
+
}
|
|
685
|
+
};
|
|
686
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
687
|
+
description: "Delete the customized resource attributes associated with a project"
|
|
520
688
|
};
|
|
521
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
522
|
-
// description: "Delete the customized resource attributes associated with a project"
|
|
523
|
-
// };
|
|
524
689
|
}
|
|
525
690
|
// Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
|
|
526
691
|
rpc UpdateWorkflowAttributes (flyteidl.admin.WorkflowAttributesUpdateRequest) returns (flyteidl.admin.WorkflowAttributesUpdateResponse) {
|
|
527
692
|
option (google.api.http) = {
|
|
528
693
|
put: "/api/v1/workflow_attributes/{attributes.project}/{attributes.domain}/{attributes.workflow}"
|
|
529
694
|
body: "*"
|
|
695
|
+
additional_bindings {
|
|
696
|
+
put: "/api/v1/workflow_attributes/org/{attributes.org}/{attributes.project}/{attributes.domain}/{attributes.workflow}"
|
|
697
|
+
body: "*"
|
|
698
|
+
}
|
|
699
|
+
};
|
|
700
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
701
|
+
description: "Update the customized resource attributes associated with a project, domain and workflow combination"
|
|
530
702
|
};
|
|
531
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
532
|
-
// description: "Update the customized resource attributes associated with a project, domain and workflow combination"
|
|
533
|
-
// };
|
|
534
703
|
}
|
|
535
704
|
|
|
536
705
|
// Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
|
|
537
706
|
rpc GetWorkflowAttributes (flyteidl.admin.WorkflowAttributesGetRequest) returns (flyteidl.admin.WorkflowAttributesGetResponse) {
|
|
538
707
|
option (google.api.http) = {
|
|
539
708
|
get: "/api/v1/workflow_attributes/{project}/{domain}/{workflow}"
|
|
709
|
+
additional_bindings {
|
|
710
|
+
get: "/api/v1/workflow_attributes/org/{org}/{project}/{domain}/{workflow}"
|
|
711
|
+
}
|
|
712
|
+
};
|
|
713
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
714
|
+
description: "Retrieve the customized resource attributes associated with a project, domain and workflow combination"
|
|
540
715
|
};
|
|
541
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
542
|
-
// description: "Retrieve the customized resource attributes associated with a project, domain and workflow combination"
|
|
543
|
-
// };
|
|
544
716
|
}
|
|
545
717
|
|
|
546
718
|
// Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
|
|
@@ -548,40 +720,53 @@ service AdminService {
|
|
|
548
720
|
option (google.api.http) = {
|
|
549
721
|
delete: "/api/v1/workflow_attributes/{project}/{domain}/{workflow}"
|
|
550
722
|
body: "*"
|
|
723
|
+
additional_bindings {
|
|
724
|
+
delete: "/api/v1/workflow_attributes/org/{org}/{project}/{domain}/{workflow}"
|
|
725
|
+
body: "*"
|
|
726
|
+
}
|
|
727
|
+
};
|
|
728
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
729
|
+
description: "Delete the customized resource attributes associated with a project, domain and workflow combination"
|
|
551
730
|
};
|
|
552
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
553
|
-
// description: "Delete the customized resource attributes associated with a project, domain and workflow combination"
|
|
554
|
-
// };
|
|
555
731
|
}
|
|
556
732
|
|
|
557
733
|
// Lists custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a specific resource type.
|
|
558
734
|
rpc ListMatchableAttributes (flyteidl.admin.ListMatchableAttributesRequest) returns (flyteidl.admin.ListMatchableAttributesResponse) {
|
|
559
735
|
option (google.api.http) = {
|
|
560
736
|
get: "/api/v1/matchable_attributes"
|
|
737
|
+
additional_bindings {
|
|
738
|
+
get: "/api/v1/matchable_attributes/org/{org}"
|
|
739
|
+
}
|
|
740
|
+
};
|
|
741
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
742
|
+
description: "Retrieve a list of MatchableAttributesConfiguration objects."
|
|
561
743
|
};
|
|
562
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
563
|
-
// description: "Retrieve a list of MatchableAttributesConfiguration objects."
|
|
564
|
-
// };
|
|
565
744
|
}
|
|
566
745
|
|
|
567
746
|
// Returns a list of :ref:`ref_flyteidl.admin.NamedEntity` objects.
|
|
568
747
|
rpc ListNamedEntities (flyteidl.admin.NamedEntityListRequest) returns (flyteidl.admin.NamedEntityList) {
|
|
569
748
|
option (google.api.http) = {
|
|
570
749
|
get: "/api/v1/named_entities/{resource_type}/{project}/{domain}"
|
|
750
|
+
additional_bindings {
|
|
751
|
+
get: "/api/v1/named_entities/org/{org}/{resource_type}/{project}/{domain}"
|
|
752
|
+
}
|
|
753
|
+
};
|
|
754
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
755
|
+
description: "Retrieve a list of NamedEntity objects sharing a common resource type, project, and domain."
|
|
571
756
|
};
|
|
572
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
573
|
-
// description: "Retrieve a list of NamedEntity objects sharing a common resource type, project, and domain."
|
|
574
|
-
// };
|
|
575
757
|
}
|
|
576
758
|
|
|
577
759
|
// Returns a :ref:`ref_flyteidl.admin.NamedEntity` object.
|
|
578
760
|
rpc GetNamedEntity (flyteidl.admin.NamedEntityGetRequest) returns (flyteidl.admin.NamedEntity) {
|
|
579
761
|
option (google.api.http) = {
|
|
580
762
|
get: "/api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name}"
|
|
763
|
+
additional_bindings {
|
|
764
|
+
get: "/api/v1/named_entities/org/{id.org}/{resource_type}/{id.project}/{id.domain}/{id.name}"
|
|
765
|
+
}
|
|
766
|
+
};
|
|
767
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
768
|
+
description: "Retrieve a NamedEntity object."
|
|
581
769
|
};
|
|
582
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
583
|
-
// description: "Retrieve a NamedEntity object."
|
|
584
|
-
// };
|
|
585
770
|
}
|
|
586
771
|
|
|
587
772
|
// Updates a :ref:`ref_flyteidl.admin.NamedEntity` object.
|
|
@@ -589,51 +774,67 @@ service AdminService {
|
|
|
589
774
|
option (google.api.http) = {
|
|
590
775
|
put: "/api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name}"
|
|
591
776
|
body: "*"
|
|
777
|
+
additional_bindings {
|
|
778
|
+
put: "/api/v1/named_entities/org/{id.org}/{resource_type}/{id.project}/{id.domain}/{id.name}"
|
|
779
|
+
body: "*"
|
|
780
|
+
}
|
|
781
|
+
};
|
|
782
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
783
|
+
description: "Update the fields associated with a NamedEntity"
|
|
592
784
|
};
|
|
593
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
594
|
-
// description: "Update the fields associated with a NamedEntity"
|
|
595
|
-
// };
|
|
596
785
|
}
|
|
597
786
|
|
|
598
787
|
rpc GetVersion (flyteidl.admin.GetVersionRequest) returns (flyteidl.admin.GetVersionResponse) {
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
788
|
+
option (google.api.http) = {
|
|
789
|
+
get: "/api/v1/version"
|
|
790
|
+
};
|
|
791
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
792
|
+
description: "Retrieve the Version (including the Build information) for FlyteAdmin service"
|
|
793
|
+
};
|
|
605
794
|
}
|
|
606
795
|
|
|
607
796
|
// Fetch a :ref:`ref_flyteidl.admin.DescriptionEntity` object.
|
|
608
797
|
rpc GetDescriptionEntity (flyteidl.admin.ObjectGetRequest) returns (flyteidl.admin.DescriptionEntity) {
|
|
609
798
|
option (google.api.http) = {
|
|
610
799
|
get: "/api/v1/description_entities/{id.resource_type}/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
800
|
+
additional_bindings {
|
|
801
|
+
get: "/api/v1/description_entities/org/{id.org}/{id.resource_type}/{id.project}/{id.domain}/{id.name}/{id.version}"
|
|
802
|
+
}
|
|
803
|
+
};
|
|
804
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
805
|
+
description: "Retrieve an existing description entity description."
|
|
611
806
|
};
|
|
612
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
613
|
-
// description: "Retrieve an existing description entity description."
|
|
614
|
-
// };
|
|
615
807
|
}
|
|
616
808
|
|
|
617
809
|
// Fetch a list of :ref:`ref_flyteidl.admin.DescriptionEntity` definitions.
|
|
618
810
|
rpc ListDescriptionEntities (flyteidl.admin.DescriptionEntityListRequest) returns (flyteidl.admin.DescriptionEntityList) {
|
|
619
811
|
option (google.api.http) = {
|
|
620
812
|
get: "/api/v1/description_entities/{resource_type}/{id.project}/{id.domain}/{id.name}"
|
|
813
|
+
additional_bindings {
|
|
814
|
+
get: "/api/v1/description_entities/org/{id.org}/{resource_type}/{id.project}/{id.domain}/{id.name}"
|
|
815
|
+
}
|
|
621
816
|
additional_bindings {
|
|
622
817
|
get: "/api/v1/description_entities/{resource_type}/{id.project}/{id.domain}"
|
|
623
818
|
}
|
|
819
|
+
additional_bindings {
|
|
820
|
+
get: "/api/v1/description_entities/org/{id.org}/{resource_type}/{id.project}/{id.domain}"
|
|
821
|
+
}
|
|
822
|
+
};
|
|
823
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
824
|
+
description: "Fetch existing description entity definitions matching input filters."
|
|
624
825
|
};
|
|
625
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
626
|
-
// description: "Fetch existing description entity definitions matching input filters."
|
|
627
|
-
// };
|
|
628
826
|
}
|
|
629
827
|
|
|
630
828
|
// Fetches runtime metrics for a :ref:`ref_flyteidl.admin.Execution`.
|
|
631
829
|
rpc GetExecutionMetrics (flyteidl.admin.WorkflowExecutionGetMetricsRequest) returns (flyteidl.admin.WorkflowExecutionGetMetricsResponse) {
|
|
632
830
|
option (google.api.http) = {
|
|
633
831
|
get: "/api/v1/metrics/executions/{id.project}/{id.domain}/{id.name}"
|
|
832
|
+
additional_bindings {
|
|
833
|
+
get: "/api/v1/metrics/executions/org/{id.org}/{id.project}/{id.domain}/{id.name}"
|
|
834
|
+
}
|
|
835
|
+
};
|
|
836
|
+
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
|
|
837
|
+
description: "Retrieve metrics from an existing workflow execution."
|
|
634
838
|
};
|
|
635
|
-
// option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
|
|
636
|
-
// description: "Retrieve metrics from an existing workflow execution."
|
|
637
|
-
// };
|
|
638
839
|
};
|
|
639
840
|
}
|