diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json index 57fc95403..32d711669 100644 --- a/openapi/openapiv2.json +++ b/openapi/openapiv2.json @@ -870,231 +870,6 @@ ] } }, - "/api/v1/namespaces/{namespace}/current-deployment/{deployment.seriesName}": { - "post": { - "summary": "Sets a deployment as the current deployment for its deployment series. Can optionally update\nthe metadata of the deployment as well.\nExperimental. This API might significantly change or be removed in a future release.\nDeprecated. Replaced by `SetWorkerDeploymentCurrentVersion`.", - "operationId": "SetCurrentDeployment2", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/v1SetCurrentDeploymentResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "parameters": [ - { - "name": "namespace", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "deployment.seriesName", - "description": "Different versions of the same worker service/application are related together by having a\nshared series name.\nOut of all deployments of a series, one can be designated as the current deployment, which\nreceives new workflow executions and new tasks of workflows with\n`VERSIONING_BEHAVIOR_AUTO_UPGRADE` versioning behavior.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkflowServiceSetCurrentDeploymentBody" - } - } - ], - "tags": [ - "WorkflowService" - ] - } - }, - "/api/v1/namespaces/{namespace}/current-deployment/{seriesName}": { - "get": { - "summary": "Returns the current deployment (and its info) for a given deployment series.\nExperimental. This API might significantly change or be removed in a future release.\nDeprecated. Replaced by `current_version` returned by `DescribeWorkerDeployment`.", - "operationId": "GetCurrentDeployment2", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/v1GetCurrentDeploymentResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "parameters": [ - { - "name": "namespace", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "seriesName", - "in": "path", - "required": true, - "type": "string" - } - ], - "tags": [ - "WorkflowService" - ] - } - }, - "/api/v1/namespaces/{namespace}/deployments": { - "get": { - "summary": "Lists worker deployments in the namespace. Optionally can filter based on deployment series\nname.\nExperimental. This API might significantly change or be removed in a future release.\nDeprecated. Replaced with `ListWorkerDeployments`.", - "operationId": "ListDeployments2", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/v1ListDeploymentsResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "parameters": [ - { - "name": "namespace", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "pageSize", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "nextPageToken", - "in": "query", - "required": false, - "type": "string", - "format": "byte" - }, - { - "name": "seriesName", - "description": "Optional. Use to filter based on exact series name match.", - "in": "query", - "required": false, - "type": "string" - } - ], - "tags": [ - "WorkflowService" - ] - } - }, - "/api/v1/namespaces/{namespace}/deployments/{deployment.seriesName}/{deployment.buildId}": { - "get": { - "summary": "Describes a worker deployment.\nExperimental. This API might significantly change or be removed in a future release.\nDeprecated. Replaced with `DescribeWorkerDeploymentVersion`.", - "operationId": "DescribeDeployment2", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/v1DescribeDeploymentResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "parameters": [ - { - "name": "namespace", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "deployment.seriesName", - "description": "Different versions of the same worker service/application are related together by having a\nshared series name.\nOut of all deployments of a series, one can be designated as the current deployment, which\nreceives new workflow executions and new tasks of workflows with\n`VERSIONING_BEHAVIOR_AUTO_UPGRADE` versioning behavior.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "deployment.buildId", - "description": "Build ID changes with each version of the worker when the worker program code and/or config\nchanges.", - "in": "path", - "required": true, - "type": "string" - } - ], - "tags": [ - "WorkflowService" - ] - } - }, - "/api/v1/namespaces/{namespace}/deployments/{deployment.seriesName}/{deployment.buildId}/reachability": { - "get": { - "summary": "Returns the reachability level of a worker deployment to help users decide when it is time\nto decommission a deployment. Reachability level is calculated based on the deployment's\n`status` and existing workflows that depend on the given deployment for their execution.\nCalculating reachability is relatively expensive. Therefore, server might return a recently\ncached value. In such a case, the `last_update_time` will inform you about the actual\nreachability calculation time.\nExperimental. This API might significantly change or be removed in a future release.\nDeprecated. Replaced with `DrainageInfo` returned by `DescribeWorkerDeploymentVersion`.", - "operationId": "GetDeploymentReachability2", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/v1GetDeploymentReachabilityResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "parameters": [ - { - "name": "namespace", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "deployment.seriesName", - "description": "Different versions of the same worker service/application are related together by having a\nshared series name.\nOut of all deployments of a series, one can be designated as the current deployment, which\nreceives new workflow executions and new tasks of workflows with\n`VERSIONING_BEHAVIOR_AUTO_UPGRADE` versioning behavior.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "deployment.buildId", - "description": "Build ID changes with each version of the worker when the worker program code and/or config\nchanges.", - "in": "path", - "required": true, - "type": "string" - } - ], - "tags": [ - "WorkflowService" - ] - } - }, "/api/v1/namespaces/{namespace}/schedules": { "get": { "summary": "List all schedules in a namespace.", @@ -4449,231 +4224,6 @@ ] } }, - "/namespaces/{namespace}/current-deployment/{deployment.seriesName}": { - "post": { - "summary": "Sets a deployment as the current deployment for its deployment series. Can optionally update\nthe metadata of the deployment as well.\nExperimental. This API might significantly change or be removed in a future release.\nDeprecated. Replaced by `SetWorkerDeploymentCurrentVersion`.", - "operationId": "SetCurrentDeployment", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/v1SetCurrentDeploymentResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "parameters": [ - { - "name": "namespace", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "deployment.seriesName", - "description": "Different versions of the same worker service/application are related together by having a\nshared series name.\nOut of all deployments of a series, one can be designated as the current deployment, which\nreceives new workflow executions and new tasks of workflows with\n`VERSIONING_BEHAVIOR_AUTO_UPGRADE` versioning behavior.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/WorkflowServiceSetCurrentDeploymentBody" - } - } - ], - "tags": [ - "WorkflowService" - ] - } - }, - "/namespaces/{namespace}/current-deployment/{seriesName}": { - "get": { - "summary": "Returns the current deployment (and its info) for a given deployment series.\nExperimental. This API might significantly change or be removed in a future release.\nDeprecated. Replaced by `current_version` returned by `DescribeWorkerDeployment`.", - "operationId": "GetCurrentDeployment", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/v1GetCurrentDeploymentResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "parameters": [ - { - "name": "namespace", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "seriesName", - "in": "path", - "required": true, - "type": "string" - } - ], - "tags": [ - "WorkflowService" - ] - } - }, - "/namespaces/{namespace}/deployments": { - "get": { - "summary": "Lists worker deployments in the namespace. Optionally can filter based on deployment series\nname.\nExperimental. This API might significantly change or be removed in a future release.\nDeprecated. Replaced with `ListWorkerDeployments`.", - "operationId": "ListDeployments", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/v1ListDeploymentsResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "parameters": [ - { - "name": "namespace", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "pageSize", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "nextPageToken", - "in": "query", - "required": false, - "type": "string", - "format": "byte" - }, - { - "name": "seriesName", - "description": "Optional. Use to filter based on exact series name match.", - "in": "query", - "required": false, - "type": "string" - } - ], - "tags": [ - "WorkflowService" - ] - } - }, - "/namespaces/{namespace}/deployments/{deployment.seriesName}/{deployment.buildId}": { - "get": { - "summary": "Describes a worker deployment.\nExperimental. This API might significantly change or be removed in a future release.\nDeprecated. Replaced with `DescribeWorkerDeploymentVersion`.", - "operationId": "DescribeDeployment", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/v1DescribeDeploymentResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "parameters": [ - { - "name": "namespace", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "deployment.seriesName", - "description": "Different versions of the same worker service/application are related together by having a\nshared series name.\nOut of all deployments of a series, one can be designated as the current deployment, which\nreceives new workflow executions and new tasks of workflows with\n`VERSIONING_BEHAVIOR_AUTO_UPGRADE` versioning behavior.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "deployment.buildId", - "description": "Build ID changes with each version of the worker when the worker program code and/or config\nchanges.", - "in": "path", - "required": true, - "type": "string" - } - ], - "tags": [ - "WorkflowService" - ] - } - }, - "/namespaces/{namespace}/deployments/{deployment.seriesName}/{deployment.buildId}/reachability": { - "get": { - "summary": "Returns the reachability level of a worker deployment to help users decide when it is time\nto decommission a deployment. Reachability level is calculated based on the deployment's\n`status` and existing workflows that depend on the given deployment for their execution.\nCalculating reachability is relatively expensive. Therefore, server might return a recently\ncached value. In such a case, the `last_update_time` will inform you about the actual\nreachability calculation time.\nExperimental. This API might significantly change or be removed in a future release.\nDeprecated. Replaced with `DrainageInfo` returned by `DescribeWorkerDeploymentVersion`.", - "operationId": "GetDeploymentReachability", - "responses": { - "200": { - "description": "A successful response.", - "schema": { - "$ref": "#/definitions/v1GetDeploymentReachabilityResponse" - } - }, - "default": { - "description": "An unexpected error response.", - "schema": { - "$ref": "#/definitions/rpcStatus" - } - } - }, - "parameters": [ - { - "name": "namespace", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "deployment.seriesName", - "description": "Different versions of the same worker service/application are related together by having a\nshared series name.\nOut of all deployments of a series, one can be designated as the current deployment, which\nreceives new workflow executions and new tasks of workflows with\n`VERSIONING_BEHAVIOR_AUTO_UPGRADE` versioning behavior.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "deployment.buildId", - "description": "Build ID changes with each version of the worker when the worker program code and/or config\nchanges.", - "in": "path", - "required": true, - "type": "string" - } - ], - "tags": [ - "WorkflowService" - ] - } - }, "/namespaces/{namespace}/schedules": { "get": { "summary": "List all schedules in a namespace.", @@ -6718,22 +6268,6 @@ } } }, - "DeploymentInfoTaskQueueInfo": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "type": { - "$ref": "#/definitions/v1TaskQueueType" - }, - "firstPollerTime": { - "type": "string", - "format": "date-time", - "description": "When server saw the first poller for this task queue in this deployment." - } - } - }, "EndpointTargetExternal": { "type": "object", "properties": { @@ -7663,30 +7197,6 @@ } } }, - "WorkflowServiceSetCurrentDeploymentBody": { - "type": "object", - "properties": { - "deployment": { - "type": "object", - "properties": { - "buildId": { - "type": "string", - "description": "Build ID changes with each version of the worker when the worker program code and/or config\nchanges." - } - }, - "description": "`Deployment` identifies a deployment of Temporal workers. The combination of deployment series\nname + build ID serves as the identifier. User can use `WorkerDeploymentOptions` in their worker\nprograms to specify these values.\nDeprecated." - }, - "identity": { - "type": "string", - "description": "Optional. The identity of the client who initiated this request." - }, - "updateMetadata": { - "$ref": "#/definitions/v1UpdateDeploymentMetadata", - "description": "Optional. Use to add or remove user-defined metadata entries. Metadata entries are exposed\nwhen describing a deployment. It is a good place for information such as operator name,\nlinks to internal deployment pipelines, etc." - } - }, - "title": "[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later" - }, "WorkflowServiceSetWorkerDeploymentCurrentVersionBody": { "type": "object", "properties": { @@ -9840,65 +9350,6 @@ }, "description": "`Deployment` identifies a deployment of Temporal workers. The combination of deployment series\nname + build ID serves as the identifier. User can use `WorkerDeploymentOptions` in their worker\nprograms to specify these values.\nDeprecated." }, - "v1DeploymentInfo": { - "type": "object", - "properties": { - "deployment": { - "$ref": "#/definitions/v1Deployment" - }, - "createTime": { - "type": "string", - "format": "date-time" - }, - "taskQueueInfos": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/DeploymentInfoTaskQueueInfo" - } - }, - "metadata": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/v1Payload" - }, - "description": "A user-defined set of key-values. Can be updated as part of write operations to the\ndeployment, such as `SetCurrentDeployment`." - }, - "isCurrent": { - "type": "boolean", - "description": "If this deployment is the current deployment of its deployment series." - } - }, - "description": "`DeploymentInfo` holds information about a deployment. Deployment information is tracked\nautomatically by server as soon as the first poll from that deployment reaches the server. There\ncan be multiple task queue workers in a single deployment which are listed in this message.\nDeprecated." - }, - "v1DeploymentListInfo": { - "type": "object", - "properties": { - "deployment": { - "$ref": "#/definitions/v1Deployment" - }, - "createTime": { - "type": "string", - "format": "date-time" - }, - "isCurrent": { - "type": "boolean", - "description": "If this deployment is the current deployment of its deployment series." - } - }, - "description": "DeploymentListInfo is an abbreviated set of fields from DeploymentInfo that's returned in\nListDeployments.\nDeprecated." - }, - "v1DeploymentReachability": { - "type": "string", - "enum": [ - "DEPLOYMENT_REACHABILITY_UNSPECIFIED", - "DEPLOYMENT_REACHABILITY_REACHABLE", - "DEPLOYMENT_REACHABILITY_CLOSED_WORKFLOWS_ONLY", - "DEPLOYMENT_REACHABILITY_UNREACHABLE" - ], - "default": "DEPLOYMENT_REACHABILITY_UNSPECIFIED", - "description": "Specify the reachability level for a deployment so users can decide if it is time to\ndecommission the deployment.\n\n - DEPLOYMENT_REACHABILITY_UNSPECIFIED: Reachability level is not specified.\n - DEPLOYMENT_REACHABILITY_REACHABLE: The deployment is reachable by new and/or open workflows. The deployment cannot be\ndecommissioned safely.\n - DEPLOYMENT_REACHABILITY_CLOSED_WORKFLOWS_ONLY: The deployment is not reachable by new or open workflows, but might be still needed by\nQueries sent to closed workflows. The deployment can be decommissioned safely if user does\nnot query closed workflows.\n - DEPLOYMENT_REACHABILITY_UNREACHABLE: The deployment is not reachable by any workflow because all the workflows who needed this\ndeployment went out of retention period. The deployment can be decommissioned safely." - }, "v1DeploymentTransition": { "type": "object", "properties": { @@ -9977,15 +9428,6 @@ } } }, - "v1DescribeDeploymentResponse": { - "type": "object", - "properties": { - "deploymentInfo": { - "$ref": "#/definitions/v1DeploymentInfo" - } - }, - "title": "[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later" - }, "v1DescribeNamespaceResponse": { "type": "object", "properties": { @@ -10416,32 +9858,6 @@ }, "description": "GetClusterInfoResponse contains information about Temporal cluster." }, - "v1GetCurrentDeploymentResponse": { - "type": "object", - "properties": { - "currentDeploymentInfo": { - "$ref": "#/definitions/v1DeploymentInfo" - } - }, - "title": "[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later" - }, - "v1GetDeploymentReachabilityResponse": { - "type": "object", - "properties": { - "deploymentInfo": { - "$ref": "#/definitions/v1DeploymentInfo" - }, - "reachability": { - "$ref": "#/definitions/v1DeploymentReachability" - }, - "lastUpdateTime": { - "type": "string", - "format": "date-time", - "description": "Reachability level might come from server cache. This timestamp specifies when the value\nwas actually calculated." - } - }, - "title": "[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later" - }, "v1GetNexusEndpointResponse": { "type": "object", "properties": { @@ -10987,23 +10403,6 @@ } } }, - "v1ListDeploymentsResponse": { - "type": "object", - "properties": { - "nextPageToken": { - "type": "string", - "format": "byte" - }, - "deployments": { - "type": "array", - "items": { - "type": "object", - "$ref": "#/definitions/v1DeploymentListInfo" - } - } - }, - "title": "[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later" - }, "v1ListNamespacesResponse": { "type": "object", "properties": { @@ -13452,19 +12851,6 @@ } } }, - "v1SetCurrentDeploymentResponse": { - "type": "object", - "properties": { - "currentDeploymentInfo": { - "$ref": "#/definitions/v1DeploymentInfo" - }, - "previousDeploymentInfo": { - "$ref": "#/definitions/v1DeploymentInfo", - "description": "Info of the deployment that was current before executing this operation." - } - }, - "title": "[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later" - }, "v1SetWorkerDeploymentCurrentVersionResponse": { "type": "object", "properties": { @@ -14542,25 +13928,6 @@ "default": "UPDATE_ADMITTED_EVENT_ORIGIN_UNSPECIFIED", "description": "Records why a WorkflowExecutionUpdateAdmittedEvent was written to history.\nNote that not all admitted Updates result in this event.\n\n - UPDATE_ADMITTED_EVENT_ORIGIN_REAPPLY: The UpdateAdmitted event was created when reapplying events during reset\nor replication. I.e. an accepted Update on one branch of Workflow history\nwas converted into an admitted Update on a different branch." }, - "v1UpdateDeploymentMetadata": { - "type": "object", - "properties": { - "upsertEntries": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/v1Payload" - } - }, - "removeEntries": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of keys to remove from the metadata." - } - }, - "description": "Used as part of Deployment write APIs to update metadata attached to a deployment.\nDeprecated." - }, "v1UpdateNamespaceInfo": { "type": "object", "properties": { diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml index 1880a9b36..7460c2b2c 100644 --- a/openapi/openapiv3.yaml +++ b/openapi/openapiv3.yaml @@ -776,238 +776,6 @@ paths: application/json: schema: $ref: '#/components/schemas/Status' - /api/v1/namespaces/{namespace}/current-deployment/{deployment.series_name}: - post: - tags: - - WorkflowService - description: |- - Sets a deployment as the current deployment for its deployment series. Can optionally update - the metadata of the deployment as well. - Experimental. This API might significantly change or be removed in a future release. - Deprecated. Replaced by `SetWorkerDeploymentCurrentVersion`. - operationId: SetCurrentDeployment - parameters: - - name: namespace - in: path - required: true - schema: - type: string - - name: deployment.series_name - in: path - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetCurrentDeploymentRequest' - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/SetCurrentDeploymentResponse' - default: - description: Default error response - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - /api/v1/namespaces/{namespace}/current-deployment/{seriesName}: - get: - tags: - - WorkflowService - description: |- - Returns the current deployment (and its info) for a given deployment series. - Experimental. This API might significantly change or be removed in a future release. - Deprecated. Replaced by `current_version` returned by `DescribeWorkerDeployment`. - operationId: GetCurrentDeployment - parameters: - - name: namespace - in: path - required: true - schema: - type: string - - name: seriesName - in: path - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/GetCurrentDeploymentResponse' - default: - description: Default error response - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - /api/v1/namespaces/{namespace}/deployments: - get: - tags: - - WorkflowService - description: |- - Lists worker deployments in the namespace. Optionally can filter based on deployment series - name. - Experimental. This API might significantly change or be removed in a future release. - Deprecated. Replaced with `ListWorkerDeployments`. - operationId: ListDeployments - parameters: - - name: namespace - in: path - required: true - schema: - type: string - - name: pageSize - in: query - schema: - type: integer - format: int32 - - name: nextPageToken - in: query - schema: - type: string - format: bytes - - name: seriesName - in: query - description: Optional. Use to filter based on exact series name match. - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/ListDeploymentsResponse' - default: - description: Default error response - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - /api/v1/namespaces/{namespace}/deployments/{deployment.series_name}/{deployment.build_id}: - get: - tags: - - WorkflowService - description: |- - Describes a worker deployment. - Experimental. This API might significantly change or be removed in a future release. - Deprecated. Replaced with `DescribeWorkerDeploymentVersion`. - operationId: DescribeDeployment - parameters: - - name: namespace - in: path - required: true - schema: - type: string - - name: deployment.series_name - in: path - required: true - schema: - type: string - - name: deployment.build_id - in: path - required: true - schema: - type: string - - name: deployment.seriesName - in: query - description: |- - Different versions of the same worker service/application are related together by having a - shared series name. - Out of all deployments of a series, one can be designated as the current deployment, which - receives new workflow executions and new tasks of workflows with - `VERSIONING_BEHAVIOR_AUTO_UPGRADE` versioning behavior. - schema: - type: string - - name: deployment.buildId - in: query - description: |- - Build ID changes with each version of the worker when the worker program code and/or config - changes. - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeDeploymentResponse' - default: - description: Default error response - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - /api/v1/namespaces/{namespace}/deployments/{deployment.series_name}/{deployment.build_id}/reachability: - get: - tags: - - WorkflowService - description: |- - Returns the reachability level of a worker deployment to help users decide when it is time - to decommission a deployment. Reachability level is calculated based on the deployment's - `status` and existing workflows that depend on the given deployment for their execution. - Calculating reachability is relatively expensive. Therefore, server might return a recently - cached value. In such a case, the `last_update_time` will inform you about the actual - reachability calculation time. - Experimental. This API might significantly change or be removed in a future release. - Deprecated. Replaced with `DrainageInfo` returned by `DescribeWorkerDeploymentVersion`. - operationId: GetDeploymentReachability - parameters: - - name: namespace - in: path - required: true - schema: - type: string - - name: deployment.series_name - in: path - required: true - schema: - type: string - - name: deployment.build_id - in: path - required: true - schema: - type: string - - name: deployment.seriesName - in: query - description: |- - Different versions of the same worker service/application are related together by having a - shared series name. - Out of all deployments of a series, one can be designated as the current deployment, which - receives new workflow executions and new tasks of workflows with - `VERSIONING_BEHAVIOR_AUTO_UPGRADE` versioning behavior. - schema: - type: string - - name: deployment.buildId - in: query - description: |- - Build ID changes with each version of the worker when the worker program code and/or config - changes. - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/GetDeploymentReachabilityResponse' - default: - description: Default error response - content: - application/json: - schema: - $ref: '#/components/schemas/Status' /api/v1/namespaces/{namespace}/schedules: get: tags: @@ -3971,238 +3739,6 @@ paths: application/json: schema: $ref: '#/components/schemas/Status' - /namespaces/{namespace}/current-deployment/{deployment.series_name}: - post: - tags: - - WorkflowService - description: |- - Sets a deployment as the current deployment for its deployment series. Can optionally update - the metadata of the deployment as well. - Experimental. This API might significantly change or be removed in a future release. - Deprecated. Replaced by `SetWorkerDeploymentCurrentVersion`. - operationId: SetCurrentDeployment - parameters: - - name: namespace - in: path - required: true - schema: - type: string - - name: deployment.series_name - in: path - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SetCurrentDeploymentRequest' - required: true - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/SetCurrentDeploymentResponse' - default: - description: Default error response - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - /namespaces/{namespace}/current-deployment/{seriesName}: - get: - tags: - - WorkflowService - description: |- - Returns the current deployment (and its info) for a given deployment series. - Experimental. This API might significantly change or be removed in a future release. - Deprecated. Replaced by `current_version` returned by `DescribeWorkerDeployment`. - operationId: GetCurrentDeployment - parameters: - - name: namespace - in: path - required: true - schema: - type: string - - name: seriesName - in: path - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/GetCurrentDeploymentResponse' - default: - description: Default error response - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - /namespaces/{namespace}/deployments: - get: - tags: - - WorkflowService - description: |- - Lists worker deployments in the namespace. Optionally can filter based on deployment series - name. - Experimental. This API might significantly change or be removed in a future release. - Deprecated. Replaced with `ListWorkerDeployments`. - operationId: ListDeployments - parameters: - - name: namespace - in: path - required: true - schema: - type: string - - name: pageSize - in: query - schema: - type: integer - format: int32 - - name: nextPageToken - in: query - schema: - type: string - format: bytes - - name: seriesName - in: query - description: Optional. Use to filter based on exact series name match. - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/ListDeploymentsResponse' - default: - description: Default error response - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - /namespaces/{namespace}/deployments/{deployment.series_name}/{deployment.build_id}: - get: - tags: - - WorkflowService - description: |- - Describes a worker deployment. - Experimental. This API might significantly change or be removed in a future release. - Deprecated. Replaced with `DescribeWorkerDeploymentVersion`. - operationId: DescribeDeployment - parameters: - - name: namespace - in: path - required: true - schema: - type: string - - name: deployment.series_name - in: path - required: true - schema: - type: string - - name: deployment.build_id - in: path - required: true - schema: - type: string - - name: deployment.seriesName - in: query - description: |- - Different versions of the same worker service/application are related together by having a - shared series name. - Out of all deployments of a series, one can be designated as the current deployment, which - receives new workflow executions and new tasks of workflows with - `VERSIONING_BEHAVIOR_AUTO_UPGRADE` versioning behavior. - schema: - type: string - - name: deployment.buildId - in: query - description: |- - Build ID changes with each version of the worker when the worker program code and/or config - changes. - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/DescribeDeploymentResponse' - default: - description: Default error response - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - /namespaces/{namespace}/deployments/{deployment.series_name}/{deployment.build_id}/reachability: - get: - tags: - - WorkflowService - description: |- - Returns the reachability level of a worker deployment to help users decide when it is time - to decommission a deployment. Reachability level is calculated based on the deployment's - `status` and existing workflows that depend on the given deployment for their execution. - Calculating reachability is relatively expensive. Therefore, server might return a recently - cached value. In such a case, the `last_update_time` will inform you about the actual - reachability calculation time. - Experimental. This API might significantly change or be removed in a future release. - Deprecated. Replaced with `DrainageInfo` returned by `DescribeWorkerDeploymentVersion`. - operationId: GetDeploymentReachability - parameters: - - name: namespace - in: path - required: true - schema: - type: string - - name: deployment.series_name - in: path - required: true - schema: - type: string - - name: deployment.build_id - in: path - required: true - schema: - type: string - - name: deployment.seriesName - in: query - description: |- - Different versions of the same worker service/application are related together by having a - shared series name. - Out of all deployments of a series, one can be designated as the current deployment, which - receives new workflow executions and new tasks of workflows with - `VERSIONING_BEHAVIOR_AUTO_UPGRADE` versioning behavior. - schema: - type: string - - name: deployment.buildId - in: query - description: |- - Build ID changes with each version of the worker when the worker program code and/or config - changes. - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/GetDeploymentReachabilityResponse' - default: - description: Default error response - content: - application/json: - schema: - $ref: '#/components/schemas/Status' /namespaces/{namespace}/schedules: get: tags: @@ -7095,65 +6631,6 @@ components: name + build ID serves as the identifier. User can use `WorkerDeploymentOptions` in their worker programs to specify these values. Deprecated. - DeploymentInfo: - type: object - properties: - deployment: - $ref: '#/components/schemas/Deployment' - createTime: - type: string - format: date-time - taskQueueInfos: - type: array - items: - $ref: '#/components/schemas/DeploymentInfo_TaskQueueInfo' - metadata: - type: object - additionalProperties: - $ref: '#/components/schemas/Payload' - description: |- - A user-defined set of key-values. Can be updated as part of write operations to the - deployment, such as `SetCurrentDeployment`. - isCurrent: - type: boolean - description: If this deployment is the current deployment of its deployment series. - description: |- - `DeploymentInfo` holds information about a deployment. Deployment information is tracked - automatically by server as soon as the first poll from that deployment reaches the server. There - can be multiple task queue workers in a single deployment which are listed in this message. - Deprecated. - DeploymentInfo_TaskQueueInfo: - type: object - properties: - name: - type: string - type: - enum: - - TASK_QUEUE_TYPE_UNSPECIFIED - - TASK_QUEUE_TYPE_WORKFLOW - - TASK_QUEUE_TYPE_ACTIVITY - - TASK_QUEUE_TYPE_NEXUS - type: string - format: enum - firstPollerTime: - type: string - description: When server saw the first poller for this task queue in this deployment. - format: date-time - DeploymentListInfo: - type: object - properties: - deployment: - $ref: '#/components/schemas/Deployment' - createTime: - type: string - format: date-time - isCurrent: - type: boolean - description: If this deployment is the current deployment of its deployment series. - description: |- - DeploymentListInfo is an abbreviated set of fields from DeploymentInfo that's returned in - ListDeployments. - Deprecated. DeploymentTransition: type: object properties: @@ -7232,12 +6709,6 @@ components: reason: type: string description: Reason indicates the reason to stop a operation - DescribeDeploymentResponse: - type: object - properties: - deploymentInfo: - $ref: '#/components/schemas/DeploymentInfo' - description: '[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later' DescribeNamespaceResponse: type: object properties: @@ -7637,32 +7108,6 @@ components: visibilityStore: type: string description: GetClusterInfoResponse contains information about Temporal cluster. - GetCurrentDeploymentResponse: - type: object - properties: - currentDeploymentInfo: - $ref: '#/components/schemas/DeploymentInfo' - description: '[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later' - GetDeploymentReachabilityResponse: - type: object - properties: - deploymentInfo: - $ref: '#/components/schemas/DeploymentInfo' - reachability: - enum: - - DEPLOYMENT_REACHABILITY_UNSPECIFIED - - DEPLOYMENT_REACHABILITY_REACHABLE - - DEPLOYMENT_REACHABILITY_CLOSED_WORKFLOWS_ONLY - - DEPLOYMENT_REACHABILITY_UNREACHABLE - type: string - format: enum - lastUpdateTime: - type: string - description: |- - Reachability level might come from server cache. This timestamp specifies when the value - was actually calculated. - format: date-time - description: '[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later' GetNexusEndpointResponse: type: object properties: @@ -8142,17 +7587,6 @@ components: nextPageToken: type: string format: bytes - ListDeploymentsResponse: - type: object - properties: - nextPageToken: - type: string - format: bytes - deployments: - type: array - items: - $ref: '#/components/schemas/DeploymentListInfo' - description: '[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later' ListNamespacesResponse: type: object properties: @@ -10542,34 +9976,6 @@ components: properties: nonRetryable: type: boolean - SetCurrentDeploymentRequest: - type: object - properties: - namespace: - type: string - deployment: - $ref: '#/components/schemas/Deployment' - identity: - type: string - description: Optional. The identity of the client who initiated this request. - updateMetadata: - allOf: - - $ref: '#/components/schemas/UpdateDeploymentMetadata' - description: |- - Optional. Use to add or remove user-defined metadata entries. Metadata entries are exposed - when describing a deployment. It is a good place for information such as operator name, - links to internal deployment pipelines, etc. - description: '[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later' - SetCurrentDeploymentResponse: - type: object - properties: - currentDeploymentInfo: - $ref: '#/components/schemas/DeploymentInfo' - previousDeploymentInfo: - allOf: - - $ref: '#/components/schemas/DeploymentInfo' - description: Info of the deployment that was current before executing this operation. - description: '[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later' SetWorkerDeploymentCurrentVersionRequest: type: object properties: @@ -11757,21 +11163,6 @@ components: allOf: - $ref: '#/components/schemas/ActivityOptions' description: Activity options after an update - UpdateDeploymentMetadata: - type: object - properties: - 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 as part of Deployment write APIs to update metadata attached to a deployment. - Deprecated. UpdateNamespaceInfo: type: object properties: diff --git a/temporal/api/workflowservice/v1/request_response.proto b/temporal/api/workflowservice/v1/request_response.proto index 48400be1e..a87c26b17 100644 --- a/temporal/api/workflowservice/v1/request_response.proto +++ b/temporal/api/workflowservice/v1/request_response.proto @@ -17,7 +17,6 @@ import "temporal/api/enums/v1/failed_cause.proto"; import "temporal/api/enums/v1/query.proto"; import "temporal/api/enums/v1/reset.proto"; import "temporal/api/enums/v1/task_queue.proto"; -import "temporal/api/enums/v1/deployment.proto"; import "temporal/api/enums/v1/update.proto"; import "temporal/api/activity/v1/message.proto"; import "temporal/api/common/v1/message.proto"; @@ -2201,32 +2200,6 @@ message UpdateWorkerDeploymentVersionMetadataResponse { } -// Returns the Current Deployment of a deployment series. -// [cleanup-wv-pre-release] Pre-release deployment APIs, clean up later -message GetCurrentDeploymentRequest { - string namespace = 1; - string series_name = 2; -} -// [cleanup-wv-pre-release] Pre-release deployment APIs, clean up later -message GetCurrentDeploymentResponse { - temporal.api.deployment.v1.DeploymentInfo current_deployment_info = 1; -} - -// [cleanup-wv-pre-release] Pre-release deployment APIs, clean up later -message GetDeploymentReachabilityRequest { - string namespace = 1; - temporal.api.deployment.v1.Deployment deployment = 2; -} - -// [cleanup-wv-pre-release] Pre-release deployment APIs, clean up later -message GetDeploymentReachabilityResponse { - temporal.api.deployment.v1.DeploymentInfo deployment_info = 1; - enums.v1.DeploymentReachability reachability = 2; - // Reachability level might come from server cache. This timestamp specifies when the value - // was actually calculated. - google.protobuf.Timestamp last_update_time = 3; -} - message CreateWorkflowRuleRequest { string namespace = 1; diff --git a/temporal/api/workflowservice/v1/service.proto b/temporal/api/workflowservice/v1/service.proto index 865386506..4ff11e201 100644 --- a/temporal/api/workflowservice/v1/service.proto +++ b/temporal/api/workflowservice/v1/service.proto @@ -751,17 +751,6 @@ service WorkflowService { }; } - // Describes a worker deployment. - // Experimental. This API might significantly change or be removed in a future release. - // Deprecated. Replaced with `DescribeWorkerDeploymentVersion`. - rpc DescribeDeployment (DescribeDeploymentRequest) returns (DescribeDeploymentResponse) { - option (google.api.http) = { - get: "/namespaces/{namespace}/deployments/{deployment.series_name}/{deployment.build_id}" - additional_bindings { - get: "/api/v1/namespaces/{namespace}/deployments/{deployment.series_name}/{deployment.build_id}" - } - }; - } // Describes a worker deployment version. // Experimental. This API might significantly change or be removed in a future release. @@ -774,63 +763,6 @@ service WorkflowService { }; } - // Lists worker deployments in the namespace. Optionally can filter based on deployment series - // name. - // Experimental. This API might significantly change or be removed in a future release. - // Deprecated. Replaced with `ListWorkerDeployments`. - rpc ListDeployments (ListDeploymentsRequest) returns (ListDeploymentsResponse) { - option (google.api.http) = { - get: "/namespaces/{namespace}/deployments" - additional_bindings { - get: "/api/v1/namespaces/{namespace}/deployments" - } - }; - } - - // Returns the reachability level of a worker deployment to help users decide when it is time - // to decommission a deployment. Reachability level is calculated based on the deployment's - // `status` and existing workflows that depend on the given deployment for their execution. - // Calculating reachability is relatively expensive. Therefore, server might return a recently - // cached value. In such a case, the `last_update_time` will inform you about the actual - // reachability calculation time. - // Experimental. This API might significantly change or be removed in a future release. - // Deprecated. Replaced with `DrainageInfo` returned by `DescribeWorkerDeploymentVersion`. - rpc GetDeploymentReachability (GetDeploymentReachabilityRequest) returns (GetDeploymentReachabilityResponse) { - option (google.api.http) = { - get: "/namespaces/{namespace}/deployments/{deployment.series_name}/{deployment.build_id}/reachability" - additional_bindings { - get: "/api/v1/namespaces/{namespace}/deployments/{deployment.series_name}/{deployment.build_id}/reachability" - } - }; - } - - // Returns the current deployment (and its info) for a given deployment series. - // Experimental. This API might significantly change or be removed in a future release. - // Deprecated. Replaced by `current_version` returned by `DescribeWorkerDeployment`. - rpc GetCurrentDeployment (GetCurrentDeploymentRequest) returns (GetCurrentDeploymentResponse) { - option (google.api.http) = { - get: "/namespaces/{namespace}/current-deployment/{series_name}" - additional_bindings { - get: "/api/v1/namespaces/{namespace}/current-deployment/{series_name}" - } - }; - } - - // Sets a deployment as the current deployment for its deployment series. Can optionally update - // the metadata of the deployment as well. - // Experimental. This API might significantly change or be removed in a future release. - // Deprecated. Replaced by `SetWorkerDeploymentCurrentVersion`. - rpc SetCurrentDeployment (SetCurrentDeploymentRequest) returns (SetCurrentDeploymentResponse) { - option (google.api.http) = { - post: "/namespaces/{namespace}/current-deployment/{deployment.series_name}" - body: "*" - additional_bindings { - post: "/api/v1/namespaces/{namespace}/current-deployment/{deployment.series_name}" - body: "*" - } - }; - } - // Set/unset the Current Version of a Worker Deployment. Automatically unsets the Ramping // Version if it is the Version being set as Current. // Experimental. This API might significantly change or be removed in a future release. @@ -868,7 +800,6 @@ service WorkflowService { }; } - // Used for manual deletion of Versions. User can delete a Version only when all the // following conditions are met: // - It is not the Current or Ramping Version of its Deployment.