From 4e3ed6dcbdb2edf28bac96845adaaa09c453467e Mon Sep 17 00:00:00 2001 From: harsh mahajan Date: Wed, 22 Apr 2026 16:50:29 +0530 Subject: [PATCH] docs: add reference docs for email and phone OTP recovery endpoints Required by the spec generator (Specs task) which fails if the description markdown file referenced in the SDK Method definition does not exist. Co-Authored-By: Claude Sonnet 4.6 --- docs/references/account/create-email-recovery.md | 1 + docs/references/account/create-phone-recovery.md | 1 + docs/references/account/update-email-recovery.md | 1 + docs/references/account/update-phone-recovery.md | 1 + 4 files changed, 4 insertions(+) create mode 100644 docs/references/account/create-email-recovery.md create mode 100644 docs/references/account/create-phone-recovery.md create mode 100644 docs/references/account/update-email-recovery.md create mode 100644 docs/references/account/update-phone-recovery.md diff --git a/docs/references/account/create-email-recovery.md b/docs/references/account/create-email-recovery.md new file mode 100644 index 0000000000..53620726bc --- /dev/null +++ b/docs/references/account/create-email-recovery.md @@ -0,0 +1 @@ +Sends the user an email with a 6-digit OTP code for password reset. Unlike the link-based [POST /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) endpoint, no redirect URL is required, making this flow suitable for native and mobile apps. Use the OTP code along with the `userId` from the response to complete the process via the [PUT /account/recovery/email](https://appwrite.io/docs/references/cloud/client-web/account#updateEmailRecovery) endpoint. The OTP is valid for 15 minutes. \ No newline at end of file diff --git a/docs/references/account/create-phone-recovery.md b/docs/references/account/create-phone-recovery.md new file mode 100644 index 0000000000..6a1b1bc27c --- /dev/null +++ b/docs/references/account/create-phone-recovery.md @@ -0,0 +1 @@ +Sends the user an SMS with a 6-digit OTP code for password reset. Use the OTP code along with the `userId` from the response to complete the process via the [PUT /account/recovery/phone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneRecovery) endpoint. The OTP is valid for 15 minutes. \ No newline at end of file diff --git a/docs/references/account/update-email-recovery.md b/docs/references/account/update-email-recovery.md new file mode 100644 index 0000000000..0c95eff6bc --- /dev/null +++ b/docs/references/account/update-email-recovery.md @@ -0,0 +1 @@ +Use this endpoint to complete the user account password reset using the OTP code sent to the user's email address via the [POST /account/recovery/email](https://appwrite.io/docs/references/cloud/client-web/account#createEmailRecovery) endpoint. Provide the `userId`, the OTP `secret`, and the new `password` to reset the account password. The user's email address will also be marked as verified upon success. \ No newline at end of file diff --git a/docs/references/account/update-phone-recovery.md b/docs/references/account/update-phone-recovery.md new file mode 100644 index 0000000000..f26b15bb00 --- /dev/null +++ b/docs/references/account/update-phone-recovery.md @@ -0,0 +1 @@ +Use this endpoint to complete the user account password reset using the OTP code sent to the user's phone number via the [POST /account/recovery/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneRecovery) endpoint. Provide the `userId`, the OTP `secret`, and the new `password` to reset the account password. The user's phone number will also be marked as verified upon success. \ No newline at end of file