Skip to content

Commit 89043f6

Browse files
committed
chore: doc for placement field
1 parent a43e456 commit 89043f6

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/types.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,11 @@ export type AppSettingsAPIResponse = APIResponse & {
162162
name?: string;
163163
organization?: string;
164164
permission_version?: string;
165+
/**
166+
* The placement of the app in the form of `${region}.${shard}`.
167+
* Examples: "us-east.c1", "dublin.c3", "singapore.c2"
168+
* Note: The backend may add/remove regions or shards occasionally.
169+
*/
165170
placement?: string;
166171
policies?: Record<string, Policy[]>;
167172
poll_enabled?: boolean;

0 commit comments

Comments
 (0)