Skip to content

Commit 9c8a433

Browse files
committed
make version optional for versioning override of already-pinned workflows
1 parent 7acda96 commit 9c8a433

File tree

3 files changed

+19
-3
lines changed

3 files changed

+19
-3
lines changed

openapi/openapiv2.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7888,7 +7888,7 @@
78887888
},
78897889
"version": {
78907890
"$ref": "#/definitions/v1WorkerDeploymentVersion",
7891-
"description": "Required."
7891+
"description": "Specifies the Worker Deployment Version to pin this workflow to.\nRequired if the target workflow is not already pinned to a version.\n\nIf omitted and the target workflow is already pinned, the effective\npinned version will be the existing pinned version.\n\nIf omitted and the target workflow is not pinned, the override request\nwill be rejected with a PreconditionFailed error."
78927892
}
78937893
}
78947894
},

openapi/openapiv3.yaml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13495,7 +13495,15 @@ components:
1349513495
version:
1349613496
allOf:
1349713497
- $ref: '#/components/schemas/WorkerDeploymentVersion'
13498-
description: Required.
13498+
description: |-
13499+
Specifies the Worker Deployment Version to pin this workflow to.
13500+
Required if the target workflow is not already pinned to a version.
13501+
13502+
If omitted and the target workflow is already pinned, the effective
13503+
pinned version will be the existing pinned version.
13504+
13505+
If omitted and the target workflow is not pinned, the override request
13506+
will be rejected with a PreconditionFailed error.
1349913507
WaitPolicy:
1350013508
type: object
1350113509
properties:

temporal/api/workflow/v1/message.proto

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -587,7 +587,15 @@ message VersioningOverride {
587587
// Defaults to PINNED_OVERRIDE_BEHAVIOR_UNSPECIFIED.
588588
// See `PinnedOverrideBehavior` for details.
589589
PinnedOverrideBehavior behavior = 1;
590-
// Required.
590+
591+
// Specifies the Worker Deployment Version to pin this workflow to.
592+
// Required if the target workflow is not already pinned to a version.
593+
//
594+
// If omitted and the target workflow is already pinned, the effective
595+
// pinned version will be the existing pinned version.
596+
//
597+
// If omitted and the target workflow is not pinned, the override request
598+
// will be rejected with a PreconditionFailed error.
591599
temporal.api.deployment.v1.WorkerDeploymentVersion version = 2;
592600
}
593601

0 commit comments

Comments
 (0)