Skip to content

Commit 63583b7

Browse files
authored
doc(client): Document that OperatorService is incompatible with Cloud (#1276)
1 parent 54cac34 commit 63583b7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

packages/client/src/connection.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,12 @@ export class Connection {
238238
/**
239239
* Raw gRPC access to Temporal Server's
240240
* {@link https://github.com/temporalio/api/blob/master/temporal/api/operatorservice/v1/service.proto | Operator service}
241+
*
242+
* The Operator Service API defines how Temporal SDKs and other clients interact with the Temporal
243+
* server to perform administrative functions like registering a search attribute or a namespace.
244+
*
245+
* This Service API is NOT compatible with Temporal Cloud. Attempt to use it against a Temporal
246+
* Cloud namespace will result in gRPC `unauthorized` error.
241247
*/
242248
public readonly operatorService: OperatorService;
243249
public readonly healthService: HealthService;

0 commit comments

Comments
 (0)