Skip to content

Commit 69fa653

Browse files
authored
Update doc strings for Worker Deployment (#811)
**What changed?** Update doc strings for Worker Deployment **Why?** These got misplaced during an earlier commit rebase: #810
1 parent 96fb607 commit 69fa653

3 files changed

Lines changed: 20 additions & 19 deletions

File tree

‎openapi/openapiv2.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14719,7 +14719,7 @@
1471914719
"description": "provider_validation encapsulates the health signal for validating the compute provider."
1472014720
}
1472114721
},
14722-
"description": "A Worker Deployment (Deployment, for short) represents all workers serving\na shared set of Task Queues. Typically, a Deployment represents one service or\napplication.\nA Deployment contains multiple Deployment Versions, each representing a different\nversion of workers. (see documentation of WorkerDeploymentVersionInfo)\nDeployment records are created in Temporal server automatically when their\nfirst poller arrives to the server.\nComputeStatus represents compute-related configuration and health checks."
14722+
"description": "ComputeStatus represents compute-related configuration and health for a Worker Deployment Version."
1472314723
},
1472414724
"v1ConfigMetadata": {
1472514725
"type": "object",
@@ -20250,7 +20250,8 @@
2025020250
"$ref": "#/definitions/v1RoutingConfigUpdateState",
2025120251
"description": "Indicates whether the routing_config has been fully propagated to all\nrelevant task queues and their partitions."
2025220252
}
20253-
}
20253+
},
20254+
"description": "A Worker Deployment (Deployment, for short) represents all workers serving\na shared set of Task Queues. Typically, a Deployment represents one service or\napplication.\nA Deployment contains multiple Deployment Versions, each representing a different\nversion of workers. (see documentation of WorkerDeploymentVersionInfo)\nDeployment records are created in Temporal server automatically when their\nfirst poller arrives to the server."
2025420255
},
2025520256
"v1WorkerDeploymentOptions": {
2025620257
"type": "object",

‎openapi/openapiv3.yaml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11118,15 +11118,7 @@ components:
1111811118
allOf:
1111911119
- $ref: '#/components/schemas/ComputeStatus_ProviderValidationStatus'
1112011120
description: provider_validation encapsulates the health signal for validating the compute provider.
11121-
description: |-
11122-
A Worker Deployment (Deployment, for short) represents all workers serving
11123-
a shared set of Task Queues. Typically, a Deployment represents one service or
11124-
application.
11125-
A Deployment contains multiple Deployment Versions, each representing a different
11126-
version of workers. (see documentation of WorkerDeploymentVersionInfo)
11127-
Deployment records are created in Temporal server automatically when their
11128-
first poller arrives to the server.
11129-
ComputeStatus represents compute-related configuration and health checks.
11121+
description: ComputeStatus represents compute-related configuration and health for a Worker Deployment Version.
1113011122
ComputeStatus_ProviderValidationStatus:
1113111123
type: object
1113211124
properties:
@@ -18529,6 +18521,14 @@ components:
1852918521
Indicates whether the routing_config has been fully propagated to all
1853018522
relevant task queues and their partitions.
1853118523
format: enum
18524+
description: |-
18525+
A Worker Deployment (Deployment, for short) represents all workers serving
18526+
a shared set of Task Queues. Typically, a Deployment represents one service or
18527+
application.
18528+
A Deployment contains multiple Deployment Versions, each representing a different
18529+
version of workers. (see documentation of WorkerDeploymentVersionInfo)
18530+
Deployment records are created in Temporal server automatically when their
18531+
first poller arrives to the server.
1853218532
WorkerDeploymentInfo_WorkerDeploymentVersionSummary:
1853318533
type: object
1853418534
properties:

‎temporal/api/deployment/v1/message.proto‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -184,14 +184,7 @@ message VersionDrainageInfo {
184184
google.protobuf.Timestamp last_checked_time = 3;
185185
}
186186

187-
// A Worker Deployment (Deployment, for short) represents all workers serving
188-
// a shared set of Task Queues. Typically, a Deployment represents one service or
189-
// application.
190-
// A Deployment contains multiple Deployment Versions, each representing a different
191-
// version of workers. (see documentation of WorkerDeploymentVersionInfo)
192-
// Deployment records are created in Temporal server automatically when their
193-
// first poller arrives to the server.
194-
// ComputeStatus represents compute-related configuration and health checks.
187+
// ComputeStatus represents compute-related configuration and health for a Worker Deployment Version.
195188
message ComputeStatus {
196189
// ProviderValidationStatus represents the result of the most recent
197190
// connectivity check between Temporal and a customer's compute provider.
@@ -206,6 +199,13 @@ message ComputeStatus {
206199
ProviderValidationStatus provider_validation = 1;
207200
}
208201

202+
// A Worker Deployment (Deployment, for short) represents all workers serving
203+
// a shared set of Task Queues. Typically, a Deployment represents one service or
204+
// application.
205+
// A Deployment contains multiple Deployment Versions, each representing a different
206+
// version of workers. (see documentation of WorkerDeploymentVersionInfo)
207+
// Deployment records are created in Temporal server automatically when their
208+
// first poller arrives to the server.
209209
message WorkerDeploymentInfo {
210210
// Identifies a Worker Deployment. Must be unique within the namespace.
211211
string name = 1;

0 commit comments

Comments
 (0)