@flyteorg/flyteidl 0.24.9 → 0.24.12

package/README.md

@@ -1,31 +1,32 @@
-# Flyte IDL
+# Flyteidl
+
+This is one of the core repositories of Flyte. It contains the Specification of the Flyte Language using protobuf messages, the Backend API specification in gRPC, and Swagger REST. The repo contains the generated clients and protocol message structures in multiple languages. Along with the generated code, the repository also contains the Golang clients for Flyte's backend APIs (the services grouped under FlyteAdmin).
 
-This is one of the core repositories of Flyte and contains the Specification of the Flyte Lanugage using protobuf messages, the Backend API specification in gRPC and Swagger REST. The repo contains generated clients and protocol message structures in multiple languages. Along-with the generated code, the repository also contains the Golang clients for Flyte's backend API's (the services grouped under Flyteadmin).
 
 [![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://slack.flyte.org)
 
 * [flyte.org](https://flyte.org)
 * [Flyte Docs](http://docs.flyte.org)
-* [FlyteIDL API reference documentation](https://docs.flyte.org/projects/flyteidl/en/stable/index.html)
+* [Flyteidl API reference documentation](https://docs.flyte.org/projects/flyteidl/en/stable/index.html)
 
-## Contributing to FlyteIDL
+## Contributing to Flyteidl
 
-## Tooling for FlyteIDL
+## Tooling for Flyteidl
 
-1. Run ``make download_tooling`` to install generator dependencies
+1. Run ``make download_tooling`` to install generator dependencies.
 
 ```bash
    make download_tooling
 ```
 
-2. Make sure docker is installed locally.
-3. Once installed, run ``make generate`` to generate all the code and mock client for FlyteAdmin Service aswell as the docs for it.
+2. Ensure Docker is installed locally.
+3. Run ``make generate`` to generate all the code, mock client, and docs for FlyteAdmin Service.
 
 ```bash
     make generate
 ```
 
-4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and then
+4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and run
 
 ```bash
    make doc-requirements.txt
@@ -33,8 +34,8 @@ This is one of the core repositories of Flyte and contains the Specification of
 
 ## Docs structure
 
-The index.rst files for protos are kept in parallel folder structure under the docs folder.
-All the proto definitions are within protos/flyteidl and there corresponding docs are kept in protos/docs
+The index.rst files for protos are arranged in parallel under the ``docs`` folder.
+All the proto definitions are within ``protos/flyteidl`` and their corresponding docs are in ``protos/docs``.
 
 ```
 docs
@@ -58,13 +59,13 @@ docs
 │   └── service.rst
 ```
 
-Each module in protos has same named module under the docs also.
-eg : protos/flyteidl/core has same named doc structure placing it index and other documentation files in protos/docs/core
+Each module in protos has a module in docs with the same name.
+For example: ``protos/flyteidl/core`` has a module ``protos/docs/core`` under the ``docs`` folder which has the corresponding index and documentation files.
 
 
-## Docs Generation
+## Generating Documentation
 
-* If introducing a new module then follow the structure for core files in `generate_protos.sh` file which helps in generating the core documentation from its proto files.
+* If a new module is to be introduced, follow the structure for core files in `generate_protos.sh` file which helps generate the core documentation from its proto files.
 ```
      core_proto_files=`ls protos/flyteidl/core/*.proto |xargs`
      # Remove any currently generated file
@@ -72,7 +73,7 @@ eg : protos/flyteidl/core has same named doc structure placing it index and othe
      protoc --doc_out=protos/docs/core --doc_opt=restructuredtext,core.rst -I=protos `echo $core_proto_files`
 ```
 
-* ``make generate`` would have already generated the modified rst files.
+* ``make generate`` generates the modified rst files.
 
-* ``make html`` Generate the sphinx documentation from the docs folder to use the modified rst for docs.
+* ``make html`` generates the Sphinx documentation from the docs folder that uses the modified rst files.
 

package/gen/pb-js/flyteidl.d.ts

@@ -17092,11 +17092,11 @@ export namespace flyteidl {
             public static verify(message: { [k: string]: any }): (string|null);
         }
 
-        /** Represents a DataProxy */
-        class DataProxy extends $protobuf.rpc.Service {
+        /** Represents a DataProxyService */
+        class DataProxyService extends $protobuf.rpc.Service {
 
             /**
-             * Constructs a new DataProxy service.
+             * Constructs a new DataProxyService service.
              * @param rpcImpl RPC implementation
              * @param [requestDelimited=false] Whether requests are length-delimited
              * @param [responseDelimited=false] Whether responses are length-delimited
@@ -17104,20 +17104,20 @@ export namespace flyteidl {
             constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
 
             /**
-             * Creates new DataProxy service using the specified rpc implementation.
+             * Creates new DataProxyService service using the specified rpc implementation.
              * @param rpcImpl RPC implementation
              * @param [requestDelimited=false] Whether requests are length-delimited
              * @param [responseDelimited=false] Whether responses are length-delimited
              * @returns RPC service. Useful where requests and/or responses are streamed.
              */
-            public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): DataProxy;
+            public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): DataProxyService;
 
             /**
              * Calls CreateUploadLocation.
              * @param request CreateUploadLocationRequest message or plain object
              * @param callback Node-style callback called with the error, if any, and CreateUploadLocationResponse
              */
-            public createUploadLocation(request: flyteidl.service.ICreateUploadLocationRequest, callback: flyteidl.service.DataProxy.CreateUploadLocationCallback): void;
+            public createUploadLocation(request: flyteidl.service.ICreateUploadLocationRequest, callback: flyteidl.service.DataProxyService.CreateUploadLocationCallback): void;
 
             /**
              * Calls CreateUploadLocation.
@@ -17127,10 +17127,10 @@ export namespace flyteidl {
             public createUploadLocation(request: flyteidl.service.ICreateUploadLocationRequest): Promise<flyteidl.service.CreateUploadLocationResponse>;
         }
 
-        namespace DataProxy {
+        namespace DataProxyService {
 
             /**
-             * Callback as used by {@link flyteidl.service.DataProxy#createUploadLocation}.
+             * Callback as used by {@link flyteidl.service.DataProxyService#createUploadLocation}.
              * @param error Error, if any
              * @param [response] CreateUploadLocationResponse
              */

package/gen/pb-js/flyteidl.js

@@ -39820,41 +39820,41 @@ export const flyteidl = $root.flyteidl = (() => {
             return CreateUploadLocationRequest;
         })();
 
-        service.DataProxy = (function() {
+        service.DataProxyService = (function() {
 
             /**
-             * Constructs a new DataProxy service.
+             * Constructs a new DataProxyService service.
              * @memberof flyteidl.service
-             * @classdesc Represents a DataProxy
+             * @classdesc Represents a DataProxyService
              * @extends $protobuf.rpc.Service
              * @constructor
              * @param {$protobuf.RPCImpl} rpcImpl RPC implementation
              * @param {boolean} [requestDelimited=false] Whether requests are length-delimited
              * @param {boolean} [responseDelimited=false] Whether responses are length-delimited
              */
-            function DataProxy(rpcImpl, requestDelimited, responseDelimited) {
+            function DataProxyService(rpcImpl, requestDelimited, responseDelimited) {
                 $protobuf.rpc.Service.call(this, rpcImpl, requestDelimited, responseDelimited);
             }
 
-            (DataProxy.prototype = Object.create($protobuf.rpc.Service.prototype)).constructor = DataProxy;
+            (DataProxyService.prototype = Object.create($protobuf.rpc.Service.prototype)).constructor = DataProxyService;
 
             /**
-             * Creates new DataProxy service using the specified rpc implementation.
+             * Creates new DataProxyService service using the specified rpc implementation.
              * @function create
-             * @memberof flyteidl.service.DataProxy
+             * @memberof flyteidl.service.DataProxyService
              * @static
              * @param {$protobuf.RPCImpl} rpcImpl RPC implementation
              * @param {boolean} [requestDelimited=false] Whether requests are length-delimited
              * @param {boolean} [responseDelimited=false] Whether responses are length-delimited
-             * @returns {DataProxy} RPC service. Useful where requests and/or responses are streamed.
+             * @returns {DataProxyService} RPC service. Useful where requests and/or responses are streamed.
              */
-            DataProxy.create = function create(rpcImpl, requestDelimited, responseDelimited) {
+            DataProxyService.create = function create(rpcImpl, requestDelimited, responseDelimited) {
                 return new this(rpcImpl, requestDelimited, responseDelimited);
             };
 
             /**
-             * Callback as used by {@link flyteidl.service.DataProxy#createUploadLocation}.
-             * @memberof flyteidl.service.DataProxy
+             * Callback as used by {@link flyteidl.service.DataProxyService#createUploadLocation}.
+             * @memberof flyteidl.service.DataProxyService
              * @typedef CreateUploadLocationCallback
              * @type {function}
              * @param {Error|null} error Error, if any
@@ -39864,28 +39864,28 @@ export const flyteidl = $root.flyteidl = (() => {
             /**
              * Calls CreateUploadLocation.
              * @function createUploadLocation
-             * @memberof flyteidl.service.DataProxy
+             * @memberof flyteidl.service.DataProxyService
              * @instance
              * @param {flyteidl.service.ICreateUploadLocationRequest} request CreateUploadLocationRequest message or plain object
-             * @param {flyteidl.service.DataProxy.CreateUploadLocationCallback} callback Node-style callback called with the error, if any, and CreateUploadLocationResponse
+             * @param {flyteidl.service.DataProxyService.CreateUploadLocationCallback} callback Node-style callback called with the error, if any, and CreateUploadLocationResponse
              * @returns {undefined}
              * @variation 1
              */
-            Object.defineProperty(DataProxy.prototype.createUploadLocation = function createUploadLocation(request, callback) {
+            Object.defineProperty(DataProxyService.prototype.createUploadLocation = function createUploadLocation(request, callback) {
                 return this.rpcCall(createUploadLocation, $root.flyteidl.service.CreateUploadLocationRequest, $root.flyteidl.service.CreateUploadLocationResponse, request, callback);
             }, "name", { value: "CreateUploadLocation" });
 
             /**
              * Calls CreateUploadLocation.
              * @function createUploadLocation
-             * @memberof flyteidl.service.DataProxy
+             * @memberof flyteidl.service.DataProxyService
              * @instance
              * @param {flyteidl.service.ICreateUploadLocationRequest} request CreateUploadLocationRequest message or plain object
              * @returns {Promise<flyteidl.service.CreateUploadLocationResponse>} Promise
              * @variation 2
              */
 
-            return DataProxy;
+            return DataProxyService;
         })();
 
         service.UserInfoRequest = (function() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flyteorg/flyteidl",
-  "version": "0.24.9",
+  "version": "0.24.12",
   "description": "Compiled protocol buffers and gRPC service clients/servers for Flyte IDLs",
   "repository": {
     "type": "git",

package/protos/docs/admin/index.rst

@@ -1,9 +1,8 @@
 Flyte Admin Service entities
 ============================
 
-These are the control plane entities that can be used to communication with the
-Flyte Admin service over gRPC or REST. The endpoint specification is defined in the
-
+These are the control plane entities that can be used to communicate with the
+FlyteAdmin service over gRPC or REST. The endpoint specification is defined in the
 `Admin raw protos <https://github.com/flyteorg/flyteidl/blob/master/protos/flyteidl/admin>`__
 
 .. toctree::

package/protos/docs/core/index.rst

@@ -1,9 +1,9 @@
 Core Flyte language specification
 =================================
 
-These set of protocol buffers provides details of some of the core data
-structures like Workflows, Tasks, Nodes, Literals. These are the specification
-of the various entities in Flyte as well as the type system.
+Protocol buffers provide details about core data
+structures like :ref:`workflows <divedeep-workflows>`, :ref:`tasks <divedeep-tasks>`, :ref:`nodes <divedeep-nodes>`, and Literals. They are the specifications
+of the various entities in Flyte and the type system.
 
 `Core raw protos <https://github.com/flyteorg/flyteidl/blob/master/protos/flyteidl/core>`__
 

package/protos/docs/datacatalog/index.rst

@@ -1,10 +1,10 @@
 Flyte Data Catalog Service
-=================================
+============================
 
-These protos provide the interface definition for the Data Catalog Service. Data Catalog is a service for
-indexing parameterized, strongly-typed data artifacts across revisions. It is used in the Flyte ecosystem
-to catalog artifacts generated by task executions. Outputs generated by a task can be stored as artifact
-data and tagged by the user so that it can be retrieved later by that tag.
+Protos provides the interface definition for the Data Catalog Service. Data Catalog is a service to
+index parameterized, strongly-typed data artifacts across revisions. It is used in the Flyte ecosystem
+to catalog artifacts generated by the task executions. The output generated by a task can be stored as artifact
+data and tagged by the user so as to be retrieved later by that tag.
 
 `Datacatalog raw proto <https://github.com/flyteorg/flyteidl/blob/master/protos/flyteidl/datacatalog/datacatalog.proto>`__
 

package/protos/docs/event/index.rst

@@ -9,14 +9,13 @@ External Eventing system.
 Flyte Internal Eventing
 ========================
 
-This is the interface used by the dataplane (execution engine) to communicate
-workflow and task progress back to the **control plane** admin service.
+This is the interface used by the dataplane (execution engine) to communicate with the control plane admin service about the workflow and task progress.
 
 Flyte External Eventing - Event Egress
 =======================================
 
-This refers to the interface for all the event messages exiting from the Flyte
-**control plane** and delivered on the configured pubsub channel.
+This refers to the interface for all the event messages leaving the Flyte
+**control plane** and reaching on the configured pubsub channel.
 
 `Event raw proto <https://github.com/flyteorg/flyteidl/blob/master/protos/flyteidl/event/event.proto>`__
 

package/protos/docs/plugins/plugins.rst

@@ -0,0 +1,549 @@
+######################
+Protocol Documentation
+######################
+
+
+
+
+.. _ref_flyteidl/plugins/array_job.proto:
+
+flyteidl/plugins/array_job.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.plugins.ArrayJob:
+
+ArrayJob
+------------------------------------------------------------------
+
+Describes a job that can process independent pieces of data concurrently. Multiple copies of the runnable component
+will be executed concurrently.
+
+
+
+.. csv-table:: ArrayJob type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "parallelism", ":ref:`ref_int64`", "", "Defines the minimum number of instances to bring up concurrently at any given point. Note that this is an optimistic restriction and that, due to network partitioning or other failures, the actual number of currently running instances might be more. This has to be a positive number if assigned. Default value is size."
+   "size", ":ref:`ref_int64`", "", "Defines the number of instances to launch at most. This number should match the size of the input if the job requires processing of all input data. This has to be a positive number. In the case this is not defined, the back-end will determine the size at run-time by reading the inputs."
+   "min_successes", ":ref:`ref_int64`", "", "An absolute number of the minimum number of successful completions of subtasks. As soon as this criteria is met, the array job will be marked as successful and outputs will be computed. This has to be a non-negative number if assigned. Default value is size (if specified)."
+   "min_success_ratio", ":ref:`ref_float`", "", "If the array job size is not known beforehand, the min_success_ratio can instead be used to determine when an array job can be marked successful."
+
+
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+ <!-- end services -->
+
+
+
+
+.. _ref_flyteidl/plugins/mpi.proto:
+
+flyteidl/plugins/mpi.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.plugins.DistributedMPITrainingTask:
+
+DistributedMPITrainingTask
+------------------------------------------------------------------
+
+MPI operator proposal https://github.com/kubeflow/community/blob/master/proposals/mpi-operator-proposal.md
+Custom proto for plugin that enables distributed training using https://github.com/kubeflow/mpi-operator
+
+
+
+.. csv-table:: DistributedMPITrainingTask type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "num_workers", ":ref:`ref_int32`", "", "number of worker spawned in the cluster for this job"
+   "num_launcher_replicas", ":ref:`ref_int32`", "", "number of launcher replicas spawned in the cluster for this job The launcher pod invokes mpirun and communicates with worker pods through MPI."
+   "slots", ":ref:`ref_int32`", "", "number of slots per worker used in hostfile. The available slots (GPUs) in each pod."
+
+
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+ <!-- end services -->
+
+
+
+
+.. _ref_flyteidl/plugins/presto.proto:
+
+flyteidl/plugins/presto.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.plugins.PrestoQuery:
+
+PrestoQuery
+------------------------------------------------------------------
+
+This message works with the 'presto' task type in the SDK and is the object that will be in the 'custom' field
+of a Presto task's TaskTemplate
+
+
+
+.. csv-table:: PrestoQuery type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "routing_group", ":ref:`ref_string`", "", ""
+   "catalog", ":ref:`ref_string`", "", ""
+   "schema", ":ref:`ref_string`", "", ""
+   "statement", ":ref:`ref_string`", "", ""
+
+
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+ <!-- end services -->
+
+
+
+
+.. _ref_flyteidl/plugins/pytorch.proto:
+
+flyteidl/plugins/pytorch.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.plugins.DistributedPyTorchTrainingTask:
+
+DistributedPyTorchTrainingTask
+------------------------------------------------------------------
+
+Custom proto for plugin that enables distributed training using https://github.com/kubeflow/pytorch-operator
+
+
+
+.. csv-table:: DistributedPyTorchTrainingTask type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "workers", ":ref:`ref_int32`", "", "number of worker replicas spawned in the cluster for this job"
+
+
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+ <!-- end services -->
+
+
+
+
+.. _ref_flyteidl/plugins/qubole.proto:
+
+flyteidl/plugins/qubole.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.plugins.HiveQuery:
+
+HiveQuery
+------------------------------------------------------------------
+
+Defines a query to execute on a hive cluster.
+
+
+
+.. csv-table:: HiveQuery type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "query", ":ref:`ref_string`", "", ""
+   "timeout_sec", ":ref:`ref_uint32`", "", ""
+   "retryCount", ":ref:`ref_uint32`", "", ""
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.HiveQueryCollection:
+
+HiveQueryCollection
+------------------------------------------------------------------
+
+Defines a collection of hive queries.
+
+
+
+.. csv-table:: HiveQueryCollection type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "queries", ":ref:`ref_flyteidl.plugins.HiveQuery`", "repeated", ""
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.QuboleHiveJob:
+
+QuboleHiveJob
+------------------------------------------------------------------
+
+This message works with the 'hive' task type in the SDK and is the object that will be in the 'custom' field
+of a hive task's TaskTemplate
+
+
+
+.. csv-table:: QuboleHiveJob type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "cluster_label", ":ref:`ref_string`", "", ""
+   "query_collection", ":ref:`ref_flyteidl.plugins.HiveQueryCollection`", "", "**Deprecated.** "
+   "tags", ":ref:`ref_string`", "repeated", ""
+   "query", ":ref:`ref_flyteidl.plugins.HiveQuery`", "", ""
+
+
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+ <!-- end services -->
+
+
+
+
+.. _ref_flyteidl/plugins/sidecar.proto:
+
+flyteidl/plugins/sidecar.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.plugins.SidecarJob:
+
+SidecarJob
+------------------------------------------------------------------
+
+A sidecar job brings up the desired pod_spec.
+The plugin executor is responsible for keeping the pod alive until the primary container terminates
+or the task itself times out.
+
+
+
+.. csv-table:: SidecarJob type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "pod_spec", ":ref:`ref_k8s.io.api.core.v1.PodSpec`", "", ""
+   "primary_container_name", ":ref:`ref_string`", "", ""
+   "annotations", ":ref:`ref_flyteidl.plugins.SidecarJob.AnnotationsEntry`", "repeated", "Pod annotations"
+   "labels", ":ref:`ref_flyteidl.plugins.SidecarJob.LabelsEntry`", "repeated", "Pod labels"
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.SidecarJob.AnnotationsEntry:
+
+SidecarJob.AnnotationsEntry
+------------------------------------------------------------------
+
+
+
+
+
+.. csv-table:: SidecarJob.AnnotationsEntry type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "key", ":ref:`ref_string`", "", ""
+   "value", ":ref:`ref_string`", "", ""
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.SidecarJob.LabelsEntry:
+
+SidecarJob.LabelsEntry
+------------------------------------------------------------------
+
+
+
+
+
+.. csv-table:: SidecarJob.LabelsEntry type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "key", ":ref:`ref_string`", "", ""
+   "value", ":ref:`ref_string`", "", ""
+
+
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+ <!-- end services -->
+
+
+
+
+.. _ref_flyteidl/plugins/spark.proto:
+
+flyteidl/plugins/spark.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.plugins.SparkApplication:
+
+SparkApplication
+------------------------------------------------------------------
+
+
+
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.SparkJob:
+
+SparkJob
+------------------------------------------------------------------
+
+Custom Proto for Spark Plugin.
+
+
+
+.. csv-table:: SparkJob type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "applicationType", ":ref:`ref_flyteidl.plugins.SparkApplication.Type`", "", ""
+   "mainApplicationFile", ":ref:`ref_string`", "", ""
+   "mainClass", ":ref:`ref_string`", "", ""
+   "sparkConf", ":ref:`ref_flyteidl.plugins.SparkJob.SparkConfEntry`", "repeated", ""
+   "hadoopConf", ":ref:`ref_flyteidl.plugins.SparkJob.HadoopConfEntry`", "repeated", ""
+   "executorPath", ":ref:`ref_string`", "", "Executor path for Python jobs."
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.SparkJob.HadoopConfEntry:
+
+SparkJob.HadoopConfEntry
+------------------------------------------------------------------
+
+
+
+
+
+.. csv-table:: SparkJob.HadoopConfEntry type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "key", ":ref:`ref_string`", "", ""
+   "value", ":ref:`ref_string`", "", ""
+
+
+
+
+
+
+
+.. _ref_flyteidl.plugins.SparkJob.SparkConfEntry:
+
+SparkJob.SparkConfEntry
+------------------------------------------------------------------
+
+
+
+
+
+.. csv-table:: SparkJob.SparkConfEntry type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "key", ":ref:`ref_string`", "", ""
+   "value", ":ref:`ref_string`", "", ""
+
+
+
+
+
+ <!-- end messages -->
+
+
+
+.. _ref_flyteidl.plugins.SparkApplication.Type:
+
+SparkApplication.Type
+------------------------------------------------------------------
+
+
+
+.. csv-table:: Enum SparkApplication.Type values
+   :header: "Name", "Number", "Description"
+   :widths: auto
+
+   "PYTHON", "0", ""
+   "JAVA", "1", ""
+   "SCALA", "2", ""
+   "R", "3", ""
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+ <!-- end services -->
+
+
+
+
+.. _ref_flyteidl/plugins/tensorflow.proto:
+
+flyteidl/plugins/tensorflow.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.plugins.DistributedTensorflowTrainingTask:
+
+DistributedTensorflowTrainingTask
+------------------------------------------------------------------
+
+Custom proto for plugin that enables distributed training using https://github.com/kubeflow/tf-operator
+
+
+
+.. csv-table:: DistributedTensorflowTrainingTask type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "workers", ":ref:`ref_int32`", "", "number of worker, ps, chief replicas spawned in the cluster for this job"
+   "ps_replicas", ":ref:`ref_int32`", "", "PS -> Parameter server"
+   "chief_replicas", ":ref:`ref_int32`", "", ""
+
+
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+ <!-- end services -->
+
+
+
+
+.. _ref_flyteidl/plugins/waitable.proto:
+
+flyteidl/plugins/waitable.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.plugins.Waitable:
+
+Waitable
+------------------------------------------------------------------
+
+Represents an Execution that was launched and could be waited on.
+
+
+
+.. csv-table:: Waitable type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "wf_exec_id", ":ref:`ref_flyteidl.core.WorkflowExecutionIdentifier`", "", ""
+   "phase", ":ref:`ref_flyteidl.core.WorkflowExecution.Phase`", "", ""
+   "workflow_id", ":ref:`ref_string`", "", ""
+
+
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+ <!-- end services -->
+
+

package/protos/docs/service/service.rst

@@ -0,0 +1,353 @@
+######################
+Protocol Documentation
+######################
+
+
+
+
+.. _ref_flyteidl/service/admin.proto:
+
+flyteidl/service/admin.proto
+==================================================================
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+
+
+.. _ref_flyteidl.service.AdminService:
+
+AdminService
+------------------------------------------------------------------
+
+The following defines an RPC service that is also served over HTTP via grpc-gateway.
+Standard response codes for both are defined here: https://github.com/grpc-ecosystem/grpc-gateway/blob/master/runtime/errors.go
+
+.. csv-table:: AdminService service methods
+   :header: "Method Name", "Request Type", "Response Type", "Description"
+   :widths: auto
+
+   "CreateTask", ":ref:`ref_flyteidl.admin.TaskCreateRequest`", ":ref:`ref_flyteidl.admin.TaskCreateResponse`", "Create and upload a :ref:`ref_flyteidl.admin.Task` definition"
+   "GetTask", ":ref:`ref_flyteidl.admin.ObjectGetRequest`", ":ref:`ref_flyteidl.admin.Task`", "Fetch a :ref:`ref_flyteidl.admin.Task` definition."
+   "ListTaskIds", ":ref:`ref_flyteidl.admin.NamedEntityIdentifierListRequest`", ":ref:`ref_flyteidl.admin.NamedEntityIdentifierList`", "Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of task objects."
+   "ListTasks", ":ref:`ref_flyteidl.admin.ResourceListRequest`", ":ref:`ref_flyteidl.admin.TaskList`", "Fetch a list of :ref:`ref_flyteidl.admin.Task` definitions."
+   "CreateWorkflow", ":ref:`ref_flyteidl.admin.WorkflowCreateRequest`", ":ref:`ref_flyteidl.admin.WorkflowCreateResponse`", "Create and upload a :ref:`ref_flyteidl.admin.Workflow` definition"
+   "GetWorkflow", ":ref:`ref_flyteidl.admin.ObjectGetRequest`", ":ref:`ref_flyteidl.admin.Workflow`", "Fetch a :ref:`ref_flyteidl.admin.Workflow` definition."
+   "ListWorkflowIds", ":ref:`ref_flyteidl.admin.NamedEntityIdentifierListRequest`", ":ref:`ref_flyteidl.admin.NamedEntityIdentifierList`", "Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of workflow objects."
+   "ListWorkflows", ":ref:`ref_flyteidl.admin.ResourceListRequest`", ":ref:`ref_flyteidl.admin.WorkflowList`", "Fetch a list of :ref:`ref_flyteidl.admin.Workflow` definitions."
+   "CreateLaunchPlan", ":ref:`ref_flyteidl.admin.LaunchPlanCreateRequest`", ":ref:`ref_flyteidl.admin.LaunchPlanCreateResponse`", "Create and upload a :ref:`ref_flyteidl.admin.LaunchPlan` definition"
+   "GetLaunchPlan", ":ref:`ref_flyteidl.admin.ObjectGetRequest`", ":ref:`ref_flyteidl.admin.LaunchPlan`", "Fetch a :ref:`ref_flyteidl.admin.LaunchPlan` definition."
+   "GetActiveLaunchPlan", ":ref:`ref_flyteidl.admin.ActiveLaunchPlanRequest`", ":ref:`ref_flyteidl.admin.LaunchPlan`", "Fetch the active version of a :ref:`ref_flyteidl.admin.LaunchPlan`."
+   "ListActiveLaunchPlans", ":ref:`ref_flyteidl.admin.ActiveLaunchPlanListRequest`", ":ref:`ref_flyteidl.admin.LaunchPlanList`", "List active versions of :ref:`ref_flyteidl.admin.LaunchPlan`."
+   "ListLaunchPlanIds", ":ref:`ref_flyteidl.admin.NamedEntityIdentifierListRequest`", ":ref:`ref_flyteidl.admin.NamedEntityIdentifierList`", "Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of launch plan objects."
+   "ListLaunchPlans", ":ref:`ref_flyteidl.admin.ResourceListRequest`", ":ref:`ref_flyteidl.admin.LaunchPlanList`", "Fetch a list of :ref:`ref_flyteidl.admin.LaunchPlan` definitions."
+   "UpdateLaunchPlan", ":ref:`ref_flyteidl.admin.LaunchPlanUpdateRequest`", ":ref:`ref_flyteidl.admin.LaunchPlanUpdateResponse`", "Updates the status of a registered :ref:`ref_flyteidl.admin.LaunchPlan`."
+   "CreateExecution", ":ref:`ref_flyteidl.admin.ExecutionCreateRequest`", ":ref:`ref_flyteidl.admin.ExecutionCreateResponse`", "Triggers the creation of a :ref:`ref_flyteidl.admin.Execution`"
+   "RelaunchExecution", ":ref:`ref_flyteidl.admin.ExecutionRelaunchRequest`", ":ref:`ref_flyteidl.admin.ExecutionCreateResponse`", "Triggers the creation of an identical :ref:`ref_flyteidl.admin.Execution`"
+   "RecoverExecution", ":ref:`ref_flyteidl.admin.ExecutionRecoverRequest`", ":ref:`ref_flyteidl.admin.ExecutionCreateResponse`", "Recreates a previously-run workflow execution that will only start executing from the last known failure point. In Recover mode, users cannot change any input parameters or update the version of the execution. This is extremely useful to recover from system errors and byzantine faults like - Loss of K8s cluster, bugs in platform or instability, machine failures, downstream system failures (downstream services), or simply to recover executions that failed because of retry exhaustion and should complete if tried again. See :ref:`ref_flyteidl.admin.ExecutionRecoverRequest` for more details."
+   "GetExecution", ":ref:`ref_flyteidl.admin.WorkflowExecutionGetRequest`", ":ref:`ref_flyteidl.admin.Execution`", "Fetches a :ref:`ref_flyteidl.admin.Execution`."
+   "UpdateExecution", ":ref:`ref_flyteidl.admin.ExecutionUpdateRequest`", ":ref:`ref_flyteidl.admin.ExecutionUpdateResponse`", "Update execution belonging to project domain :ref:`ref_flyteidl.admin.Execution`."
+   "GetExecutionData", ":ref:`ref_flyteidl.admin.WorkflowExecutionGetDataRequest`", ":ref:`ref_flyteidl.admin.WorkflowExecutionGetDataResponse`", "Fetches input and output data for a :ref:`ref_flyteidl.admin.Execution`."
+   "ListExecutions", ":ref:`ref_flyteidl.admin.ResourceListRequest`", ":ref:`ref_flyteidl.admin.ExecutionList`", "Fetch a list of :ref:`ref_flyteidl.admin.Execution`."
+   "TerminateExecution", ":ref:`ref_flyteidl.admin.ExecutionTerminateRequest`", ":ref:`ref_flyteidl.admin.ExecutionTerminateResponse`", "Terminates an in-progress :ref:`ref_flyteidl.admin.Execution`."
+   "GetNodeExecution", ":ref:`ref_flyteidl.admin.NodeExecutionGetRequest`", ":ref:`ref_flyteidl.admin.NodeExecution`", "Fetches a :ref:`ref_flyteidl.admin.NodeExecution`."
+   "ListNodeExecutions", ":ref:`ref_flyteidl.admin.NodeExecutionListRequest`", ":ref:`ref_flyteidl.admin.NodeExecutionList`", "Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution`."
+   "ListNodeExecutionsForTask", ":ref:`ref_flyteidl.admin.NodeExecutionForTaskListRequest`", ":ref:`ref_flyteidl.admin.NodeExecutionList`", "Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution` launched by the reference :ref:`ref_flyteidl.admin.TaskExecution`."
+   "GetNodeExecutionData", ":ref:`ref_flyteidl.admin.NodeExecutionGetDataRequest`", ":ref:`ref_flyteidl.admin.NodeExecutionGetDataResponse`", "Fetches input and output data for a :ref:`ref_flyteidl.admin.NodeExecution`."
+   "RegisterProject", ":ref:`ref_flyteidl.admin.ProjectRegisterRequest`", ":ref:`ref_flyteidl.admin.ProjectRegisterResponse`", "Registers a :ref:`ref_flyteidl.admin.Project` with the Flyte deployment."
+   "UpdateProject", ":ref:`ref_flyteidl.admin.Project`", ":ref:`ref_flyteidl.admin.ProjectUpdateResponse`", "Updates an existing :ref:`ref_flyteidl.admin.Project` flyteidl.admin.Project should be passed but the domains property should be empty; it will be ignored in the handler as domains cannot be updated via this API."
+   "ListProjects", ":ref:`ref_flyteidl.admin.ProjectListRequest`", ":ref:`ref_flyteidl.admin.Projects`", "Fetches a list of :ref:`ref_flyteidl.admin.Project`"
+   "CreateWorkflowEvent", ":ref:`ref_flyteidl.admin.WorkflowExecutionEventRequest`", ":ref:`ref_flyteidl.admin.WorkflowExecutionEventResponse`", "Indicates a :ref:`ref_flyteidl.event.WorkflowExecutionEvent` has occurred."
+   "CreateNodeEvent", ":ref:`ref_flyteidl.admin.NodeExecutionEventRequest`", ":ref:`ref_flyteidl.admin.NodeExecutionEventResponse`", "Indicates a :ref:`ref_flyteidl.event.NodeExecutionEvent` has occurred."
+   "CreateTaskEvent", ":ref:`ref_flyteidl.admin.TaskExecutionEventRequest`", ":ref:`ref_flyteidl.admin.TaskExecutionEventResponse`", "Indicates a :ref:`ref_flyteidl.event.TaskExecutionEvent` has occurred."
+   "GetTaskExecution", ":ref:`ref_flyteidl.admin.TaskExecutionGetRequest`", ":ref:`ref_flyteidl.admin.TaskExecution`", "Fetches a :ref:`ref_flyteidl.admin.TaskExecution`."
+   "ListTaskExecutions", ":ref:`ref_flyteidl.admin.TaskExecutionListRequest`", ":ref:`ref_flyteidl.admin.TaskExecutionList`", "Fetches a list of :ref:`ref_flyteidl.admin.TaskExecution`."
+   "GetTaskExecutionData", ":ref:`ref_flyteidl.admin.TaskExecutionGetDataRequest`", ":ref:`ref_flyteidl.admin.TaskExecutionGetDataResponse`", "Fetches input and output data for a :ref:`ref_flyteidl.admin.TaskExecution`."
+   "UpdateProjectDomainAttributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributesUpdateRequest`", ":ref:`ref_flyteidl.admin.ProjectDomainAttributesUpdateResponse`", "Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain."
+   "GetProjectDomainAttributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributesGetRequest`", ":ref:`ref_flyteidl.admin.ProjectDomainAttributesGetResponse`", "Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain."
+   "DeleteProjectDomainAttributes", ":ref:`ref_flyteidl.admin.ProjectDomainAttributesDeleteRequest`", ":ref:`ref_flyteidl.admin.ProjectDomainAttributesDeleteResponse`", "Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain."
+   "UpdateWorkflowAttributes", ":ref:`ref_flyteidl.admin.WorkflowAttributesUpdateRequest`", ":ref:`ref_flyteidl.admin.WorkflowAttributesUpdateResponse`", "Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow."
+   "GetWorkflowAttributes", ":ref:`ref_flyteidl.admin.WorkflowAttributesGetRequest`", ":ref:`ref_flyteidl.admin.WorkflowAttributesGetResponse`", "Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow."
+   "DeleteWorkflowAttributes", ":ref:`ref_flyteidl.admin.WorkflowAttributesDeleteRequest`", ":ref:`ref_flyteidl.admin.WorkflowAttributesDeleteResponse`", "Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow."
+   "ListMatchableAttributes", ":ref:`ref_flyteidl.admin.ListMatchableAttributesRequest`", ":ref:`ref_flyteidl.admin.ListMatchableAttributesResponse`", "Lists custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a specific resource type."
+   "ListNamedEntities", ":ref:`ref_flyteidl.admin.NamedEntityListRequest`", ":ref:`ref_flyteidl.admin.NamedEntityList`", "Returns a list of :ref:`ref_flyteidl.admin.NamedEntity` objects."
+   "GetNamedEntity", ":ref:`ref_flyteidl.admin.NamedEntityGetRequest`", ":ref:`ref_flyteidl.admin.NamedEntity`", "Returns a :ref:`ref_flyteidl.admin.NamedEntity` object."
+   "UpdateNamedEntity", ":ref:`ref_flyteidl.admin.NamedEntityUpdateRequest`", ":ref:`ref_flyteidl.admin.NamedEntityUpdateResponse`", "Updates a :ref:`ref_flyteidl.admin.NamedEntity` object."
+   "GetVersion", ":ref:`ref_flyteidl.admin.GetVersionRequest`", ":ref:`ref_flyteidl.admin.GetVersionResponse`", ""
+ <!-- end services -->
+
+
+
+
+.. _ref_flyteidl/service/auth.proto:
+
+flyteidl/service/auth.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.service.OAuth2MetadataRequest:
+
+OAuth2MetadataRequest
+------------------------------------------------------------------
+
+
+
+
+
+
+
+
+
+
+.. _ref_flyteidl.service.OAuth2MetadataResponse:
+
+OAuth2MetadataResponse
+------------------------------------------------------------------
+
+OAuth2MetadataResponse defines an RFC-Compliant response for /.well-known/oauth-authorization-server metadata
+as defined in https://tools.ietf.org/html/rfc8414
+
+
+
+.. csv-table:: OAuth2MetadataResponse type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "issuer", ":ref:`ref_string`", "", "Defines the issuer string in all JWT tokens this server issues. The issuer can be admin itself or an external issuer."
+   "authorization_endpoint", ":ref:`ref_string`", "", "URL of the authorization server's authorization endpoint [RFC6749]. This is REQUIRED unless no grant types are supported that use the authorization endpoint."
+   "token_endpoint", ":ref:`ref_string`", "", "URL of the authorization server's token endpoint [RFC6749]."
+   "response_types_supported", ":ref:`ref_string`", "repeated", "Array containing a list of the OAuth 2.0 response_type values that this authorization server supports."
+   "scopes_supported", ":ref:`ref_string`", "repeated", "JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this authorization server supports."
+   "token_endpoint_auth_methods_supported", ":ref:`ref_string`", "repeated", "JSON array containing a list of client authentication methods supported by this token endpoint."
+   "jwks_uri", ":ref:`ref_string`", "", "URL of the authorization server's JWK Set [JWK] document. The referenced document contains the signing key(s) the client uses to validate signatures from the authorization server."
+   "code_challenge_methods_supported", ":ref:`ref_string`", "repeated", "JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported by this authorization server."
+   "grant_types_supported", ":ref:`ref_string`", "repeated", "JSON array containing a list of the OAuth 2.0 grant type values that this authorization server supports."
+
+
+
+
+
+
+
+.. _ref_flyteidl.service.PublicClientAuthConfigRequest:
+
+PublicClientAuthConfigRequest
+------------------------------------------------------------------
+
+
+
+
+
+
+
+
+
+
+.. _ref_flyteidl.service.PublicClientAuthConfigResponse:
+
+PublicClientAuthConfigResponse
+------------------------------------------------------------------
+
+FlyteClientResponse encapsulates public information that flyte clients (CLIs... etc.) can use to authenticate users.
+
+
+
+.. csv-table:: PublicClientAuthConfigResponse type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "client_id", ":ref:`ref_string`", "", "client_id to use when initiating OAuth2 authorization requests."
+   "redirect_uri", ":ref:`ref_string`", "", "redirect uri to use when initiating OAuth2 authorization requests."
+   "scopes", ":ref:`ref_string`", "repeated", "scopes to request when initiating OAuth2 authorization requests."
+   "authorization_metadata_key", ":ref:`ref_string`", "", "Authorization Header to use when passing Access Tokens to the server. If not provided, the client should use the default http `Authorization` header."
+
+
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+
+
+.. _ref_flyteidl.service.AuthMetadataService:
+
+AuthMetadataService
+------------------------------------------------------------------
+
+The following defines an RPC service that is also served over HTTP via grpc-gateway.
+Standard response codes for both are defined here: https://github.com/grpc-ecosystem/grpc-gateway/blob/master/runtime/errors.go
+RPCs defined in this service must be anonymously accessible.
+
+.. csv-table:: AuthMetadataService service methods
+   :header: "Method Name", "Request Type", "Response Type", "Description"
+   :widths: auto
+
+   "GetOAuth2Metadata", ":ref:`ref_flyteidl.service.OAuth2MetadataRequest`", ":ref:`ref_flyteidl.service.OAuth2MetadataResponse`", "Anonymously accessible. Retrieves local or external oauth authorization server metadata."
+   "GetPublicClientConfig", ":ref:`ref_flyteidl.service.PublicClientAuthConfigRequest`", ":ref:`ref_flyteidl.service.PublicClientAuthConfigResponse`", "Anonymously accessible. Retrieves the client information clients should use when initiating OAuth2 authorization requests."
+ <!-- end services -->
+
+
+
+
+.. _ref_flyteidl/service/dataproxy.proto:
+
+flyteidl/service/dataproxy.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.service.CreateUploadLocationRequest:
+
+CreateUploadLocationRequest
+------------------------------------------------------------------
+
+CreateUploadLocationRequest specified request for the CreateUploadLocation API.
+
+
+
+.. csv-table:: CreateUploadLocationRequest type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "project", ":ref:`ref_string`", "", "Project to create the upload location for +required"
+   "domain", ":ref:`ref_string`", "", "Domain to create the upload location for. +required"
+   "suffix", ":ref:`ref_string`", "", "Suffix specifies a desired suffix for the generated location. E.g. `/file.py` or `pre/fix/file.zip`. +optional. By default, the service will generate a random file name."
+   "expires_in", ":ref:`ref_google.protobuf.Duration`", "", "ExpiresIn defines a requested expiration duration for the generated url. The request will be rejected if this exceeds the platform allowed max. +optional. The default value comes from a global config."
+
+
+
+
+
+
+
+.. _ref_flyteidl.service.CreateUploadLocationResponse:
+
+CreateUploadLocationResponse
+------------------------------------------------------------------
+
+
+
+
+
+.. csv-table:: CreateUploadLocationResponse type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "signed_url", ":ref:`ref_string`", "", "SignedUrl specifies the url to use to upload content to (e.g. https://my-bucket.s3.amazonaws.com/randomstring/suffix.tar?X-...)"
+   "native_url", ":ref:`ref_string`", "", "NativeUrl specifies the url in the format of the configured storage provider (e.g. s3://my-bucket/randomstring/suffix.tar)"
+   "expires_at", ":ref:`ref_google.protobuf.Timestamp`", "", "ExpiresAt defines when will the signed URL expires."
+
+
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+
+
+.. _ref_flyteidl.service.DataProxyService:
+
+DataProxyService
+------------------------------------------------------------------
+
+DataProxyService defines an RPC Service that allows access to user-data in a controlled manner.
+
+.. csv-table:: DataProxyService service methods
+   :header: "Method Name", "Request Type", "Response Type", "Description"
+   :widths: auto
+
+   "CreateUploadLocation", ":ref:`ref_flyteidl.service.CreateUploadLocationRequest`", ":ref:`ref_flyteidl.service.CreateUploadLocationResponse`", "CreateUploadLocation creates a signed url to upload artifacts to for a given project/domain."
+ <!-- end services -->
+
+
+
+
+.. _ref_flyteidl/service/identity.proto:
+
+flyteidl/service/identity.proto
+==================================================================
+
+
+
+
+
+.. _ref_flyteidl.service.UserInfoRequest:
+
+UserInfoRequest
+------------------------------------------------------------------
+
+
+
+
+
+
+
+
+
+
+.. _ref_flyteidl.service.UserInfoResponse:
+
+UserInfoResponse
+------------------------------------------------------------------
+
+See the OpenID Connect spec at https://openid.net/specs/openid-connect-core-1_0.html#UserInfoResponse for more information.
+
+
+
+.. csv-table:: UserInfoResponse type fields
+   :header: "Field", "Type", "Label", "Description"
+   :widths: auto
+
+   "subject", ":ref:`ref_string`", "", "Locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed by the Client."
+   "name", ":ref:`ref_string`", "", "Full name"
+   "preferred_username", ":ref:`ref_string`", "", "Shorthand name by which the End-User wishes to be referred to"
+   "given_name", ":ref:`ref_string`", "", "Given name(s) or first name(s)"
+   "family_name", ":ref:`ref_string`", "", "Surname(s) or last name(s)"
+   "email", ":ref:`ref_string`", "", "Preferred e-mail address"
+   "picture", ":ref:`ref_string`", "", "Profile picture URL"
+
+
+
+
+
+ <!-- end messages -->
+
+ <!-- end enums -->
+
+ <!-- end HasExtensions -->
+
+
+
+.. _ref_flyteidl.service.IdentityService:
+
+IdentityService
+------------------------------------------------------------------
+
+IdentityService defines an RPC Service that interacts with user/app identities.
+
+.. csv-table:: IdentityService service methods
+   :header: "Method Name", "Request Type", "Response Type", "Description"
+   :widths: auto
+
+   "UserInfo", ":ref:`ref_flyteidl.service.UserInfoRequest`", ":ref:`ref_flyteidl.service.UserInfoResponse`", "Retrieves user information about the currently logged in user."
+ <!-- end services -->
+
+

package/protos/flyteidl/service/dataproxy.proto

@@ -39,9 +39,9 @@ message CreateUploadLocationRequest {
   google.protobuf.Duration expires_in = 4;
 }
 
-// DataProxy defines an RPC Service that allows access to user-data in a controlled manner.
-service DataProxy {
-  // Retrieves user information about the currently logged in user.
+// DataProxyService defines an RPC Service that allows access to user-data in a controlled manner.
+service DataProxyService {
+  // CreateUploadLocation creates a signed url to upload artifacts to for a given project/domain.
   rpc CreateUploadLocation (CreateUploadLocationRequest) returns (CreateUploadLocationResponse) {
     option (google.api.http) = {
       post: "/api/v1/dataproxy/artifact_urn"