From 276ab1a2aa734adb2fcf9076892a73e7c76667c8 Mon Sep 17 00:00:00 2001 From: Daniel Rammer Date: Mon, 24 Jun 2024 12:09:26 -0500 Subject: [PATCH] improving version docs Signed-off-by: Daniel Rammer --- flyteidl/gen/pb-es/flyteidl/core/execution_envs_pb.ts | 4 +++- flyteidl/gen/pb-go/flyteidl/core/execution_envs.pb.go | 4 +++- .../gen/pb-go/gateway/flyteidl/service/admin.swagger.json | 2 +- flyteidl/gen/pb_rust/flyteidl.core.rs | 4 +++- flyteidl/protos/flyteidl/core/execution_envs.proto | 4 +++- 5 files changed, 13 insertions(+), 5 deletions(-) diff --git a/flyteidl/gen/pb-es/flyteidl/core/execution_envs_pb.ts b/flyteidl/gen/pb-es/flyteidl/core/execution_envs_pb.ts index fb1720d152..3cd2b3c9f7 100644 --- a/flyteidl/gen/pb-es/flyteidl/core/execution_envs_pb.ts +++ b/flyteidl/gen/pb-es/flyteidl/core/execution_envs_pb.ts @@ -109,7 +109,9 @@ export class ExecutionEnv extends Message { } | { case: undefined; value?: undefined } = { case: undefined }; /** - * version is the version of the execution environment. + * version is the version of the execution environment. This may be used differently by each + * individual environment type (ex. auto-generated or manually specificed), but is intended to + * allow variance in environment specifications with the same ID. * * @generated from field: string version = 5; */ diff --git a/flyteidl/gen/pb-go/flyteidl/core/execution_envs.pb.go b/flyteidl/gen/pb-go/flyteidl/core/execution_envs.pb.go index 2cfe8d09e4..46c52870f2 100644 --- a/flyteidl/gen/pb-go/flyteidl/core/execution_envs.pb.go +++ b/flyteidl/gen/pb-go/flyteidl/core/execution_envs.pb.go @@ -107,7 +107,9 @@ type ExecutionEnv struct { // *ExecutionEnv_Extant // *ExecutionEnv_Spec Environment isExecutionEnv_Environment `protobuf_oneof:"environment"` - // version is the version of the execution environment. + // version is the version of the execution environment. This may be used differently by each + // individual environment type (ex. auto-generated or manually specificed), but is intended to + // allow variance in environment specifications with the same ID. Version string `protobuf:"bytes,5,opt,name=version,proto3" json:"version,omitempty"` } diff --git a/flyteidl/gen/pb-go/gateway/flyteidl/service/admin.swagger.json b/flyteidl/gen/pb-go/gateway/flyteidl/service/admin.swagger.json index 0c1dc2e1d7..cbc3a592b2 100644 --- a/flyteidl/gen/pb-go/gateway/flyteidl/service/admin.swagger.json +++ b/flyteidl/gen/pb-go/gateway/flyteidl/service/admin.swagger.json @@ -7094,7 +7094,7 @@ }, "version": { "type": "string", - "description": "version is the version of the execution environment." + "description": "version is the version of the execution environment. This may be used differently by each\nindividual environment type (ex. auto-generated or manually specificed), but is intended to\nallow variance in environment specifications with the same ID." } }, "description": "ExecutionEnv is a message that is used to specify the execution environment." diff --git a/flyteidl/gen/pb_rust/flyteidl.core.rs b/flyteidl/gen/pb_rust/flyteidl.core.rs index 2560b96cd1..75e407ee9b 100644 --- a/flyteidl/gen/pb_rust/flyteidl.core.rs +++ b/flyteidl/gen/pb_rust/flyteidl.core.rs @@ -2971,7 +2971,9 @@ pub struct ExecutionEnv { /// type is the type of the execution environment. #[prost(string, tag="2")] pub r#type: ::prost::alloc::string::String, - /// version is the version of the execution environment. + /// version is the version of the execution environment. This may be used differently by each + /// individual environment type (ex. auto-generated or manually specificed), but is intended to + /// allow variance in environment specifications with the same ID. #[prost(string, tag="5")] pub version: ::prost::alloc::string::String, /// environment is a oneof field that can be used to specify the environment in different ways. diff --git a/flyteidl/protos/flyteidl/core/execution_envs.proto b/flyteidl/protos/flyteidl/core/execution_envs.proto index 9be61db95d..0846b3cd7e 100644 --- a/flyteidl/protos/flyteidl/core/execution_envs.proto +++ b/flyteidl/protos/flyteidl/core/execution_envs.proto @@ -37,6 +37,8 @@ message ExecutionEnv { google.protobuf.Struct spec = 4; } - // version is the version of the execution environment. + // version is the version of the execution environment. This may be used differently by each + // individual environment type (ex. auto-generated or manually specificed), but is intended to + // allow variance in environment specifications with the same ID. string version = 5; }