Skip to content

Commit ae312b0

Browse files
authored
Fix incorrect "compatible" spelling 🤦 (#268)
In build id ordering APIs
1 parent c5af469 commit ae312b0

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

Diff for: ‎temporal/api/history/v1/message.proto

+1-1
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ message WorkflowTaskCompletedEventAttributes {
195195
string binary_checksum = 4;
196196
// Version info of the worker who processed this workflow task, or missing if worker is not
197197
// using versioning. If present, the `build_id` field within is also used as `binary_checksum`,
198-
// which may be omitted in that case (it may also be populated to preserve compatability).
198+
// which may be omitted in that case (it may also be populated to preserve compatibility).
199199
temporal.api.common.v1.WorkerVersionStamp worker_version = 5;
200200
// Data the SDK wishes to record for itself, but server need not interpret, and does not
201201
// directly impact workflow state.

Diff for: ‎temporal/api/workflowservice/v1/request_response.proto

+11-11
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ message PollWorkflowTaskQueueRequest {
243243
string binary_checksum = 4;
244244
// If set, the worker is opting in to versioning and wishes to only
245245
// receive tasks that are considered compatible with the version capabilities provided.
246-
// Doing so only makes sense in conjunction with the `UpdateWorkerBuildIdOrdering` API.
246+
// Doing so only makes sense in conjunction with the `UpdateWorkerBuildIdCompatibility` API.
247247
// When this field has a `worker_build_id`, and `binary_checksum` is not
248248
// set, that value should also be considered as the `binary_checksum`.
249249
temporal.api.common.v1.WorkerVersionCapabilities worker_version_capabilities = 5;
@@ -366,7 +366,7 @@ message PollActivityTaskQueueRequest {
366366
temporal.api.taskqueue.v1.TaskQueueMetadata task_queue_metadata = 4;
367367
// If set, the worker is opting in to versioning and wishes to only
368368
// receive tasks that are considered compatible with the capabilities provided.
369-
// Doing so only makes sense in conjunction with the `UpdateWorkerBuildIdOrdering` API.
369+
// Doing so only makes sense in conjunction with the `UpdateWorkerBuildIdCompatibility` API.
370370
temporal.api.common.v1.WorkerVersionCapabilities worker_version_capabilities = 5;
371371
}
372372

@@ -1054,10 +1054,10 @@ message ListSchedulesResponse {
10541054
}
10551055

10561056
// (-- api-linter: core::0134::request-mask-required=disabled
1057-
// aip.dev/not-precedent: UpdateWorkerBuildIdOrderingRequest doesn't follow Google API format --)
1057+
// aip.dev/not-precedent: UpdateWorkerBuildIdCompatibilityRequest doesn't follow Google API format --)
10581058
// (-- api-linter: core::0134::request-resource-required=disabled
1059-
// aip.dev/not-precedent: UpdateWorkerBuildIdOrderingRequest RPC doesn't follow Google API format. --)
1060-
message UpdateWorkerBuildIdCompatabilityRequest {
1059+
// aip.dev/not-precedent: UpdateWorkerBuildIdCompatibilityRequest RPC doesn't follow Google API format. --)
1060+
message UpdateWorkerBuildIdCompatibilityRequest {
10611061
message AddNewCompatibleVersion {
10621062
// A new id to be added to an existing compatible set.
10631063
string new_build_id = 1;
@@ -1099,17 +1099,17 @@ message UpdateWorkerBuildIdCompatabilityRequest {
10991099
string promote_build_id_within_set = 6;
11001100
}
11011101
}
1102-
message UpdateWorkerBuildIdCompatabilityResponse {
1102+
message UpdateWorkerBuildIdCompatibilityResponse {
11031103
// The id of the compatible set that the updated version was added to, or exists in. Users don't
11041104
// need to understand or care about this value, but it has value for debugging purposes.
11051105
string version_set_id = 1;
11061106
}
11071107

11081108
// (-- api-linter: core::0134::request-resource-required=disabled
1109-
// aip.dev/not-precedent: GetWorkerBuildIdOrderingRequest RPC doesn't follow Google API format. --)
1110-
message GetWorkerBuildIdCompatabilityRequest {
1109+
// aip.dev/not-precedent: GetWorkerBuildIdCompatibilityRequest RPC doesn't follow Google API format. --)
1110+
message GetWorkerBuildIdCompatibilityRequest {
11111111
string namespace = 1;
1112-
// Must be set, the task queue to interrogate about worker id ordering
1112+
// Must be set, the task queue to interrogate about worker id compatibility.
11131113
string task_queue = 2;
11141114
// Limits how many compatible sets will be returned. Specify 1 to only return the current
11151115
// default major version set. 0 returns all sets.
@@ -1119,9 +1119,9 @@ message GetWorkerBuildIdCompatabilityRequest {
11191119
bool include_retirement_candidates = 4;
11201120
// If set, the response will include information about which versions have open workflows, and
11211121
// whether or not there are currently polling workers who are compatible with those versions.
1122-
bool include_poller_compatability = 5;
1122+
bool include_poller_compatibility = 5;
11231123
}
1124-
message GetWorkerBuildIdCompatabilityResponse {
1124+
message GetWorkerBuildIdCompatibilityResponse {
11251125
// Major version sets, in order from oldest to newest. The last element of the list will always
11261126
// be the current default major version. IE: New workflows will target the most recent version
11271127
// in that version set.

Diff for: ‎temporal/api/workflowservice/v1/service.proto

+4-4
Original file line numberDiff line numberDiff line change
@@ -386,12 +386,12 @@ service WorkflowService {
386386
// members are compatible with one another.
387387
//
388388
// (-- api-linter: core::0134::response-message-name=disabled
389-
// aip.dev/not-precedent: UpdateWorkerBuildIdOrdering RPC doesn't follow Google API format. --)
389+
// aip.dev/not-precedent: UpdateWorkerBuildIdCompatibility RPC doesn't follow Google API format. --)
390390
// (-- api-linter: core::0134::method-signature=disabled
391-
// aip.dev/not-precedent: UpdateWorkerBuildIdOrdering RPC doesn't follow Google API format. --)
392-
rpc UpdateWorkerBuildIdCompatability (UpdateWorkerBuildIdCompatabilityRequest) returns (UpdateWorkerBuildIdCompatabilityResponse) {}
391+
// aip.dev/not-precedent: UpdateWorkerBuildIdCompatibility RPC doesn't follow Google API format. --)
392+
rpc UpdateWorkerBuildIdCompatibility (UpdateWorkerBuildIdCompatibilityRequest) returns (UpdateWorkerBuildIdCompatibilityResponse) {}
393393
// Fetches the worker build id versioning sets for some task queue and related metadata.
394-
rpc GetWorkerBuildIdCompatability (GetWorkerBuildIdCompatabilityRequest) returns (GetWorkerBuildIdCompatabilityResponse) {}
394+
rpc GetWorkerBuildIdCompatibility (GetWorkerBuildIdCompatibilityRequest) returns (GetWorkerBuildIdCompatibilityResponse) {}
395395

396396
// Invokes the specified update function on user workflow code.
397397
// (-- api-linter: core::0134=disabled

0 commit comments

Comments
 (0)