Skip to content

Commit

Permalink
Fix incorrect "compatible" spelling 🤦 (#268)
Browse files Browse the repository at this point in the history
In build id ordering APIs
  • Loading branch information
Sushisource committed Mar 22, 2023
1 parent c5af469 commit ae312b0
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion temporal/api/history/v1/message.proto
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ message WorkflowTaskCompletedEventAttributes {
string binary_checksum = 4;
// Version info of the worker who processed this workflow task, or missing if worker is not
// using versioning. If present, the `build_id` field within is also used as `binary_checksum`,
// which may be omitted in that case (it may also be populated to preserve compatability).
// which may be omitted in that case (it may also be populated to preserve compatibility).
temporal.api.common.v1.WorkerVersionStamp worker_version = 5;
// Data the SDK wishes to record for itself, but server need not interpret, and does not
// directly impact workflow state.
Expand Down
22 changes: 11 additions & 11 deletions temporal/api/workflowservice/v1/request_response.proto
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ message PollWorkflowTaskQueueRequest {
string binary_checksum = 4;
// If set, the worker is opting in to versioning and wishes to only
// receive tasks that are considered compatible with the version capabilities provided.
// Doing so only makes sense in conjunction with the `UpdateWorkerBuildIdOrdering` API.
// Doing so only makes sense in conjunction with the `UpdateWorkerBuildIdCompatibility` API.
// When this field has a `worker_build_id`, and `binary_checksum` is not
// set, that value should also be considered as the `binary_checksum`.
temporal.api.common.v1.WorkerVersionCapabilities worker_version_capabilities = 5;
Expand Down Expand Up @@ -366,7 +366,7 @@ message PollActivityTaskQueueRequest {
temporal.api.taskqueue.v1.TaskQueueMetadata task_queue_metadata = 4;
// If set, the worker is opting in to versioning and wishes to only
// receive tasks that are considered compatible with the capabilities provided.
// Doing so only makes sense in conjunction with the `UpdateWorkerBuildIdOrdering` API.
// Doing so only makes sense in conjunction with the `UpdateWorkerBuildIdCompatibility` API.
temporal.api.common.v1.WorkerVersionCapabilities worker_version_capabilities = 5;
}

Expand Down Expand Up @@ -1054,10 +1054,10 @@ message ListSchedulesResponse {
}

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

// (-- api-linter: core::0134::request-resource-required=disabled
// aip.dev/not-precedent: GetWorkerBuildIdOrderingRequest RPC doesn't follow Google API format. --)
message GetWorkerBuildIdCompatabilityRequest {
// aip.dev/not-precedent: GetWorkerBuildIdCompatibilityRequest RPC doesn't follow Google API format. --)
message GetWorkerBuildIdCompatibilityRequest {
string namespace = 1;
// Must be set, the task queue to interrogate about worker id ordering
// Must be set, the task queue to interrogate about worker id compatibility.
string task_queue = 2;
// Limits how many compatible sets will be returned. Specify 1 to only return the current
// default major version set. 0 returns all sets.
Expand All @@ -1119,9 +1119,9 @@ message GetWorkerBuildIdCompatabilityRequest {
bool include_retirement_candidates = 4;
// If set, the response will include information about which versions have open workflows, and
// whether or not there are currently polling workers who are compatible with those versions.
bool include_poller_compatability = 5;
bool include_poller_compatibility = 5;
}
message GetWorkerBuildIdCompatabilityResponse {
message GetWorkerBuildIdCompatibilityResponse {
// Major version sets, in order from oldest to newest. The last element of the list will always
// be the current default major version. IE: New workflows will target the most recent version
// in that version set.
Expand Down
8 changes: 4 additions & 4 deletions temporal/api/workflowservice/v1/service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -386,12 +386,12 @@ service WorkflowService {
// members are compatible with one another.
//
// (-- api-linter: core::0134::response-message-name=disabled
// aip.dev/not-precedent: UpdateWorkerBuildIdOrdering RPC doesn't follow Google API format. --)
// aip.dev/not-precedent: UpdateWorkerBuildIdCompatibility RPC doesn't follow Google API format. --)
// (-- api-linter: core::0134::method-signature=disabled
// aip.dev/not-precedent: UpdateWorkerBuildIdOrdering RPC doesn't follow Google API format. --)
rpc UpdateWorkerBuildIdCompatability (UpdateWorkerBuildIdCompatabilityRequest) returns (UpdateWorkerBuildIdCompatabilityResponse) {}
// aip.dev/not-precedent: UpdateWorkerBuildIdCompatibility RPC doesn't follow Google API format. --)
rpc UpdateWorkerBuildIdCompatibility (UpdateWorkerBuildIdCompatibilityRequest) returns (UpdateWorkerBuildIdCompatibilityResponse) {}
// Fetches the worker build id versioning sets for some task queue and related metadata.
rpc GetWorkerBuildIdCompatability (GetWorkerBuildIdCompatabilityRequest) returns (GetWorkerBuildIdCompatabilityResponse) {}
rpc GetWorkerBuildIdCompatibility (GetWorkerBuildIdCompatibilityRequest) returns (GetWorkerBuildIdCompatibilityResponse) {}

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

0 comments on commit ae312b0

Please sign in to comment.