Update descriptions of WorkflowService and OperatorService #618
+8
−6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mjameswh
reviewed
Jul 22, 2025
| // 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 |
There was a problem hiding this comment.
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.
cretz
reviewed
Jul 22, 2025
| // 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 | ||
| // usage in SDKs should be limited to APIs that clearly state that they shouldn't be used by the main |
There was a problem hiding this comment.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Small improvements to descriptions of the services. E.g.