Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update metadata #543

Merged
merged 2 commits into from
Jan 31, 2025
Merged

update metadata #543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f96fda5
update metadata api
Shivs11 Jan 31, 2025
59d4c67
fix weird spacing issue
Shivs11 Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 136 additions & 0 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2047,6 +2047,58 @@
]
}
},
"/api/v1/namespaces/{namespace}/worker-deployments/{version.deploymentName}/version/{version.buildId}/update-metadata": {
"post": {
"operationId": "UpdateWorkerVersionMetadata2",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UpdateWorkerVersionMetadataResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version.deploymentName",
"description": "The name of the Deployment this version belongs too.",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version.buildId",
"description": "Build ID uniquely identifies the Deployment Version within a Deployment, but the same Build\nID can be used in multiple Deployments.",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WorkflowServiceUpdateWorkerVersionMetadataBody"
}
}
],
"tags": [
"WorkflowService"
]
}
},
"/api/v1/namespaces/{namespace}/worker-task-reachability": {
"get": {
"summary": "Deprecated. Use `DescribeTaskQueue`.",
Expand Down Expand Up @@ -5294,6 +5346,58 @@
]
}
},
"/namespaces/{namespace}/worker-deployments/{version.deploymentName}/version/{version.buildId}/update-metadata": {
"post": {
"operationId": "UpdateWorkerVersionMetadata",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UpdateWorkerVersionMetadataResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version.deploymentName",
"description": "The name of the Deployment this version belongs too.",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version.buildId",
"description": "Build ID uniquely identifies the Deployment Version within a Deployment, but the same Build\nID can be used in multiple Deployments.",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WorkflowServiceUpdateWorkerVersionMetadataBody"
}
}
],
"tags": [
"WorkflowService"
]
}
},
"/namespaces/{namespace}/worker-task-reachability": {
"get": {
"summary": "Deprecated. Use `DescribeTaskQueue`.",
Expand Down Expand Up @@ -7441,6 +7545,29 @@
}
}
},
"WorkflowServiceUpdateWorkerVersionMetadataBody": {
"type": "object",
"properties": {
"version": {
"type": "object",
"description": "Identifies a Worker Deployment Version. The combination of `deployment_name` and `build_id`\nserve as the identifier."
},
"upsertEntries": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/v1Payload"
}
},
"removeEntries": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of keys to remove from the metadata."
}
},
"description": "Used to update the user-defined metadata of a Worker Deployment Version."
},
"WorkflowServiceUpdateWorkflowExecutionBody": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -13479,6 +13606,15 @@
"type": "object",
"title": "[cleanup-wv-pre-release]"
},
"v1UpdateWorkerVersionMetadataResponse": {
"type": "object",
"properties": {
"metadata": {
"$ref": "#/definitions/v1VersionMetadata",
"description": "Full metadata after performing the update."
}
}
},
"v1UpdateWorkerVersioningRulesResponse": {
"type": "object",
"properties": {
Expand Down
104 changes: 104 additions & 0 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1820,6 +1820,46 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/api/v1/namespaces/{namespace}/worker-deployments/{version.deployment_name}/version/{version.build_id}/update-metadata:
post:
tags:
- WorkflowService
operationId: UpdateWorkerVersionMetadata
parameters:
- name: namespace
in: path
required: true
schema:
type: string
- name: version.deployment_name
in: path
required: true
schema:
type: string
- name: version.build_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkerVersionMetadataRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkerVersionMetadataResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/api/v1/namespaces/{namespace}/worker-task-reachability:
get:
tags:
Expand Down Expand Up @@ -4717,6 +4757,46 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/namespaces/{namespace}/worker-deployments/{version.deployment_name}/version/{version.build_id}/update-metadata:
post:
tags:
- WorkflowService
operationId: UpdateWorkerVersionMetadata
parameters:
- name: namespace
in: path
required: true
schema:
type: string
- name: version.deployment_name
in: path
required: true
schema:
type: string
- name: version.build_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkerVersionMetadataRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkerVersionMetadataResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/namespaces/{namespace}/worker-task-reachability:
get:
tags:
Expand Down Expand Up @@ -10888,6 +10968,30 @@ components:
UpdateScheduleResponse:
type: object
properties: {}
UpdateWorkerVersionMetadataRequest:
type: object
properties:
namespace:
type: string
version:
$ref: '#/components/schemas/WorkerDeploymentVersion'
upsertEntries:
type: object
additionalProperties:
$ref: '#/components/schemas/Payload'
removeEntries:
type: array
items:
type: string
description: List of keys to remove from the metadata.
description: Used to update the user-defined metadata of a Worker Deployment Version.
UpdateWorkerVersionMetadataResponse:
type: object
properties:
metadata:
allOf:
- $ref: '#/components/schemas/VersionMetadata'
description: Full metadata after performing the update.
UpdateWorkflowExecutionOptionsRequest:
type: object
properties:
Expand Down
15 changes: 15 additions & 0 deletions temporal/api/workflowservice/v1/request_response.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2142,6 +2142,21 @@ message DeleteWorkerDeploymentRequest {
message DeleteWorkerDeploymentResponse {
}

// Used to update the user-defined metadata of a Worker Deployment Version.
message UpdateWorkerVersionMetadataRequest {
string namespace = 1;
temporal.api.deployment.v1.WorkerDeploymentVersion version = 2;
map<string, temporal.api.common.v1.Payload> upsert_entries = 3;
// List of keys to remove from the metadata.
repeated string remove_entries = 4;
}

message UpdateWorkerVersionMetadataResponse {
// Full metadata after performing the update.
temporal.api.deployment.v1.VersionMetadata metadata = 1;
}


// Returns the Current Deployment of a deployment series.
// [cleanup-wv-pre-release] Pre-release deployment APIs, clean up later
message GetCurrentDeploymentRequest {
Expand Down
11 changes: 11 additions & 0 deletions temporal/api/workflowservice/v1/service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -917,6 +917,17 @@ service WorkflowService {
};
}

rpc UpdateWorkerVersionMetadata (UpdateWorkerVersionMetadataRequest) returns (UpdateWorkerVersionMetadataResponse) {
option (google.api.http) = {
post: "/namespaces/{namespace}/worker-deployments/{version.deployment_name}/version/{version.build_id}/update-metadata"
body: "*"
additional_bindings {
post: "/api/v1/namespaces/{namespace}/worker-deployments/{version.deployment_name}/version/{version.build_id}/update-metadata"
body: "*"
}
};
}

// Invokes the specified Update function on user Workflow code.
rpc UpdateWorkflowExecution(UpdateWorkflowExecutionRequest) returns (UpdateWorkflowExecutionResponse) {
option (google.api.http) = {
Expand Down
Loading