Switch back to using description for Nexus Endpoints (#420)

Author: bergundy

buf.yaml

@@ -11,6 +11,8 @@ breaking:
     - WIRE_JSON
   ignore:
     - google
+    # Remove after applying nexus spec description change
+    - temporal/api/nexus/v1/message.proto
 lint:
   use:
     - DEFAULT

openapi/openapiv2.json

@@ -4852,8 +4852,9 @@
           "type": "string",
           "description": "Endpoint name, unique for this cluster. Must match `[a-zA-Z_][a-zA-Z0-9_]*`.\nRenaming an endpoint breaks all workflow callers that reference this endpoint, causing operations to fail."
         },
-        "metadata": {
-          "$ref": "#/definitions/v1UserMetadata"
+        "description": {
+          "$ref": "#/definitions/v1Payload",
+          "description": "Markdown description serialized as a single JSON string.\nIf the Payload is encrypted, the UI and CLI may decrypt with the configured codec server endpoint.\nBy default, the server enforces a limit of 20,000 bytes for this entire payload."
         },
         "target": {
           "$ref": "#/definitions/v1EndpointTarget",

openapi/openapiv3.yaml

@@ -3151,8 +3151,13 @@ components:
           description: |-
             Endpoint name, unique for this cluster. Must match `[a-zA-Z_][a-zA-Z0-9_]*`.
              Renaming an endpoint breaks all workflow callers that reference this endpoint, causing operations to fail.
-        metadata:
-          $ref: '#/components/schemas/UserMetadata'
+        description:
+          allOf:
+            - $ref: '#/components/schemas/Payload'
+          description: |-
+            Markdown description serialized as a single JSON string.
+             If the Payload is encrypted, the UI and CLI may decrypt with the configured codec server endpoint.
+             By default, the server enforces a limit of 20,000 bytes for this entire payload.
         target:
           allOf:
             - $ref: '#/components/schemas/EndpointTarget'

temporal/api/nexus/v1/message.proto

@@ -31,7 +31,6 @@ option csharp_namespace = "Temporalio.Api.Nexus.V1";
 
 import "google/protobuf/timestamp.proto";
 import "temporal/api/common/v1/message.proto";
-import "temporal/api/sdk/v1/user_metadata.proto";
 
 // A general purpose failure message.
 // See: https://github.com/nexus-rpc/api/blob/main/SPEC.md#failure
@@ -162,7 +161,10 @@ message EndpointSpec {
     // Renaming an endpoint breaks all workflow callers that reference this endpoint, causing operations to fail.
     string name = 1;
 
-    temporal.api.sdk.v1.UserMetadata metadata = 2;
+    // Markdown description serialized as a single JSON string.
+    // If the Payload is encrypted, the UI and CLI may decrypt with the configured codec server endpoint.
+    // By default, the server enforces a limit of 20,000 bytes for this entire payload.
+    temporal.api.common.v1.Payload description = 2;
 
     // Target to route requests to.
     EndpointTarget target = 3;