Merge pull request #7575 from BitGo/WP-6950-pending-approval

docs(express): pendingApprovalV1 API definition

Author: lokesh-bitgo

modules/express/src/typedRoutes/api/v1/pendingApproval.ts

@@ -8,27 +8,53 @@ export const pendingApprovalRequestParams = {
 };
 
 export const pendingApprovalRequestBody = {
-  /** State of the approval: 'approved' to approve, omit or 'rejected' to reject (defaults to rejection) */
+  /** State of the approval: 'approved' to approve, any other value or omit to reject (defaults to rejection) */
   state: optional(t.string),
-  /** Wallet passphrase for decrypting user keys (required for transaction signing) */
+  /** Wallet passphrase for transaction signing (required for transactionRequest approvals unless tx or xprv provided) */
   walletPassphrase: optional(t.string),
   /** One-time password for 2FA verification */
   otp: optional(t.string),
-  /** Transaction hex to use instead of the original transaction */
+  /** Pre-signed transaction hex to use instead of reconstructing (for transactionRequest approvals) */
   tx: optional(t.string),
-  /** Private key in string form (as an alternative to wallet passphrase) */
+  /** Extended private key as alternative to walletPassphrase (for transactionRequest approvals) */
   xprv: optional(t.string),
-  /** If true, returns information about pending transactions without approving */
+  /** If true, returns information about pending transactions without approving (unused in V1) */
   previewPendingTxs: optional(t.boolean),
-  /** Alternative ID for the pending approval */
+  /** Alternative ID for the pending approval (unused in V1) */
   pendingApprovalId: optional(t.string),
 };
 
 /**
- * Pending Approval Request
- * Approve or reject a pending approval by its ID.
- * Handles various approval scenarios including transaction approvals, policy rule changes,
- * and user change requests.
+ * Approve or reject a pending approval
+ *
+ * Updates the state of a pending approval to either 'approved' or 'rejected' based on the
+ * state parameter. If state is 'approved', the approval is approved; otherwise, it is rejected.
+ * Default behavior (when state is omitted) is rejection.
+ *
+ * **Approval Types:**
+ * - **transactionRequest**: Transaction approvals (may require walletPassphrase for signing)
+ * - **policyRuleRequest**: Policy changes (no transaction signing needed)
+ * - **tagUpdateRequest**: Tag updates
+ * - Other types: User changes, enterprise updates, etc.
+ *
+ * **Transaction Approval Behavior (transactionRequest type):**
+ * - If `tx` provided: Uses the provided transaction hex directly
+ * - If `walletPassphrase` or `xprv` provided: Reconstructs and signs transaction with current unspents
+ * - If neither provided: Uses original transaction (works for sweeps and view-only approvers)
+ * - Automatically retries with reconstruction if unspents expire during approval
+ *
+ * **Multi-Approval Wallets:**
+ * If approvalsRequired > 1, the state may be 'pending' after approval (not 'approved' until
+ * all required approvals are received).
+ *
+ * **Response:** Returns the updated pending approval object including:
+ * - id: Pending approval ID
+ * - state: Current state ('approved', 'rejected', 'pending', or 'canceled')
+ * - info: Approval-specific information (transactionRequest, policyRuleRequest, etc.)
+ * - walletId: Wallet ID (if wallet-owned)
+ * - enterprise: Enterprise ID (if enterprise-owned)
+ * - creator: User ID who created the approval
+ * - approvalsRequired: Number of approvals needed (for multi-approval wallets)
  *
  * @operationId express.v1.pendingapprovals
  * @tag express
@@ -42,9 +68,9 @@ export const PutPendingApproval = httpRoute({
     body: pendingApprovalRequestBody,
   }),
   response: {
-    /** Successfully updated pending approval */
+    /** Successfully updated pending approval. Returns the updated pending approval object with new state and info. */
     200: t.UnknownRecord,
-    /** Error response */
+    /** Error response (e.g., invalid ID, insufficient permissions, missing authentication, unspents expired without passphrase) */
     400: BitgoExpressError,
   },
 });