From 511bed1334219d55632e9a9991bc9bda5cf9194d Mon Sep 17 00:00:00 2001 From: Izaak Gough Date: Thu, 18 Jun 2026 16:16:40 +0100 Subject: [PATCH] docs: align docs with actual auth/authType behaviour --- src/v1/cloud-functions.ts | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/src/v1/cloud-functions.ts b/src/v1/cloud-functions.ts index 12fba6087..e80dce43f 100644 --- a/src/v1/cloud-functions.ts +++ b/src/v1/cloud-functions.ts @@ -98,10 +98,13 @@ export interface EventContext> { * For more detail including token keys, see the * {@link https://firebase.google.com/docs/reference/rules/rules#properties | security rules reference}. * - * This field is only populated for Realtime Database triggers and Callable - * functions. For an unauthenticated user, this field is null. For Firebase + * This field is only populated for Realtime Database triggers. For an + * unauthenticated Realtime Database user, this field is `null`. For Firebase * admin users and event types that do not provide user information, this field - * does not exist. + * is not set. + * + * Callable functions use {@link https.CallableContext.auth} instead of + * `EventContext.auth`. */ auth?: { uid: string; @@ -122,8 +125,8 @@ export interface EventContext> { * * - `UNAUTHENTICATED`: Unauthenticated action * - * - `null`: For event types that do not provide user information (all except - * Realtime Database). + * This field is only populated for Realtime Database triggers. For event + * types that do not provide user information, this field is not set. */ authType?: "ADMIN" | "USER" | "UNAUTHENTICATED";