From 2d24674d43a9455a8b6e52e1ecadc5f6648fa2d4 Mon Sep 17 00:00:00 2001 From: Shivam Saraf Date: Fri, 23 May 2025 15:07:52 -0700 Subject: [PATCH 1/2] added latest_version, current_version, ramping_version in list_deployments --- openapi/openapiv2.json | 9 +++++++++ openapi/openapiv3.yaml | 6 ++++++ temporal/api/workflowservice/v1/request_response.proto | 3 +++ 3 files changed, 18 insertions(+) diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json index 57fc95403..2c6d0f11e 100644 --- a/openapi/openapiv2.json +++ b/openapi/openapiv2.json @@ -6812,6 +6812,15 @@ }, "routingConfig": { "$ref": "#/definitions/v1RoutingConfig" + }, + "latestVersionSummary": { + "$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary" + }, + "currentVersionSummary": { + "$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary" + }, + "rampingVersionSummary": { + "$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary" } }, "title": "A subset of WorkerDeploymentInfo" diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml index 1880a9b36..669ebbceb 100644 --- a/openapi/openapiv3.yaml +++ b/openapi/openapiv3.yaml @@ -8251,6 +8251,12 @@ components: format: date-time routingConfig: $ref: '#/components/schemas/RoutingConfig' + latestVersionSummary: + $ref: '#/components/schemas/WorkerDeploymentInfo_WorkerDeploymentVersionSummary' + currentVersionSummary: + $ref: '#/components/schemas/WorkerDeploymentInfo_WorkerDeploymentVersionSummary' + rampingVersionSummary: + $ref: '#/components/schemas/WorkerDeploymentInfo_WorkerDeploymentVersionSummary' description: A subset of WorkerDeploymentInfo ListWorkflowExecutionsResponse: type: object diff --git a/temporal/api/workflowservice/v1/request_response.proto b/temporal/api/workflowservice/v1/request_response.proto index 48400be1e..d709b1780 100644 --- a/temporal/api/workflowservice/v1/request_response.proto +++ b/temporal/api/workflowservice/v1/request_response.proto @@ -2146,6 +2146,9 @@ message ListWorkerDeploymentsResponse { string name = 1; google.protobuf.Timestamp create_time = 2; temporal.api.deployment.v1.RoutingConfig routing_config = 3; + temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary latest_version_summary = 4; + temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary current_version_summary = 5; + temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary ramping_version_summary = 6; } } From b75e2cbf73623decc05dc649f4b2b92bbccd71be Mon Sep 17 00:00:00 2001 From: Shivam Saraf Date: Wed, 28 May 2025 08:35:53 -0400 Subject: [PATCH 2/2] docstrings --- openapi/openapiv2.json | 9 ++++++--- openapi/openapiv3.yaml | 12 +++++++++--- .../api/workflowservice/v1/request_response.proto | 3 +++ 3 files changed, 18 insertions(+), 6 deletions(-) diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json index 2c6d0f11e..8d2333416 100644 --- a/openapi/openapiv2.json +++ b/openapi/openapiv2.json @@ -6814,13 +6814,16 @@ "$ref": "#/definitions/v1RoutingConfig" }, "latestVersionSummary": { - "$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary" + "$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary", + "description": "Summary of the version that was added most recently in the Worker Deployment." }, "currentVersionSummary": { - "$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary" + "$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary", + "description": "Summary of the current version of the Worker Deployment." }, "rampingVersionSummary": { - "$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary" + "$ref": "#/definitions/WorkerDeploymentInfoWorkerDeploymentVersionSummary", + "description": "Summary of the ramping version of the Worker Deployment." } }, "title": "A subset of WorkerDeploymentInfo" diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml index 669ebbceb..b36613d60 100644 --- a/openapi/openapiv3.yaml +++ b/openapi/openapiv3.yaml @@ -8252,11 +8252,17 @@ components: routingConfig: $ref: '#/components/schemas/RoutingConfig' latestVersionSummary: - $ref: '#/components/schemas/WorkerDeploymentInfo_WorkerDeploymentVersionSummary' + allOf: + - $ref: '#/components/schemas/WorkerDeploymentInfo_WorkerDeploymentVersionSummary' + description: Summary of the version that was added most recently in the Worker Deployment. currentVersionSummary: - $ref: '#/components/schemas/WorkerDeploymentInfo_WorkerDeploymentVersionSummary' + allOf: + - $ref: '#/components/schemas/WorkerDeploymentInfo_WorkerDeploymentVersionSummary' + description: Summary of the current version of the Worker Deployment. rampingVersionSummary: - $ref: '#/components/schemas/WorkerDeploymentInfo_WorkerDeploymentVersionSummary' + allOf: + - $ref: '#/components/schemas/WorkerDeploymentInfo_WorkerDeploymentVersionSummary' + description: Summary of the ramping version of the Worker Deployment. description: A subset of WorkerDeploymentInfo ListWorkflowExecutionsResponse: type: object diff --git a/temporal/api/workflowservice/v1/request_response.proto b/temporal/api/workflowservice/v1/request_response.proto index d709b1780..389c34208 100644 --- a/temporal/api/workflowservice/v1/request_response.proto +++ b/temporal/api/workflowservice/v1/request_response.proto @@ -2146,8 +2146,11 @@ message ListWorkerDeploymentsResponse { string name = 1; google.protobuf.Timestamp create_time = 2; temporal.api.deployment.v1.RoutingConfig routing_config = 3; + // Summary of the version that was added most recently in the Worker Deployment. temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary latest_version_summary = 4; + // Summary of the current version of the Worker Deployment. temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary current_version_summary = 5; + // Summary of the ramping version of the Worker Deployment. temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary ramping_version_summary = 6; } }