Skip to content

Commit 7e3392d

Browse files
carlydfcarlydf
committed
deprecate old fields instead of deleting
1 parent 60a9f0b commit 7e3392d

7 files changed

Lines changed: 206 additions & 52 deletions

File tree

‎openapi/openapiv2.json‎

Lines changed: 92 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1770,6 +1770,13 @@
17701770
"in": "path",
17711771
"required": true,
17721772
"type": "string"
1773+
},
1774+
{
1775+
"name": "version",
1776+
"description": "Deprecated. Use `deployment_version`.",
1777+
"in": "query",
1778+
"required": false,
1779+
"type": "string"
17731780
}
17741781
],
17751782
"tags": [
@@ -1814,6 +1821,13 @@
18141821
"required": true,
18151822
"type": "string"
18161823
},
1824+
{
1825+
"name": "version",
1826+
"description": "Deprecated. Use `deployment_version`.",
1827+
"in": "query",
1828+
"required": false,
1829+
"type": "string"
1830+
},
18171831
{
18181832
"name": "skipDrainage",
18191833
"description": "Pass to force deletion even if the Version is draining. In this case the open pinned\nworkflows will be stuck until manually moved to another version by UpdateWorkflowExecutionOptions.",
@@ -5253,6 +5267,13 @@
52535267
"in": "path",
52545268
"required": true,
52555269
"type": "string"
5270+
},
5271+
{
5272+
"name": "version",
5273+
"description": "Deprecated. Use `deployment_version`.",
5274+
"in": "query",
5275+
"required": false,
5276+
"type": "string"
52565277
}
52575278
],
52585279
"tags": [
@@ -5297,6 +5318,13 @@
52975318
"required": true,
52985319
"type": "string"
52995320
},
5321+
{
5322+
"name": "version",
5323+
"description": "Deprecated. Use `deployment_version`.",
5324+
"in": "query",
5325+
"required": false,
5326+
"type": "string"
5327+
},
53005328
{
53015329
"name": "skipDrainage",
53025330
"description": "Pass to force deletion even if the Version is draining. In this case the open pinned\nworkflows will be stuck until manually moved to another version by UpdateWorkflowExecutionOptions.",
@@ -6998,6 +7026,10 @@
69987026
"WorkerDeploymentInfoWorkerDeploymentVersionSummary": {
69997027
"type": "object",
70007028
"properties": {
7029+
"version": {
7030+
"type": "string",
7031+
"description": "Deprecated. Use `deployment_version`."
7032+
},
70017033
"deploymentVersion": {
70027034
"$ref": "#/definitions/v1WorkerDeploymentVersion"
70037035
},
@@ -7550,6 +7582,14 @@
75507582
"WorkflowServiceSetWorkerDeploymentCurrentVersionBody": {
75517583
"type": "object",
75527584
"properties": {
7585+
"deploymentName": {
7586+
"type": "string",
7587+
"description": "Deprecated. Use `current`."
7588+
},
7589+
"version": {
7590+
"type": "string",
7591+
"description": "Deprecated. Use `current`."
7592+
},
75537593
"deploymentVersion": {
75547594
"$ref": "#/definitions/v1WorkerDeploymentVersion"
75557595
},
@@ -7575,6 +7615,14 @@
75757615
"WorkflowServiceSetWorkerDeploymentRampingVersionBody": {
75767616
"type": "object",
75777617
"properties": {
7618+
"deploymentName": {
7619+
"type": "string",
7620+
"description": "Deprecated. Use `ramping`."
7621+
},
7622+
"version": {
7623+
"type": "string",
7624+
"description": "Deprecated. Use `ramping`."
7625+
},
75787626
"deploymentVersion": {
75797627
"$ref": "#/definitions/v1WorkerDeploymentVersion"
75807628
},
@@ -8085,6 +8133,10 @@
80858133
"WorkflowServiceUpdateWorkerDeploymentVersionMetadataBody": {
80868134
"type": "object",
80878135
"properties": {
8136+
"version": {
8137+
"type": "string",
8138+
"description": "Deprecated. Use `deployment_version`."
8139+
},
80888140
"deploymentVersion": {
80898141
"type": "object",
80908142
"description": "A Worker Deployment Version (Version, for short) represents a different\nversion of workers within a Worker Deployment. (see documentation of WorkerDeploymentVersionInfo)\nVersion records are created in Temporal server automatically when their\nfirst poller arrives to the server.\nExperimental. Worker Deployment Versions are experimental and might significantly change in the future."
@@ -9746,8 +9798,14 @@
97469798
"type": "object",
97479799
"properties": {
97489800
"version": {
9749-
"$ref": "#/definitions/v1WorkerDeploymentVersion",
9750-
"description": "Required. The target Version of the transition. May be `__unversioned__` which means a\nso-far-versioned workflow is transitioning to unversioned workers."
9801+
"type": "string",
9802+
"description": "Deprecated. Use `target`."
9803+
},
9804+
"deploymentVersion": {
9805+
"$ref": "#/definitions/v1WorkerDeploymentVersion"
9806+
},
9807+
"unversioned": {
9808+
"type": "boolean"
97519809
}
97529810
},
97539811
"description": "Holds information about ongoing transition of a workflow execution from one worker\ndeployment version to another.\nExperimental. Might change in the future."
@@ -12776,13 +12834,21 @@
1277612834
"type": "boolean",
1277712835
"title": "Represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)"
1277812836
},
12837+
"currentVersion": {
12838+
"type": "string",
12839+
"description": "Deprecated. Use `current`."
12840+
},
1277912841
"rampingDeploymentVersion": {
1278012842
"$ref": "#/definitions/v1WorkerDeploymentVersion"
1278112843
},
1278212844
"rampingUnversioned": {
1278312845
"type": "boolean",
1278412846
"title": "Represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)"
1278512847
},
12848+
"rampingVersion": {
12849+
"type": "string",
12850+
"description": "Deprecated. Use `ramping`."
12851+
},
1278612852
"rampingVersionPercentage": {
1278712853
"type": "number",
1278812854
"format": "float",
@@ -13270,6 +13336,10 @@
1327013336
"format": "byte",
1327113337
"description": "This value is returned so that it can be optionally passed to APIs\nthat write to the Worker Deployment state to ensure that the state\ndid not change between this API call and a future write."
1327213338
},
13339+
"previousVersion": {
13340+
"type": "string",
13341+
"description": "Deprecated. Use `previous_current`."
13342+
},
1327313343
"deploymentVersion": {
1327413344
"$ref": "#/definitions/v1WorkerDeploymentVersion"
1327513345
},
@@ -13286,6 +13356,10 @@
1328613356
"format": "byte",
1328713357
"description": "This value is returned so that it can be optionally passed to APIs\nthat write to the Worker Deployment state to ensure that the state\ndid not change between this API call and a future write."
1328813358
},
13359+
"previousVersion": {
13360+
"type": "string",
13361+
"description": "Deprecated. Use `previous_ramping`."
13362+
},
1328913363
"deploymentVersion": {
1329013364
"$ref": "#/definitions/v1WorkerDeploymentVersion"
1329113365
},
@@ -14139,13 +14213,21 @@
1413914213
"type": "boolean",
1414014214
"title": "Represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)"
1414114215
},
14216+
"currentVersion": {
14217+
"type": "string",
14218+
"description": "Deprecated. Use `current`."
14219+
},
1414214220
"rampingDeploymentVersion": {
1414314221
"$ref": "#/definitions/v1WorkerDeploymentVersion"
1414414222
},
1414514223
"rampingUnversioned": {
1414614224
"type": "boolean",
1414714225
"title": "Represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)"
1414814226
},
14227+
"rampingVersion": {
14228+
"type": "string",
14229+
"description": "Deprecated. Use `ramping`."
14230+
},
1414914231
"rampingVersionPercentage": {
1415014232
"type": "number",
1415114233
"format": "float",
@@ -14728,6 +14810,10 @@
1472814810
"v1WorkerDeploymentVersionInfo": {
1472914811
"type": "object",
1473014812
"properties": {
14813+
"version": {
14814+
"type": "string",
14815+
"description": "Deprecated. Use `deployment_version`."
14816+
},
1473114817
"deploymentVersion": {
1473214818
"$ref": "#/definitions/v1WorkerDeploymentVersion"
1473314819
},
@@ -15469,6 +15555,10 @@
1546915555
"description": "The worker deployment that completed the last workflow task of this workflow execution. Must\nbe present if `behavior` is set. Absent value means no workflow task is completed, or the\nlast workflow task was completed by an unversioned worker. Unversioned workers may still send\na deployment value which will be stored here, so the right way to check if an execution is\nversioned if an execution is versioned or not is via the `behavior` field.\nNote that `deployment` is overridden by `versioning_override` if the latter is present.\nDeprecated. Use `version`."
1547015556
},
1547115557
"version": {
15558+
"$ref": "#/definitions/v1WorkerDeploymentVersion",
15559+
"description": "Deprecated. Use `deployment_version`."
15560+
},
15561+
"deploymentVersion": {
1547215562
"$ref": "#/definitions/v1WorkerDeploymentVersion",
1547315563
"description": "The Worker Deployment Version that completed the last workflow task of this workflow execution.\nMust be present if and only if `behavior` is set. An absent value means no workflow task is\ncompleted, or the workflow is unversioned.\nFor child workflows of Pinned parents, this will be set to parent's Pinned Version when the\nthe child starts so that child's first workflow task goes to the same Version as the parent.\nNote that if `versioning_override.behavior` is PINNED then `versioning_override.pinned_version`\nwill override this value."
1547415564
},

0 commit comments

Comments
 (0)