Added api reference for ResponsePayload

firebase · Sep 18, 2023 · 33aba4c · 33aba4c
1 parent c177b42
commit 33aba4c
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/src/common/providers/identity.ts b/src/common/providers/identity.ts
@@ -435,8 +435,9 @@ export interface DecodedPayload {
 }
 
 /**
- * This interface defines the payload to send back to GCIP.
- * The nesting structure different than what customers returned.
+ * Internal definition to include all the fields that can be sent as
+ * a response from the blocking function to the backend.
+ * This is added mainly to have a type definition for 'generateResponsePayload'
  * @internal */
 export interface ResponsePayload {
   userRecord?: UserRecordResponsePayload;