Skip to content

Update descriptions of WorkflowService and OperatorService #618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update descriptions of WorkflowService and OperatorService #618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions temporal/api/operatorservice/v1/service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ option csharp_namespace = "Temporalio.Api.OperatorService.V1";
import "temporal/api/operatorservice/v1/request_response.proto";
import "google/api/annotations.proto";

// OperatorService API defines how Temporal SDKs and other clients interact with the Temporal server
// to perform administrative functions like registering a search attribute or a namespace.
// APIs in this file could be not compatible with Temporal Cloud, hence it's usage in SDKs should be limited by
// designated APIs that clearly state that they shouldn't be used by the main Application (Workflows & Activities) framework.
// The OperatorService API defines how Temporal SDKs and other clients interact with the Temporal server to
// perform administrative functions. APIs in this file may be incompatible with Temporal Cloud, hence its
Copy link
Contributor

@mjameswh mjameswh Jul 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

APIs in this file may be incompatible with Temporal Cloud

Not something you changed, but wondering… Is there even a single API in OperatorService that can be used on Cloud? I don't think so. If none, we should consider making this description more specific.

// usage in SDKs should be limited to APIs that clearly state that they shouldn't be used by the main
Copy link
Member

@cretz cretz Jul 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

usage in SDKs should be limited to APIs that clearly state that they shouldn't be used

Not following what you are meaning here. Is this documentation/notes for the SDK team? It was a bit confusing to read at first putting myself in a user's shoes.

// application framework (Workflows, Nexus Operations, etc)
service OperatorService {
// (-- Search Attribute --)

Expand Down Expand Up @@ -44,6 +44,7 @@ service OperatorService {
}

// DeleteNamespace synchronously deletes a namespace and asynchronously reclaims all namespace resources.
// See workflowservice for other operations on namespaces.
rpc DeleteNamespace (DeleteNamespaceRequest) returns (DeleteNamespaceResponse) {
}

Expand Down
5 changes: 3 additions & 2 deletions temporal/api/workflowservice/v1/service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ option csharp_namespace = "Temporalio.Api.WorkflowService.V1";
import "temporal/api/workflowservice/v1/request_response.proto";
import "google/api/annotations.proto";

// WorkflowService API defines how Temporal SDKs and other clients interact with the Temporal server
// to create and interact with workflows and activities.
// The WorkflowService API defines how Temporal SDKs and other clients interact with the
// Temporal server to perform operations against entities including namespaces, workflows,
// activities, schedules, and nexus operations.
//
// Users are expected to call `StartWorkflowExecution` to create a new workflow execution.
//
Expand Down
Loading