fixup! Polish the password recovery page

element-hq · Jan 9, 2025 · 8a69c9a · 8a69c9a
1 parent 20aa7ce
commit 8a69c9a
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/crates/handlers/src/graphql/mutations/user.rs b/crates/handlers/src/graphql/mutations/user.rs
@@ -822,6 +822,10 @@ impl UserMutations {
     }
 
     /// Resend a user recovery email
+    ///
+    /// This is used when a user opens a recovery link that has expired. In this
+    /// case, we display a link for them to get a new recovery email, which
+    /// calls this mutation.
     pub async fn resend_recovery_email(
         &self,
         ctx: &Context<'_>,

diff --git a/frontend/schema.graphql b/frontend/schema.graphql
@@ -805,6 +805,10 @@ type Mutation {
   setPasswordByRecovery(input: SetPasswordByRecoveryInput!): SetPasswordPayload!
   """
   Resend a user recovery email
+
+  This is used when a user opens a recovery link that has expired. In this
+  case, we display a link for them to get a new recovery email, which
+  calls this mutation.
   """
   resendRecoveryEmail(
     input: ResendRecoveryEmailInput!

diff --git a/frontend/src/gql/graphql.ts b/frontend/src/gql/graphql.ts
@@ -493,7 +493,13 @@ export type Mutation = {
   lockUser: LockUserPayload;
   /** Remove an email address */
   removeEmail: RemoveEmailPayload;
-  /** Resend a user recovery email */
+  /**
+   * Resend a user recovery email
+   *
+   * This is used when a user opens a recovery link that has expired. In this
+   * case, we display a link for them to get a new recovery email, which
+   * calls this mutation.
+   */
   resendRecoveryEmail: ResendRecoveryEmailPayload;
   /** Send a verification code for an email address */
   sendVerificationEmail: SendVerificationEmailPayload;