@flyteorg/flyteidl 1.2.8 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/package.json +1 -1
  2. package/protos/flyteidl/service/admin.proto +201 -201
  3. package/protos/flyteidl/service/auth.proto +7 -7
  4. package/protos/flyteidl/service/dataproxy.proto +10 -10
  5. package/protos/flyteidl/service/identity.proto +4 -4
  6. package/protos/flyteidl/service/signal.proto +22 -22
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flyteorg/flyteidl",
3
- "version": "1.2.8",
3
+ "version": "1.3.0",
4
4
  "description": "Compiled protocol buffers and gRPC service clients/servers for Flyte IDLs",
5
5
  "repository": {
6
6
  "type": "git",
package/protos/flyteidl/service/admin.proto CHANGED
@@ -20,7 +20,7 @@ import "flyteidl/admin/version.proto";
20
20
  import "flyteidl/admin/common.proto";
21
21
  import "flyteidl/admin/description_entity.proto";
22
22
  import "flyteidl/core/identifier.proto";
23
- import "protoc-gen-swagger/options/annotations.proto";
23
+ // import "protoc-gen-swagger/options/annotations.proto";
24
24
 
25
25
  // The following defines an RPC service that is also served over HTTP via grpc-gateway.
26
26
  // Standard response codes for both are defined here: https://github.com/grpc-ecosystem/grpc-gateway/blob/master/runtime/errors.go
@@ -31,21 +31,21 @@ service AdminService {
31
31
  post: "/api/v1/tasks"
32
32
  body: "*"
33
33
  };
34
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
35
- description: "Create and register a task definition."
36
- responses: {
37
- key: "400"
38
- value: {
39
- description: "Returned for bad request that may have failed validation."
40
- }
41
- }
42
- responses: {
43
- key: "409"
44
- value: {
45
- description: "Returned for a request that references an identical entity that has already been registered."
46
- }
47
- }
48
- };
34
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
35
+ // description: "Create and register a task definition."
36
+ // responses: {
37
+ // key: "400"
38
+ // value: {
39
+ // description: "Returned for bad request that may have failed validation."
40
+ // }
41
+ // }
42
+ // responses: {
43
+ // key: "409"
44
+ // value: {
45
+ // description: "Returned for a request that references an identical entity that has already been registered."
46
+ // }
47
+ // }
48
+ // };
49
49
  }
50
50
 
51
51
  // Fetch a :ref:`ref_flyteidl.admin.Task` definition.
@@ -53,9 +53,9 @@ service AdminService {
53
53
  option (google.api.http) = {
54
54
  get: "/api/v1/tasks/{id.project}/{id.domain}/{id.name}/{id.version}"
55
55
  };
56
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
57
- description: "Retrieve an existing task definition."
58
- };
56
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
57
+ // description: "Retrieve an existing task definition."
58
+ // };
59
59
  }
60
60
 
61
61
  // Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of task objects.
@@ -63,9 +63,9 @@ service AdminService {
63
63
  option (google.api.http) = {
64
64
  get: "/api/v1/task_ids/{project}/{domain}"
65
65
  };
66
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
67
- description: "Fetch existing task definition identifiers matching input filters."
68
- };
66
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
67
+ // description: "Fetch existing task definition identifiers matching input filters."
68
+ // };
69
69
  }
70
70
 
71
71
  // Fetch a list of :ref:`ref_flyteidl.admin.Task` definitions.
@@ -76,9 +76,9 @@ service AdminService {
76
76
  get: "/api/v1/tasks/{id.project}/{id.domain}"
77
77
  }
78
78
  };
79
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
80
- description: "Fetch existing task definitions matching input filters."
81
- };
79
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
80
+ // description: "Fetch existing task definitions matching input filters."
81
+ // };
82
82
  }
83
83
 
84
84
  // Create and upload a :ref:`ref_flyteidl.admin.Workflow` definition
@@ -87,21 +87,21 @@ service AdminService {
87
87
  post: "/api/v1/workflows"
88
88
  body: "*"
89
89
  };
90
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
91
- description: "Create and register a workflow definition."
92
- responses: {
93
- key: "400"
94
- value: {
95
- description: "Returned for bad request that may have failed validation."
96
- }
97
- }
98
- responses: {
99
- key: "409"
100
- value: {
101
- description: "Returned for a request that references an identical entity that has already been registered."
102
- }
103
- }
104
- };
90
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
91
+ // description: "Create and register a workflow definition."
92
+ // responses: {
93
+ // key: "400"
94
+ // value: {
95
+ // description: "Returned for bad request that may have failed validation."
96
+ // }
97
+ // }
98
+ // responses: {
99
+ // key: "409"
100
+ // value: {
101
+ // description: "Returned for a request that references an identical entity that has already been registered."
102
+ // }
103
+ // }
104
+ // };
105
105
  }
106
106
 
107
107
  // Fetch a :ref:`ref_flyteidl.admin.Workflow` definition.
@@ -109,9 +109,9 @@ service AdminService {
109
109
  option (google.api.http) = {
110
110
  get: "/api/v1/workflows/{id.project}/{id.domain}/{id.name}/{id.version}"
111
111
  };
112
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
113
- description: "Retrieve an existing workflow definition."
114
- };
112
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
113
+ // description: "Retrieve an existing workflow definition."
114
+ // };
115
115
  }
116
116
 
117
117
  // Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of workflow objects.
@@ -119,9 +119,9 @@ service AdminService {
119
119
  option (google.api.http) = {
120
120
  get: "/api/v1/workflow_ids/{project}/{domain}"
121
121
  };
122
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
123
- description: "Fetch an existing workflow definition identifiers matching input filters."
124
- };
122
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
123
+ // description: "Fetch an existing workflow definition identifiers matching input filters."
124
+ // };
125
125
  }
126
126
 
127
127
  // Fetch a list of :ref:`ref_flyteidl.admin.Workflow` definitions.
@@ -132,9 +132,9 @@ service AdminService {
132
132
  get: "/api/v1/workflows/{id.project}/{id.domain}"
133
133
  }
134
134
  };
135
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
136
- description: "Fetch existing workflow definitions matching input filters."
137
- };
135
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
136
+ // description: "Fetch existing workflow definitions matching input filters."
137
+ // };
138
138
  }
139
139
 
140
140
  // Create and upload a :ref:`ref_flyteidl.admin.LaunchPlan` definition
@@ -143,21 +143,21 @@ service AdminService {
143
143
  post: "/api/v1/launch_plans"
144
144
  body: "*"
145
145
  };
146
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
147
- description: "Create and register a launch plan definition."
148
- responses: {
149
- key: "400"
150
- value: {
151
- description: "Returned for bad request that may have failed validation."
152
- }
153
- }
154
- responses: {
155
- key: "409"
156
- value: {
157
- description: "Returned for a request that references an identical entity that has already been registered."
158
- }
159
- }
160
- };
146
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
147
+ // description: "Create and register a launch plan definition."
148
+ // responses: {
149
+ // key: "400"
150
+ // value: {
151
+ // description: "Returned for bad request that may have failed validation."
152
+ // }
153
+ // }
154
+ // responses: {
155
+ // key: "409"
156
+ // value: {
157
+ // description: "Returned for a request that references an identical entity that has already been registered."
158
+ // }
159
+ // }
160
+ // };
161
161
  }
162
162
 
163
163
  // Fetch a :ref:`ref_flyteidl.admin.LaunchPlan` definition.
@@ -165,9 +165,9 @@ service AdminService {
165
165
  option (google.api.http) = {
166
166
  get: "/api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version}"
167
167
  };
168
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
169
- description: "Retrieve an existing launch plan definition."
170
- };
168
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
169
+ // description: "Retrieve an existing launch plan definition."
170
+ // };
171
171
  }
172
172
 
173
173
  // Fetch the active version of a :ref:`ref_flyteidl.admin.LaunchPlan`.
@@ -175,9 +175,9 @@ service AdminService {
175
175
  option (google.api.http) = {
176
176
  get: "/api/v1/active_launch_plans/{id.project}/{id.domain}/{id.name}"
177
177
  };
178
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
179
- description: "Retrieve the active launch plan version specified by input request filters."
180
- };
178
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
179
+ // description: "Retrieve the active launch plan version specified by input request filters."
180
+ // };
181
181
  }
182
182
 
183
183
  // List active versions of :ref:`ref_flyteidl.admin.LaunchPlan`.
@@ -185,9 +185,9 @@ service AdminService {
185
185
  option (google.api.http) = {
186
186
  get: "/api/v1/active_launch_plans/{project}/{domain}"
187
187
  };
188
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
189
- description: "Fetch the active launch plan versions specified by input request filters."
190
- };
188
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
189
+ // description: "Fetch the active launch plan versions specified by input request filters."
190
+ // };
191
191
  }
192
192
 
193
193
  // Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of launch plan objects.
@@ -195,9 +195,9 @@ service AdminService {
195
195
  option (google.api.http) = {
196
196
  get: "/api/v1/launch_plan_ids/{project}/{domain}"
197
197
  };
198
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
199
- description: "Fetch existing launch plan definition identifiers matching input filters."
200
- };
198
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
199
+ // description: "Fetch existing launch plan definition identifiers matching input filters."
200
+ // };
201
201
  }
202
202
 
203
203
  // Fetch a list of :ref:`ref_flyteidl.admin.LaunchPlan` definitions.
@@ -208,9 +208,9 @@ service AdminService {
208
208
  get: "/api/v1/launch_plans/{id.project}/{id.domain}"
209
209
  }
210
210
  };
211
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
212
- description: "Fetch existing launch plan definitions matching input filters."
213
- };
211
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
212
+ // description: "Fetch existing launch plan definitions matching input filters."
213
+ // };
214
214
  }
215
215
 
216
216
  // Updates the status of a registered :ref:`ref_flyteidl.admin.LaunchPlan`.
@@ -219,14 +219,14 @@ service AdminService {
219
219
  put: "/api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version}"
220
220
  body: "*"
221
221
  };
222
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
223
- description: "Update the status of an existing launch plan definition. "
224
- "At most one launch plan version for a given {project, domain, name} can be active at a time. "
225
- "If this call sets a launch plan to active and existing version is already active, the result of this call will be that the "
226
- "formerly active launch plan will be made inactive and specified launch plan in this request will be made active. "
227
- "In the event that the formerly active launch plan had a schedule associated it with it, this schedule will be disabled. "
228
- "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."
229
- };
222
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
223
+ // description: "Update the status of an existing launch plan definition. "
224
+ // "At most one launch plan version for a given {project, domain, name} can be active at a time. "
225
+ // "If this call sets a launch plan to active and existing version is already active, the result of this call will be that the "
226
+ // "formerly active launch plan will be made inactive and specified launch plan in this request will be made active. "
227
+ // "In the event that the formerly active launch plan had a schedule associated it with it, this schedule will be disabled. "
228
+ // "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."
229
+ // };
230
230
  }
231
231
 
232
232
  // Triggers the creation of a :ref:`ref_flyteidl.admin.Execution`
@@ -235,9 +235,9 @@ service AdminService {
235
235
  post: "/api/v1/executions"
236
236
  body: "*"
237
237
  };
238
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
239
- description: "Create a workflow execution."
240
- };
238
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
239
+ // description: "Create a workflow execution."
240
+ // };
241
241
  }
242
242
 
243
243
  // Triggers the creation of an identical :ref:`ref_flyteidl.admin.Execution`
@@ -246,9 +246,9 @@ service AdminService {
246
246
  post: "/api/v1/executions/relaunch"
247
247
  body: "*"
248
248
  };
249
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
250
- description: "Relaunch a workflow execution."
251
- };
249
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
250
+ // description: "Relaunch a workflow execution."
251
+ // };
252
252
  }
253
253
 
254
254
  // Recreates a previously-run workflow execution that will only start executing from the last known failure point.
@@ -261,13 +261,13 @@ service AdminService {
261
261
  post: "/api/v1/executions/recover"
262
262
  body: "*"
263
263
  };
264
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
265
- description: "Recreates a previously-run workflow execution that will only start executing from the last known failure point. "
266
- "In Recover mode, users cannot change any input parameters or update the version of the execution. "
267
- "This is extremely useful to recover from system errors and byzantine faults like - Loss of K8s cluster, bugs in platform or instability, machine failures, "
268
- "downstream system failures (downstream services), or simply to recover executions that failed because of retry exhaustion and should complete if tried again."
264
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
265
+ // description: "Recreates a previously-run workflow execution that will only start executing from the last known failure point. "
266
+ // "In Recover mode, users cannot change any input parameters or update the version of the execution. "
267
+ // "This is extremely useful to recover from system errors and byzantine faults like - Loss of K8s cluster, bugs in platform or instability, machine failures, "
268
+ // "downstream system failures (downstream services), or simply to recover executions that failed because of retry exhaustion and should complete if tried again."
269
269
 
270
- };
270
+ // };
271
271
  }
272
272
 
273
273
  // Fetches a :ref:`ref_flyteidl.admin.Execution`.
@@ -275,9 +275,9 @@ service AdminService {
275
275
  option (google.api.http) = {
276
276
  get: "/api/v1/executions/{id.project}/{id.domain}/{id.name}"
277
277
  };
278
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
279
- description: "Retrieve an existing workflow execution."
280
- };
278
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
279
+ // description: "Retrieve an existing workflow execution."
280
+ // };
281
281
  }
282
282
 
283
283
  // Update execution belonging to project domain :ref:`ref_flyteidl.admin.Execution`.
@@ -286,9 +286,9 @@ service AdminService {
286
286
  put: "/api/v1/executions/{id.project}/{id.domain}/{id.name}"
287
287
  body: "*"
288
288
  };
289
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
290
- description: "Update execution belonging to project domain."
291
- };
289
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
290
+ // description: "Update execution belonging to project domain."
291
+ // };
292
292
  }
293
293
 
294
294
  // Fetches input and output data for a :ref:`ref_flyteidl.admin.Execution`.
@@ -296,9 +296,9 @@ service AdminService {
296
296
  option (google.api.http) = {
297
297
  get: "/api/v1/data/executions/{id.project}/{id.domain}/{id.name}"
298
298
  };
299
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
300
- description: "Retrieve input and output data from an existing workflow execution."
301
- };
299
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
300
+ // description: "Retrieve input and output data from an existing workflow execution."
301
+ // };
302
302
  };
303
303
 
304
304
  // Fetch a list of :ref:`ref_flyteidl.admin.Execution`.
@@ -306,9 +306,9 @@ service AdminService {
306
306
  option (google.api.http) = {
307
307
  get: "/api/v1/executions/{id.project}/{id.domain}"
308
308
  };
309
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
310
- description: "Fetch existing workflow executions matching input filters."
311
- };
309
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
310
+ // description: "Fetch existing workflow executions matching input filters."
311
+ // };
312
312
  }
313
313
 
314
314
  // Terminates an in-progress :ref:`ref_flyteidl.admin.Execution`.
@@ -317,9 +317,9 @@ service AdminService {
317
317
  delete: "/api/v1/executions/{id.project}/{id.domain}/{id.name}"
318
318
  body: "*"
319
319
  };
320
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
321
- description: "Terminate the active workflow execution specified in the request."
322
- };
320
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
321
+ // description: "Terminate the active workflow execution specified in the request."
322
+ // };
323
323
  }
324
324
 
325
325
  // Fetches a :ref:`ref_flyteidl.admin.NodeExecution`.
@@ -327,9 +327,9 @@ service AdminService {
327
327
  option (google.api.http) = {
328
328
  get: "/api/v1/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}"
329
329
  };
330
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
331
- description: "Retrieve an existing node execution."
332
- };
330
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
331
+ // description: "Retrieve an existing node execution."
332
+ // };
333
333
  }
334
334
 
335
335
  // Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution`.
@@ -337,9 +337,9 @@ service AdminService {
337
337
  option (google.api.http) = {
338
338
  get: "/api/v1/node_executions/{workflow_execution_id.project}/{workflow_execution_id.domain}/{workflow_execution_id.name}"
339
339
  };
340
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
341
- description: "Fetch existing node executions matching input filters."
342
- };
340
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
341
+ // description: "Fetch existing node executions matching input filters."
342
+ // };
343
343
  }
344
344
 
345
345
  // Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution` launched by the reference :ref:`ref_flyteidl.admin.TaskExecution`.
@@ -347,9 +347,9 @@ service AdminService {
347
347
  option (google.api.http) = {
348
348
  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}"
349
349
  };
350
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
351
- description: "Fetch child node executions launched by the specified task execution."
352
- };
350
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
351
+ // description: "Fetch child node executions launched by the specified task execution."
352
+ // };
353
353
  }
354
354
 
355
355
  // Fetches input and output data for a :ref:`ref_flyteidl.admin.NodeExecution`.
@@ -357,9 +357,9 @@ service AdminService {
357
357
  option (google.api.http) = {
358
358
  get: "/api/v1/data/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}"
359
359
  };
360
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
361
- description: "Retrieve input and output data from an existing node execution."
362
- };
360
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
361
+ // description: "Retrieve input and output data from an existing node execution."
362
+ // };
363
363
  };
364
364
 
365
365
  // Registers a :ref:`ref_flyteidl.admin.Project` with the Flyte deployment.
@@ -368,9 +368,9 @@ service AdminService {
368
368
  post: "/api/v1/projects"
369
369
  body: "*"
370
370
  };
371
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
372
- description: "Register a project."
373
- };
371
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
372
+ // description: "Register a project."
373
+ // };
374
374
  }
375
375
 
376
376
  // Updates an existing :ref:`ref_flyteidl.admin.Project`
@@ -381,9 +381,9 @@ service AdminService {
381
381
  put: "/api/v1/projects/{id}"
382
382
  body: "*"
383
383
  };
384
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
385
- description: "Update a project."
386
- };
384
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
385
+ // description: "Update a project."
386
+ // };
387
387
  }
388
388
 
389
389
  // Fetches a list of :ref:`ref_flyteidl.admin.Project`
@@ -391,9 +391,9 @@ service AdminService {
391
391
  option (google.api.http) = {
392
392
  get: "/api/v1/projects"
393
393
  };
394
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
395
- description: "Fetch registered projects."
396
- };
394
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
395
+ // description: "Fetch registered projects."
396
+ // };
397
397
  }
398
398
 
399
399
  // Indicates a :ref:`ref_flyteidl.event.WorkflowExecutionEvent` has occurred.
@@ -402,9 +402,9 @@ service AdminService {
402
402
  post: "/api/v1/events/workflows"
403
403
  body: "*"
404
404
  };
405
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
406
- description: "Create a workflow execution event recording a phase transition."
407
- };
405
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
406
+ // description: "Create a workflow execution event recording a phase transition."
407
+ // };
408
408
  }
409
409
 
410
410
  // Indicates a :ref:`ref_flyteidl.event.NodeExecutionEvent` has occurred.
@@ -413,9 +413,9 @@ service AdminService {
413
413
  post: "/api/v1/events/nodes"
414
414
  body: "*"
415
415
  };
416
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
417
- description: "Create a node execution event recording a phase transition."
418
- };
416
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
417
+ // description: "Create a node execution event recording a phase transition."
418
+ // };
419
419
  }
420
420
 
421
421
  // Indicates a :ref:`ref_flyteidl.event.TaskExecutionEvent` has occurred.
@@ -424,9 +424,9 @@ service AdminService {
424
424
  post: "/api/v1/events/tasks"
425
425
  body: "*"
426
426
  };
427
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
428
- description: "Create a task execution event recording a phase transition."
429
- };
427
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
428
+ // description: "Create a task execution event recording a phase transition."
429
+ // };
430
430
  }
431
431
 
432
432
  // Fetches a :ref:`ref_flyteidl.admin.TaskExecution`.
@@ -434,9 +434,9 @@ service AdminService {
434
434
  option (google.api.http) = {
435
435
  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}"
436
436
  };
437
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
438
- description: "Retrieve an existing task execution."
439
- };
437
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
438
+ // description: "Retrieve an existing task execution."
439
+ // };
440
440
  }
441
441
 
442
442
  // Fetches a list of :ref:`ref_flyteidl.admin.TaskExecution`.
@@ -444,9 +444,9 @@ service AdminService {
444
444
  option (google.api.http) = {
445
445
  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}"
446
446
  };
447
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
448
- description: "Fetch existing task executions matching input filters."
449
- };
447
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
448
+ // description: "Fetch existing task executions matching input filters."
449
+ // };
450
450
 
451
451
  }
452
452
 
@@ -455,9 +455,9 @@ service AdminService {
455
455
  option (google.api.http) = {
456
456
  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}"
457
457
  };
458
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
459
- description: "Retrieve input and output data from an existing task execution."
460
- };
458
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
459
+ // description: "Retrieve input and output data from an existing task execution."
460
+ // };
461
461
  }
462
462
 
463
463
  // Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
@@ -466,9 +466,9 @@ service AdminService {
466
466
  put: "/api/v1/project_domain_attributes/{attributes.project}/{attributes.domain}"
467
467
  body: "*"
468
468
  };
469
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
470
- description: "Update the customized resource attributes associated with a project-domain combination"
471
- };
469
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
470
+ // description: "Update the customized resource attributes associated with a project-domain combination"
471
+ // };
472
472
  }
473
473
 
474
474
  // Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
@@ -476,9 +476,9 @@ service AdminService {
476
476
  option (google.api.http) = {
477
477
  get: "/api/v1/project_domain_attributes/{project}/{domain}"
478
478
  };
479
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
480
- description: "Retrieve the customized resource attributes associated with a project-domain combination"
481
- };
479
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
480
+ // description: "Retrieve the customized resource attributes associated with a project-domain combination"
481
+ // };
482
482
  }
483
483
 
484
484
  // Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
@@ -487,9 +487,9 @@ service AdminService {
487
487
  delete: "/api/v1/project_domain_attributes/{project}/{domain}"
488
488
  body: "*"
489
489
  };
490
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
491
- description: "Delete the customized resource attributes associated with a project-domain combination"
492
- };
490
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
491
+ // description: "Delete the customized resource attributes associated with a project-domain combination"
492
+ // };
493
493
  }
494
494
 
495
495
  // Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` at the project level
@@ -498,9 +498,9 @@ service AdminService {
498
498
  put: "/api/v1/project_attributes/{attributes.project}"
499
499
  body: "*"
500
500
  };
501
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
502
- description: "Update the customized resource attributes associated with a project"
503
- };
501
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
502
+ // description: "Update the customized resource attributes associated with a project"
503
+ // };
504
504
  }
505
505
 
506
506
  // Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
@@ -508,9 +508,9 @@ service AdminService {
508
508
  option (google.api.http) = {
509
509
  get: "/api/v1/project_attributes/{project}"
510
510
  };
511
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
512
- description: "Retrieve the customized resource attributes associated with a project"
513
- };
511
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
512
+ // description: "Retrieve the customized resource attributes associated with a project"
513
+ // };
514
514
  }
515
515
 
516
516
  // Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
@@ -519,9 +519,9 @@ service AdminService {
519
519
  delete: "/api/v1/project_attributes/{project}"
520
520
  body: "*"
521
521
  };
522
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
523
- description: "Delete the customized resource attributes associated with a project"
524
- };
522
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
523
+ // description: "Delete the customized resource attributes associated with a project"
524
+ // };
525
525
  }
526
526
  // Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
527
527
  rpc UpdateWorkflowAttributes (flyteidl.admin.WorkflowAttributesUpdateRequest) returns (flyteidl.admin.WorkflowAttributesUpdateResponse) {
@@ -529,9 +529,9 @@ service AdminService {
529
529
  put: "/api/v1/workflow_attributes/{attributes.project}/{attributes.domain}/{attributes.workflow}"
530
530
  body: "*"
531
531
  };
532
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
533
- description: "Update the customized resource attributes associated with a project, domain and workflow combination"
534
- };
532
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
533
+ // description: "Update the customized resource attributes associated with a project, domain and workflow combination"
534
+ // };
535
535
  }
536
536
 
537
537
  // Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
@@ -539,9 +539,9 @@ service AdminService {
539
539
  option (google.api.http) = {
540
540
  get: "/api/v1/workflow_attributes/{project}/{domain}/{workflow}"
541
541
  };
542
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
543
- description: "Retrieve the customized resource attributes associated with a project, domain and workflow combination"
544
- };
542
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
543
+ // description: "Retrieve the customized resource attributes associated with a project, domain and workflow combination"
544
+ // };
545
545
  }
546
546
 
547
547
  // Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
@@ -550,9 +550,9 @@ service AdminService {
550
550
  delete: "/api/v1/workflow_attributes/{project}/{domain}/{workflow}"
551
551
  body: "*"
552
552
  };
553
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
554
- description: "Delete the customized resource attributes associated with a project, domain and workflow combination"
555
- };
553
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
554
+ // description: "Delete the customized resource attributes associated with a project, domain and workflow combination"
555
+ // };
556
556
  }
557
557
 
558
558
  // Lists custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a specific resource type.
@@ -560,9 +560,9 @@ service AdminService {
560
560
  option (google.api.http) = {
561
561
  get: "/api/v1/matchable_attributes"
562
562
  };
563
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
564
- description: "Retrieve a list of MatchableAttributesConfiguration objects."
565
- };
563
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
564
+ // description: "Retrieve a list of MatchableAttributesConfiguration objects."
565
+ // };
566
566
  }
567
567
 
568
568
  // Returns a list of :ref:`ref_flyteidl.admin.NamedEntity` objects.
@@ -570,9 +570,9 @@ service AdminService {
570
570
  option (google.api.http) = {
571
571
  get: "/api/v1/named_entities/{resource_type}/{project}/{domain}"
572
572
  };
573
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
574
- description: "Retrieve a list of NamedEntity objects sharing a common resource type, project, and domain."
575
- };
573
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
574
+ // description: "Retrieve a list of NamedEntity objects sharing a common resource type, project, and domain."
575
+ // };
576
576
  }
577
577
 
578
578
  // Returns a :ref:`ref_flyteidl.admin.NamedEntity` object.
@@ -580,9 +580,9 @@ service AdminService {
580
580
  option (google.api.http) = {
581
581
  get: "/api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name}"
582
582
  };
583
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
584
- description: "Retrieve a NamedEntity object."
585
- };
583
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
584
+ // description: "Retrieve a NamedEntity object."
585
+ // };
586
586
  }
587
587
 
588
588
  // Updates a :ref:`ref_flyteidl.admin.NamedEntity` object.
@@ -591,18 +591,18 @@ service AdminService {
591
591
  put: "/api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name}"
592
592
  body: "*"
593
593
  };
594
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
595
- description: "Update the fields associated with a NamedEntity"
596
- };
594
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
595
+ // description: "Update the fields associated with a NamedEntity"
596
+ // };
597
597
  }
598
598
 
599
599
  rpc GetVersion (flyteidl.admin.GetVersionRequest) returns (flyteidl.admin.GetVersionResponse) {
600
600
  option (google.api.http) = {
601
601
  get: "/api/v1/version"
602
602
  };
603
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
604
- description: "Retrieve the Version (including the Build information) for FlyteAdmin service"
605
- };
603
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
604
+ // description: "Retrieve the Version (including the Build information) for FlyteAdmin service"
605
+ // };
606
606
  }
607
607
 
608
608
  // Fetch a :ref:`ref_flyteidl.admin.DescriptionEntity` object.
@@ -610,9 +610,9 @@ service AdminService {
610
610
  option (google.api.http) = {
611
611
  get: "/api/v1/description_entities/{id.resource_type}/{id.project}/{id.domain}/{id.name}/{id.version}"
612
612
  };
613
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
614
- description: "Retrieve an existing description entity description."
615
- };
613
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
614
+ // description: "Retrieve an existing description entity description."
615
+ // };
616
616
  }
617
617
 
618
618
  // Fetch a list of :ref:`ref_flyteidl.admin.DescriptionEntity` definitions.
@@ -623,8 +623,8 @@ service AdminService {
623
623
  get: "/api/v1/description_entities/{resource_type}/{id.project}/{id.domain}"
624
624
  }
625
625
  };
626
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
627
- description: "Fetch existing description entity definitions matching input filters."
628
- };
626
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
627
+ // description: "Fetch existing description entity definitions matching input filters."
628
+ // };
629
629
  }
630
630
  }
package/protos/flyteidl/service/auth.proto CHANGED
@@ -4,7 +4,7 @@ package flyteidl.service;
4
4
  option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/service";
5
5
 
6
6
  import "google/api/annotations.proto";
7
- import "protoc-gen-swagger/options/annotations.proto";
7
+ // import "protoc-gen-swagger/options/annotations.proto";
8
8
 
9
9
  message OAuth2MetadataRequest {}
10
10
 
@@ -76,9 +76,9 @@ service AuthMetadataService {
76
76
  option (google.api.http) = {
77
77
  get: "/.well-known/oauth-authorization-server"
78
78
  };
79
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
80
- description: "Retrieves OAuth2 authorization server metadata. This endpoint is anonymously accessible."
81
- };
79
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
80
+ // description: "Retrieves OAuth2 authorization server metadata. This endpoint is anonymously accessible."
81
+ // };
82
82
  }
83
83
 
84
84
  // Anonymously accessible. Retrieves the client information clients should use when initiating OAuth2 authorization
@@ -87,8 +87,8 @@ service AuthMetadataService {
87
87
  option (google.api.http) = {
88
88
  get: "/config/v1/flyte_client"
89
89
  };
90
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
91
- description: "Retrieves public flyte client info. This endpoint is anonymously accessible."
92
- };
90
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
91
+ // description: "Retrieves public flyte client info. This endpoint is anonymously accessible."
92
+ // };
93
93
  }
94
94
  }
package/protos/flyteidl/service/dataproxy.proto CHANGED
@@ -4,7 +4,7 @@ package flyteidl.service;
4
4
  option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/service";
5
5
 
6
6
  import "google/api/annotations.proto";
7
- import "protoc-gen-swagger/options/annotations.proto";
7
+ // import "protoc-gen-swagger/options/annotations.proto";
8
8
  import "google/protobuf/duration.proto";
9
9
  import "google/protobuf/timestamp.proto";
10
10
  import "flyteidl/core/identifier.proto";
@@ -110,9 +110,9 @@ service DataProxyService {
110
110
  post: "/api/v1/dataproxy/artifact_urn"
111
111
  body: "*"
112
112
  };
113
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
114
- description: "Creates a write-only http location that is accessible for tasks at runtime."
115
- };
113
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
114
+ // description: "Creates a write-only http location that is accessible for tasks at runtime."
115
+ // };
116
116
  }
117
117
 
118
118
  // CreateDownloadLocation creates a signed url to download artifacts.
@@ -121,9 +121,9 @@ service DataProxyService {
121
121
  option (google.api.http) = {
122
122
  get: "/api/v1/dataproxy/artifact_urn"
123
123
  };
124
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
125
- description: "Deprecated: Please use CreateDownloadLink instead. Creates a read-only http location that is accessible for tasks at runtime."
126
- };
124
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
125
+ // description: "Deprecated: Please use CreateDownloadLink instead. Creates a read-only http location that is accessible for tasks at runtime."
126
+ // };
127
127
  }
128
128
 
129
129
  // CreateDownloadLocation creates a signed url to download artifacts.
@@ -132,8 +132,8 @@ service DataProxyService {
132
132
  post: "/api/v1/dataproxy/artifact_link"
133
133
  body: "*"
134
134
  };
135
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
136
- description: "Creates a read-only http location that is accessible for tasks at runtime."
137
- };
135
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
136
+ // description: "Creates a read-only http location that is accessible for tasks at runtime."
137
+ // };
138
138
  }
139
139
  }
package/protos/flyteidl/service/identity.proto CHANGED
@@ -4,7 +4,7 @@ package flyteidl.service;
4
4
  option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/service";
5
5
 
6
6
  import "google/api/annotations.proto";
7
- import "protoc-gen-swagger/options/annotations.proto";
7
+ // import "protoc-gen-swagger/options/annotations.proto";
8
8
 
9
9
  message UserInfoRequest {}
10
10
 
@@ -40,8 +40,8 @@ service IdentityService {
40
40
  option (google.api.http) = {
41
41
  get: "/me"
42
42
  };
43
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
44
- description: "Retrieves authenticated identity info."
45
- };
43
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
44
+ // description: "Retrieves authenticated identity info."
45
+ // };
46
46
  }
47
47
  }
package/protos/flyteidl/service/signal.proto CHANGED
@@ -5,7 +5,7 @@ option go_package = "github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/service";
5
5
 
6
6
  import "google/api/annotations.proto";
7
7
  import "flyteidl/admin/signal.proto";
8
- import "protoc-gen-swagger/options/annotations.proto";
8
+ // import "protoc-gen-swagger/options/annotations.proto";
9
9
 
10
10
  // SignalService defines an RPC Service that may create, update, and retrieve signal(s).
11
11
  service SignalService {
@@ -15,9 +15,9 @@ service SignalService {
15
15
  // a signal, meaning the first call will create the signal and all subsequent calls will
16
16
  // fetch the existing signal. This is only useful during Flyte Workflow execution and therefore
17
17
  // is not exposed to mitigate unintended behavior.
18
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
19
- description: "Retrieve a signal, creating it if it does not exist."
20
- };
18
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
19
+ // description: "Retrieve a signal, creating it if it does not exist."
20
+ // };
21
21
  }
22
22
 
23
23
  // Fetch a list of :ref:`ref_flyteidl.admin.Signal` definitions.
@@ -25,9 +25,9 @@ service SignalService {
25
25
  option (google.api.http) = {
26
26
  get: "/api/v1/signals/{workflow_execution_id.project}/{workflow_execution_id.domain}/{workflow_execution_id.name}"
27
27
  };
28
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
29
- description: "Fetch existing signal definitions matching the input signal id filters."
30
- };
28
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
29
+ // description: "Fetch existing signal definitions matching the input signal id filters."
30
+ // };
31
31
  }
32
32
 
33
33
  // Sets the value on a :ref:`ref_flyteidl.admin.Signal` definition
@@ -36,20 +36,20 @@ service SignalService {
36
36
  post: "/api/v1/signals"
37
37
  body: "*"
38
38
  };
39
- option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
40
- description: "Set a signal value."
41
- responses: {
42
- key: "400"
43
- value: {
44
- description: "Returned for bad request that may have failed validation."
45
- }
46
- }
47
- responses: {
48
- key: "409"
49
- value: {
50
- description: "Returned for a request that references an identical entity that has already been registered."
51
- }
52
- }
53
- };
39
+ // option (grpc.gateway.protoc_gen_swagger.options.openapiv2_operation) = {
40
+ // description: "Set a signal value."
41
+ // responses: {
42
+ // key: "400"
43
+ // value: {
44
+ // description: "Returned for bad request that may have failed validation."
45
+ // }
46
+ // }
47
+ // responses: {
48
+ // key: "409"
49
+ // value: {
50
+ // description: "Returned for a request that references an identical entity that has already been registered."
51
+ // }
52
+ // }
53
+ // };
54
54
  }
55
55
  }