Skip to content

Commit e098742

Browse files
authored
Use UserMetadata in Nexus EndpointSpec (#412)
1 parent 8c57e7b commit e098742

File tree

4 files changed

+9
-12
lines changed

4 files changed

+9
-12
lines changed

buf.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ breaking:
1313
- google
1414
# Remove this after user metadata is merged
1515
- temporal/api/sdk/v1/workflow_metadata.proto
16+
# Remove after applying nexus spec metadata change
17+
- temporal/api/nexus/v1/message.proto
1618
lint:
1719
use:
1820
- DEFAULT

openapi/openapiv2.json

+2-3
Original file line numberDiff line numberDiff line change
@@ -4845,9 +4845,8 @@
48454845
"type": "string",
48464846
"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."
48474847
},
4848-
"description": {
4849-
"$ref": "#/definitions/v1Payload",
4850-
"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."
4848+
"metadata": {
4849+
"$ref": "#/definitions/v1UserMetadata"
48514850
},
48524851
"target": {
48534852
"$ref": "#/definitions/v1EndpointTarget",

openapi/openapiv3.yaml

+2-6
Original file line numberDiff line numberDiff line change
@@ -3149,12 +3149,8 @@ components:
31493149
description: |-
31503150
Endpoint name, unique for this cluster. Must match `[a-zA-Z_][a-zA-Z0-9_]*`.
31513151
Renaming an endpoint breaks all workflow callers that reference this endpoint, causing operations to fail.
3152-
description:
3153-
allOf:
3154-
- $ref: '#/components/schemas/Payload'
3155-
description: |-
3156-
Markdown description serialized as a single JSON string.
3157-
If the Payload is encrypted, the UI and CLI may decrypt with the configured codec server endpoint.
3152+
metadata:
3153+
$ref: '#/components/schemas/UserMetadata'
31583154
target:
31593155
allOf:
31603156
- $ref: '#/components/schemas/EndpointTarget'

temporal/api/nexus/v1/message.proto

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ option csharp_namespace = "Temporalio.Api.Nexus.V1";
3131

3232
import "google/protobuf/timestamp.proto";
3333
import "temporal/api/common/v1/message.proto";
34+
import "temporal/api/sdk/v1/user_metadata.proto";
3435

3536
// A general purpose failure message.
3637
// See: https://github.com/nexus-rpc/api/blob/main/SPEC.md#failure
@@ -160,9 +161,8 @@ message EndpointSpec {
160161
// Endpoint name, unique for this cluster. Must match `[a-zA-Z_][a-zA-Z0-9_]*`.
161162
// Renaming an endpoint breaks all workflow callers that reference this endpoint, causing operations to fail.
162163
string name = 1;
163-
// Markdown description serialized as a single JSON string.
164-
// If the Payload is encrypted, the UI and CLI may decrypt with the configured codec server endpoint.
165-
temporal.api.common.v1.Payload description = 2;
164+
165+
temporal.api.sdk.v1.UserMetadata metadata = 2;
166166

167167
// Target to route requests to.
168168
EndpointTarget target = 3;

0 commit comments

Comments
 (0)