Add description field in task and trigger protos

flyteidl2/task/environment.proto

@@ -13,4 +13,7 @@ message Environment {
     (buf.validate.field).string.min_len = 1,
     (buf.validate.field).string.max_len = 63
   ];
+
+  // Description of environment
+  string description = 2 [(buf.validate.field).string.max_len = 255];
 }

flyteidl2/task/task_definition.proto

@@ -110,6 +110,9 @@ message TaskMetadata {
 
   // Brief overview of attached triggers if any.
   TaskTriggersSummary triggers_summary = 5;
+
+  // The short description for this task
+  string short_description = 6;
 }
 
 // Lightweight representation of a task.
@@ -121,6 +124,20 @@ message Task {
   TaskMetadata metadata = 2 [(buf.validate.field).required = true];
 }
 
+// Link to source code used to define this entity
+message SourceCode {
+  string link = 1;
+}
+
+message DocumentationEntity {
+  // One-liner overview of the entity.
+  string short_description = 1 [(buf.validate.field).string.max_len = 255];
+  // Full user description with formatting preserved.
+  string long_description = 2 [(buf.validate.field).string.max_len = 2048];
+  // Optional link to source code used to define this entity.
+  SourceCode source_code = 3;
+}
+
 // Specification for a task.
 message TaskSpec {
   // The template for this task.
@@ -137,6 +154,9 @@ message TaskSpec {
 
   // Optional environment for this task. Note, some tasks may not be run in the context of an environment.
   Environment environment = 4;
+
+  // The documentation entity for the task
+  DocumentationEntity documentation = 5;
 }
 
 // Specification for a trace action.
@@ -181,4 +201,7 @@ message TaskTriggerSpec {
 
   // The run spec for triggered task.
   flyteidl2.task.RunSpec run_spec = 3;
+
+  //  Optional description
+  string description = 4;
 }

flyteidl2/trigger/trigger_definition.proto

@@ -36,6 +36,9 @@ message TriggerSpec {
     (buf.validate.field).string.min_len = 1,
     (buf.validate.field).string.max_len = 63
   ];
+
+  //  Optional description
+  string description = 6;
 }
 
 message TriggerStatus {
@@ -84,6 +87,9 @@ message TriggerDetails {
 
   // Optional automation spec.
   flyteidl2.task.TriggerAutomationSpec automation_spec = 5;
+
+  // Trigger description
+  optional string description = 6 [(buf.validate.field).string.max_len = 255];
 }
 
 // Light-weight information about trigger for a list view