Skip to content

Commit 50cbefb

Browse files
alexshtinalexshtin
authored
Sync //Deprecated comment and [deprecated = true] attribute (#592)
**What changed?** Sync `//Deprecated` comment and `[deprecated = true]` attribute. **Why?** When field is deprecated it should be marked with both comment and attribute to get full support in all languages. **Breaking changes** No, only comments/attributes changes.
1 parent 2803768 commit 50cbefb

File tree

12 files changed

+116
-110
lines changed

12 files changed

+116
-110
lines changed

‎openapi/openapiv2.json‎

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6922,7 +6922,7 @@
69226922
"properties": {
69236923
"operationId": {
69246924
"type": "string",
6925-
"description": "Deprecated: Renamed to operation_token."
6925+
"description": "Deprecated. Renamed to operation_token."
69266926
},
69276927
"links": {
69286928
"type": "array",
@@ -7467,7 +7467,7 @@
74677467
},
74687468
"resetReapplyType": {
74697469
"$ref": "#/definitions/v1ResetReapplyType",
7470-
"title": "Event types to be reapplied (deprecated)\nDefault: RESET_REAPPLY_TYPE_SIGNAL"
7470+
"title": "Deprecated. Use `options`.\nDefault: RESET_REAPPLY_TYPE_SIGNAL"
74717471
},
74727472
"resetReapplyExcludeTypes": {
74737473
"type": "array",
@@ -7794,7 +7794,7 @@
77947794
},
77957795
"control": {
77967796
"type": "string",
7797-
"title": "Deprecated"
7797+
"description": "Deprecated."
77987798
},
77997799
"retryPolicy": {
78007800
"$ref": "#/definitions/v1RetryPolicy",
@@ -7865,7 +7865,7 @@
78657865
},
78667866
"control": {
78677867
"type": "string",
7868-
"title": "Deprecated"
7868+
"description": "Deprecated."
78697869
},
78707870
"header": {
78717871
"$ref": "#/definitions/v1Header",
@@ -8947,11 +8947,11 @@
89478947
},
89488948
"resetType": {
89498949
"$ref": "#/definitions/v1ResetType",
8950-
"description": "Reset type (deprecated, use `options`)."
8950+
"description": "Deprecated. Use `options`."
89518951
},
89528952
"resetReapplyType": {
89538953
"$ref": "#/definitions/v1ResetReapplyType",
8954-
"description": "History event reapply options (deprecated, use `options`)."
8954+
"description": "Deprecated. Use `options`."
89558955
},
89568956
"postResetOperations": {
89578957
"type": "array",
@@ -9250,7 +9250,7 @@
92509250
},
92519251
"operationId": {
92529252
"type": "string",
9253-
"description": "Operation ID as originally generated by a Handler.\n\nDeprecated: Renamed to operation_token."
9253+
"description": "Operation ID as originally generated by a Handler.\n\nDeprecated. Renamed to operation_token."
92549254
},
92559255
"operationToken": {
92569256
"type": "string",
@@ -10354,7 +10354,7 @@
1035410354
},
1035510355
"control": {
1035610356
"type": "string",
10357-
"title": "Deprecated"
10357+
"description": "Deprecated."
1035810358
}
1035910359
}
1036010360
},
@@ -11672,7 +11672,7 @@
1167211672
},
1167311673
"operationId": {
1167411674
"type": "string",
11675-
"description": "Operation ID - may be empty if the operation completed synchronously.\n\nDeprecated: Renamed to operation_token."
11675+
"description": "Operation ID - may be empty if the operation completed synchronously.\n\nDeprecated. Renamed to operation_token."
1167611676
},
1167711677
"operationToken": {
1167811678
"type": "string",
@@ -11880,15 +11880,15 @@
1188011880
"useWorkflowBuildId": {
1188111881
"type": "object",
1188211882
"properties": {},
11883-
"description": "When present, it means this activity is assigned to the build ID of its workflow."
11883+
"description": "Deprecated. When present, it means this activity is assigned to the build ID of its workflow."
1188411884
},
1188511885
"lastIndependentlyAssignedBuildId": {
1188611886
"type": "string",
11887-
"description": "This means the activity is independently versioned and not bound to the build ID of its workflow.\nThe activity will use the build id in this field instead.\nIf the task fails and is scheduled again, the assigned build ID may change according to the latest versioning\nrules."
11887+
"description": "Deprecated. This means the activity is independently versioned and not bound to the build ID of its workflow.\nThe activity will use the build id in this field instead.\nIf the task fails and is scheduled again, the assigned build ID may change according to the latest versioning\nrules."
1188811888
},
1188911889
"lastWorkerVersionStamp": {
1189011890
"$ref": "#/definitions/v1WorkerVersionStamp",
11891-
"title": "The version stamp of the worker to whom this activity was most recently dispatched\nDeprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]"
11891+
"title": "Deprecated. The version stamp of the worker to whom this activity was most recently dispatched\nThis field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]"
1189211892
},
1189311893
"currentRetryInterval": {
1189411894
"type": "string",
@@ -11985,7 +11985,7 @@
1198511985
},
1198611986
"operationId": {
1198711987
"type": "string",
11988-
"description": "Operation ID. Only set for asynchronous operations after a successful StartOperation call.\n\nDeprecated: Renamed to operation_token."
11988+
"description": "Operation ID. Only set for asynchronous operations after a successful StartOperation call.\n\nDeprecated. Renamed to operation_token."
1198911989
},
1199011990
"scheduleToCloseTimeout": {
1199111991
"type": "string",
@@ -12628,7 +12628,7 @@
1262812628
},
1262912629
"control": {
1263012630
"type": "string",
12631-
"title": "Deprecated"
12631+
"description": "Deprecated."
1263212632
}
1263312633
}
1263412634
},
@@ -12652,7 +12652,7 @@
1265212652
},
1265312653
"control": {
1265412654
"type": "string",
12655-
"title": "Deprecated"
12655+
"description": "Deprecated."
1265612656
},
1265712657
"childWorkflowOnly": {
1265812658
"type": "boolean",
@@ -12723,7 +12723,7 @@
1272312723
},
1272412724
"resetReapplyType": {
1272512725
"$ref": "#/definitions/v1ResetReapplyType",
12726-
"title": "Event types to be reapplied (deprecated)\nDefault: RESET_REAPPLY_TYPE_SIGNAL"
12726+
"title": "Deprecated. Use `options`.\nDefault: RESET_REAPPLY_TYPE_SIGNAL"
1272712727
},
1272812728
"currentRunOnly": {
1272912729
"type": "boolean",
@@ -12748,7 +12748,7 @@
1274812748
},
1274912749
"binaryChecksum": {
1275012750
"type": "string",
12751-
"description": "A worker binary version identifier (deprecated)."
12751+
"description": "Deprecated. A worker binary version identifier."
1275212752
},
1275312753
"runId": {
1275412754
"type": "string",
@@ -12808,7 +12808,7 @@
1280812808
"RESET_REAPPLY_TYPE_ALL_ELIGIBLE"
1280912809
],
1281012810
"default": "RESET_REAPPLY_TYPE_UNSPECIFIED",
12811-
"description": "Event types to include when reapplying events. Deprecated: applications\nshould use ResetReapplyExcludeType to specify exclusions from this set, and\nnew event types should be added to ResetReapplyExcludeType instead of here.\n\n - RESET_REAPPLY_TYPE_SIGNAL: Signals are reapplied when workflow is reset.\n - RESET_REAPPLY_TYPE_NONE: No events are reapplied when workflow is reset.\n - RESET_REAPPLY_TYPE_ALL_ELIGIBLE: All eligible events are reapplied when workflow is reset."
12811+
"description": "Deprecated: applications should use ResetReapplyExcludeType to specify\nexclusions from this set, and new event types should be added to ResetReapplyExcludeType\ninstead of here.\n\n - RESET_REAPPLY_TYPE_SIGNAL: Signals are reapplied when workflow is reset.\n - RESET_REAPPLY_TYPE_NONE: No events are reapplied when workflow is reset.\n - RESET_REAPPLY_TYPE_ALL_ELIGIBLE: All eligible events are reapplied when workflow is reset."
1281212812
},
1281312813
"v1ResetStickyTaskQueueResponse": {
1281412814
"type": "object"
@@ -12821,7 +12821,7 @@
1282112821
"RESET_TYPE_LAST_WORKFLOW_TASK"
1282212822
],
1282312823
"default": "RESET_TYPE_UNSPECIFIED",
12824-
"description": "Reset type options. Deprecated, see temporal.api.common.v1.ResetOptions.\n\n - RESET_TYPE_FIRST_WORKFLOW_TASK: Resets to event of the first workflow task completed, or if it does not exist, the event after task scheduled.\n - RESET_TYPE_LAST_WORKFLOW_TASK: Resets to event of the last workflow task completed, or if it does not exist, the event after task scheduled."
12824+
"description": "Deprecated, see temporal.api.common.v1.ResetOptions.\n\n - RESET_TYPE_FIRST_WORKFLOW_TASK: Resets to event of the first workflow task completed, or if it does not exist, the event after task scheduled.\n - RESET_TYPE_LAST_WORKFLOW_TASK: Resets to event of the last workflow task completed, or if it does not exist, the event after task scheduled."
1282512825
},
1282612826
"v1ResetWorkflowExecutionResponse": {
1282712827
"type": "object",
@@ -13187,7 +13187,8 @@
1318713187
"format": "date-time"
1318813188
},
1318913189
"invalidScheduleError": {
13190-
"type": "string"
13190+
"type": "string",
13191+
"description": "Deprecated."
1319113192
}
1319213193
}
1319313194
},
@@ -13376,7 +13377,7 @@
1337613377
"type": "object",
1337713378
"$ref": "#/definitions/v1CalendarSpec"
1337813379
},
13379-
"description": "Any timestamps matching any of exclude_* will be skipped.\n\nuse exclude_structured_calendar"
13380+
"description": "Any timestamps matching any of exclude_* will be skipped.\nDeprecated. Use exclude_structured_calendar."
1338013381
},
1338113382
"excludeStructuredCalendar": {
1338213383
"type": "array",
@@ -13587,7 +13588,7 @@
1358713588
},
1358813589
"control": {
1358913590
"type": "string",
13590-
"title": "Deprecated"
13591+
"description": "Deprecated."
1359113592
}
1359213593
}
1359313594
},
@@ -13619,7 +13620,7 @@
1361913620
},
1362013621
"control": {
1362113622
"type": "string",
13622-
"title": "Deprecated"
13623+
"description": "Deprecated."
1362313624
},
1362413625
"childWorkflowOnly": {
1362513626
"type": "boolean",
@@ -13746,7 +13747,7 @@
1374613747
},
1374713748
"control": {
1374813749
"type": "string",
13749-
"title": "Deprecated"
13750+
"description": "Deprecated."
1375013751
},
1375113752
"initiatedEventId": {
1375213753
"type": "string",
@@ -13800,7 +13801,7 @@
1380013801
},
1380113802
"control": {
1380213803
"type": "string",
13803-
"title": "Deprecated"
13804+
"description": "Deprecated."
1380413805
},
1380513806
"workflowTaskCompletedEventId": {
1380613807
"type": "string",
@@ -15411,7 +15412,7 @@
1541115412
},
1541215413
"skipGenerateWorkflowTask": {
1541315414
"type": "boolean",
15414-
"description": "This field is deprecated and never respected. It should always be set to false."
15415+
"description": "Deprecated. This field is never respected and should always be set to false."
1541515416
},
1541615417
"externalWorkflowExecution": {
1541715418
"$ref": "#/definitions/v1WorkflowExecution",
@@ -16053,7 +16054,7 @@
1605316054
},
1605416055
"binaryChecksum": {
1605516056
"type": "string",
16056-
"title": "DEPRECATED since 1.21 - This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]\nIf a worker explicitly failed this task, its binary id"
16057+
"title": "Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]\nIf a worker explicitly failed this task, its binary id"
1605716058
},
1605816059
"workerVersion": {
1605916060
"$ref": "#/definitions/v1WorkerVersionStamp",

0 commit comments

Comments
 (0)