From f7216d3cd6a4ea39f72d2b7880557c28054279bf Mon Sep 17 00:00:00 2001 From: Shivam Saraf Date: Tue, 21 Jan 2025 16:23:27 -0500 Subject: [PATCH] plurals --- openapi/openapiv2.json | 148 +++++++++--------- openapi/openapiv3.yaml | 148 +++++++++--------- temporal/api/workflowservice/v1/service.proto | 8 +- 3 files changed, 152 insertions(+), 152 deletions(-) diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json index b51e9c92..fc5cb967 100644 --- a/openapi/openapiv2.json +++ b/openapi/openapiv2.json @@ -1730,15 +1730,15 @@ ] } }, - "/api/v1/namespaces/{namespace}/worker-deployment/{deploymentName}/set-current-version": { - "post": { - "summary": "Set/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping\nVersion if it is the Version being set as Current.", - "operationId": "SetWorkerDeploymentCurrentVersion2", + "/api/v1/namespaces/{namespace}/worker-deployments-version/{version}": { + "get": { + "summary": "Describes a worker deployment version.", + "operationId": "DescribeWorkerDeploymentVersion2", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/v1SetWorkerDeploymentCurrentVersionResponse" + "$ref": "#/definitions/v1DescribeWorkerDeploymentVersionResponse" } }, "default": { @@ -1756,18 +1756,10 @@ "type": "string" }, { - "name": "deploymentName", + "name": "version", "in": "path", "required": true, "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkflowServiceSetWorkerDeploymentCurrentVersionBody" - } } ], "tags": [ @@ -1775,15 +1767,14 @@ ] } }, - "/api/v1/namespaces/{namespace}/worker-deployment/{deploymentName}/set-ramping-version": { - "post": { - "summary": "Set/unset the Ramping Version of a Worker Deployment and its ramp percentage. Can be used for\ngradual ramp to unversioned workers too.", - "operationId": "SetWorkerDeploymentRampingVersion2", + "/api/v1/namespaces/{namespace}/worker-deployments/{deploymentName}": { + "get": { + "operationId": "DescribeWorkerDeployment2", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/v1SetWorkerDeploymentRampingVersionResponse" + "$ref": "#/definitions/v1DescribeWorkerDeploymentResponse" } }, "default": { @@ -1805,14 +1796,6 @@ "in": "path", "required": true, "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkflowServiceSetWorkerDeploymentRampingVersionBody" - } } ], "tags": [ @@ -1820,15 +1803,15 @@ ] } }, - "/api/v1/namespaces/{namespace}/worker-deployments-version/{version}": { - "get": { - "summary": "Describes a worker deployment version.", - "operationId": "DescribeWorkerDeploymentVersion2", + "/api/v1/namespaces/{namespace}/worker-deployments/{deploymentName}/set-current-version": { + "post": { + "summary": "Set/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping\nVersion if it is the Version being set as Current.", + "operationId": "SetWorkerDeploymentCurrentVersion2", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/v1DescribeWorkerDeploymentVersionResponse" + "$ref": "#/definitions/v1SetWorkerDeploymentCurrentVersionResponse" } }, "default": { @@ -1846,10 +1829,18 @@ "type": "string" }, { - "name": "version", + "name": "deploymentName", "in": "path", "required": true, "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowServiceSetWorkerDeploymentCurrentVersionBody" + } } ], "tags": [ @@ -1857,14 +1848,15 @@ ] } }, - "/api/v1/namespaces/{namespace}/worker-deployments/{deploymentName}": { - "get": { - "operationId": "DescribeWorkerDeployment2", + "/api/v1/namespaces/{namespace}/worker-deployments/{deploymentName}/set-ramping-version": { + "post": { + "summary": "Set/unset the Ramping Version of a Worker Deployment and its ramp percentage. Can be used for\ngradual ramp to unversioned workers too.", + "operationId": "SetWorkerDeploymentRampingVersion2", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/v1DescribeWorkerDeploymentResponse" + "$ref": "#/definitions/v1SetWorkerDeploymentRampingVersionResponse" } }, "default": { @@ -1886,6 +1878,14 @@ "in": "path", "required": true, "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowServiceSetWorkerDeploymentRampingVersionBody" + } } ], "tags": [ @@ -4823,15 +4823,15 @@ ] } }, - "/namespaces/{namespace}/worker-deployment/{deploymentName}/set-current-version": { - "post": { - "summary": "Set/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping\nVersion if it is the Version being set as Current.", - "operationId": "SetWorkerDeploymentCurrentVersion", + "/namespaces/{namespace}/worker-deployments-version/{version}": { + "get": { + "summary": "Describes a worker deployment version.", + "operationId": "DescribeWorkerDeploymentVersion", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/v1SetWorkerDeploymentCurrentVersionResponse" + "$ref": "#/definitions/v1DescribeWorkerDeploymentVersionResponse" } }, "default": { @@ -4849,18 +4849,10 @@ "type": "string" }, { - "name": "deploymentName", + "name": "version", "in": "path", "required": true, "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkflowServiceSetWorkerDeploymentCurrentVersionBody" - } } ], "tags": [ @@ -4868,15 +4860,14 @@ ] } }, - "/namespaces/{namespace}/worker-deployment/{deploymentName}/set-ramping-version": { - "post": { - "summary": "Set/unset the Ramping Version of a Worker Deployment and its ramp percentage. Can be used for\ngradual ramp to unversioned workers too.", - "operationId": "SetWorkerDeploymentRampingVersion", + "/namespaces/{namespace}/worker-deployments/{deploymentName}": { + "get": { + "operationId": "DescribeWorkerDeployment", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/v1SetWorkerDeploymentRampingVersionResponse" + "$ref": "#/definitions/v1DescribeWorkerDeploymentResponse" } }, "default": { @@ -4898,14 +4889,6 @@ "in": "path", "required": true, "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkflowServiceSetWorkerDeploymentRampingVersionBody" - } } ], "tags": [ @@ -4913,15 +4896,15 @@ ] } }, - "/namespaces/{namespace}/worker-deployments-version/{version}": { - "get": { - "summary": "Describes a worker deployment version.", - "operationId": "DescribeWorkerDeploymentVersion", + "/namespaces/{namespace}/worker-deployments/{deploymentName}/set-current-version": { + "post": { + "summary": "Set/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping\nVersion if it is the Version being set as Current.", + "operationId": "SetWorkerDeploymentCurrentVersion", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/v1DescribeWorkerDeploymentVersionResponse" + "$ref": "#/definitions/v1SetWorkerDeploymentCurrentVersionResponse" } }, "default": { @@ -4939,10 +4922,18 @@ "type": "string" }, { - "name": "version", + "name": "deploymentName", "in": "path", "required": true, "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowServiceSetWorkerDeploymentCurrentVersionBody" + } } ], "tags": [ @@ -4950,14 +4941,15 @@ ] } }, - "/namespaces/{namespace}/worker-deployments/{deploymentName}": { - "get": { - "operationId": "DescribeWorkerDeployment", + "/namespaces/{namespace}/worker-deployments/{deploymentName}/set-ramping-version": { + "post": { + "summary": "Set/unset the Ramping Version of a Worker Deployment and its ramp percentage. Can be used for\ngradual ramp to unversioned workers too.", + "operationId": "SetWorkerDeploymentRampingVersion", "responses": { "200": { "description": "A successful response.", "schema": { - "$ref": "#/definitions/v1DescribeWorkerDeploymentResponse" + "$ref": "#/definitions/v1SetWorkerDeploymentRampingVersionResponse" } }, "default": { @@ -4979,6 +4971,14 @@ "in": "path", "required": true, "type": "string" + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WorkflowServiceSetWorkerDeploymentRampingVersionBody" + } } ], "tags": [ diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml index 021c56c1..e66fffa7 100644 --- a/openapi/openapiv3.yaml +++ b/openapi/openapiv3.yaml @@ -1533,52 +1533,41 @@ paths: application/json: schema: $ref: '#/components/schemas/Status' - /api/v1/namespaces/{namespace}/worker-deployment/{deploymentName}/set-current-version: - post: + /api/v1/namespaces/{namespace}/worker-deployments-version/{version}: + get: tags: - WorkflowService - description: |- - Set/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping - Version if it is the Version being set as Current. - operationId: SetWorkerDeploymentCurrentVersion + description: Describes a worker deployment version. + operationId: DescribeWorkerDeploymentVersion parameters: - name: namespace in: path required: true schema: type: string - - name: deploymentName + - name: version in: path required: true schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetWorkerDeploymentCurrentVersionRequest' - required: true responses: "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/SetWorkerDeploymentCurrentVersionResponse' + $ref: '#/components/schemas/DescribeWorkerDeploymentVersionResponse' default: description: Default error response content: application/json: schema: $ref: '#/components/schemas/Status' - /api/v1/namespaces/{namespace}/worker-deployment/{deploymentName}/set-ramping-version: - post: + /api/v1/namespaces/{namespace}/worker-deployments/{deploymentName}: + get: tags: - WorkflowService - description: |- - Set/unset the Ramping Version of a Worker Deployment and its ramp percentage. Can be used for - gradual ramp to unversioned workers too. - operationId: SetWorkerDeploymentRampingVersion + operationId: DescribeWorkerDeployment parameters: - name: namespace in: path @@ -1590,60 +1579,65 @@ paths: required: true schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetWorkerDeploymentRampingVersionRequest' - required: true responses: "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/SetWorkerDeploymentRampingVersionResponse' + $ref: '#/components/schemas/DescribeWorkerDeploymentResponse' default: description: Default error response content: application/json: schema: $ref: '#/components/schemas/Status' - /api/v1/namespaces/{namespace}/worker-deployments-version/{version}: - get: + /api/v1/namespaces/{namespace}/worker-deployments/{deploymentName}/set-current-version: + post: tags: - WorkflowService - description: Describes a worker deployment version. - operationId: DescribeWorkerDeploymentVersion + description: |- + Set/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping + Version if it is the Version being set as Current. + operationId: SetWorkerDeploymentCurrentVersion parameters: - name: namespace in: path required: true schema: type: string - - name: version + - name: deploymentName in: path required: true schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetWorkerDeploymentCurrentVersionRequest' + required: true responses: "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/DescribeWorkerDeploymentVersionResponse' + $ref: '#/components/schemas/SetWorkerDeploymentCurrentVersionResponse' default: description: Default error response content: application/json: schema: $ref: '#/components/schemas/Status' - /api/v1/namespaces/{namespace}/worker-deployments/{deploymentName}: - get: + /api/v1/namespaces/{namespace}/worker-deployments/{deploymentName}/set-ramping-version: + post: tags: - WorkflowService - operationId: DescribeWorkerDeployment + description: |- + Set/unset the Ramping Version of a Worker Deployment and its ramp percentage. Can be used for + gradual ramp to unversioned workers too. + operationId: SetWorkerDeploymentRampingVersion parameters: - name: namespace in: path @@ -1655,13 +1649,19 @@ paths: required: true schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetWorkerDeploymentRampingVersionRequest' + required: true responses: "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/DescribeWorkerDeploymentResponse' + $ref: '#/components/schemas/SetWorkerDeploymentRampingVersionResponse' default: description: Default error response content: @@ -4278,52 +4278,41 @@ paths: application/json: schema: $ref: '#/components/schemas/Status' - /namespaces/{namespace}/worker-deployment/{deploymentName}/set-current-version: - post: + /namespaces/{namespace}/worker-deployments-version/{version}: + get: tags: - WorkflowService - description: |- - Set/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping - Version if it is the Version being set as Current. - operationId: SetWorkerDeploymentCurrentVersion + description: Describes a worker deployment version. + operationId: DescribeWorkerDeploymentVersion parameters: - name: namespace in: path required: true schema: type: string - - name: deploymentName + - name: version in: path required: true schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetWorkerDeploymentCurrentVersionRequest' - required: true responses: "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/SetWorkerDeploymentCurrentVersionResponse' + $ref: '#/components/schemas/DescribeWorkerDeploymentVersionResponse' default: description: Default error response content: application/json: schema: $ref: '#/components/schemas/Status' - /namespaces/{namespace}/worker-deployment/{deploymentName}/set-ramping-version: - post: + /namespaces/{namespace}/worker-deployments/{deploymentName}: + get: tags: - WorkflowService - description: |- - Set/unset the Ramping Version of a Worker Deployment and its ramp percentage. Can be used for - gradual ramp to unversioned workers too. - operationId: SetWorkerDeploymentRampingVersion + operationId: DescribeWorkerDeployment parameters: - name: namespace in: path @@ -4335,60 +4324,65 @@ paths: required: true schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetWorkerDeploymentRampingVersionRequest' - required: true responses: "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/SetWorkerDeploymentRampingVersionResponse' + $ref: '#/components/schemas/DescribeWorkerDeploymentResponse' default: description: Default error response content: application/json: schema: $ref: '#/components/schemas/Status' - /namespaces/{namespace}/worker-deployments-version/{version}: - get: + /namespaces/{namespace}/worker-deployments/{deploymentName}/set-current-version: + post: tags: - WorkflowService - description: Describes a worker deployment version. - operationId: DescribeWorkerDeploymentVersion + description: |- + Set/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping + Version if it is the Version being set as Current. + operationId: SetWorkerDeploymentCurrentVersion parameters: - name: namespace in: path required: true schema: type: string - - name: version + - name: deploymentName in: path required: true schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetWorkerDeploymentCurrentVersionRequest' + required: true responses: "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/DescribeWorkerDeploymentVersionResponse' + $ref: '#/components/schemas/SetWorkerDeploymentCurrentVersionResponse' default: description: Default error response content: application/json: schema: $ref: '#/components/schemas/Status' - /namespaces/{namespace}/worker-deployments/{deploymentName}: - get: + /namespaces/{namespace}/worker-deployments/{deploymentName}/set-ramping-version: + post: tags: - WorkflowService - operationId: DescribeWorkerDeployment + description: |- + Set/unset the Ramping Version of a Worker Deployment and its ramp percentage. Can be used for + gradual ramp to unversioned workers too. + operationId: SetWorkerDeploymentRampingVersion parameters: - name: namespace in: path @@ -4400,13 +4394,19 @@ paths: required: true schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetWorkerDeploymentRampingVersionRequest' + required: true responses: "200": description: OK content: application/json: schema: - $ref: '#/components/schemas/DescribeWorkerDeploymentResponse' + $ref: '#/components/schemas/SetWorkerDeploymentRampingVersionResponse' default: description: Default error response content: diff --git a/temporal/api/workflowservice/v1/service.proto b/temporal/api/workflowservice/v1/service.proto index f4647ea8..c8217cba 100644 --- a/temporal/api/workflowservice/v1/service.proto +++ b/temporal/api/workflowservice/v1/service.proto @@ -855,10 +855,10 @@ service WorkflowService { // Version if it is the Version being set as Current. rpc SetWorkerDeploymentCurrentVersion (SetWorkerDeploymentCurrentVersionRequest) returns (SetWorkerDeploymentCurrentVersionResponse) { option (google.api.http) = { - post: "/namespaces/{namespace}/worker-deployment/{deployment_name}/set-current-version" + post: "/namespaces/{namespace}/worker-deployments/{deployment_name}/set-current-version" body: "*" additional_bindings { - post: "/api/v1/namespaces/{namespace}/worker-deployment/{deployment_name}/set-current-version" + post: "/api/v1/namespaces/{namespace}/worker-deployments/{deployment_name}/set-current-version" body: "*" } }; @@ -877,10 +877,10 @@ service WorkflowService { // gradual ramp to unversioned workers too. rpc SetWorkerDeploymentRampingVersion (SetWorkerDeploymentRampingVersionRequest) returns (SetWorkerDeploymentRampingVersionResponse) { option (google.api.http) = { - post: "/namespaces/{namespace}/worker-deployment/{deployment_name}/set-ramping-version" + post: "/namespaces/{namespace}/worker-deployments/{deployment_name}/set-ramping-version" body: "*" additional_bindings { - post: "/api/v1/namespaces/{namespace}/worker-deployment/{deployment_name}/set-ramping-version" + post: "/api/v1/namespaces/{namespace}/worker-deployments/{deployment_name}/set-ramping-version" body: "*" } };