From b48a8fc711b06bf3a0d876d145291feb73bfbbcf Mon Sep 17 00:00:00 2001
From: Brendan Golden <git@brendan.ie>
Date: Sun, 6 Aug 2023 14:43:49 +0100
Subject: [PATCH] doc: update documentation and comments

---
 README.md   | 4 ++--
 src/main.rs | 5 +++++
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 215dce5..2be985f 100644
--- a/README.md
+++ b/README.md
@@ -81,7 +81,7 @@ Invalid Auth:
 
 Generic responses which is used unless otherwise specified above.
 
-### POST /ldap/reset
+### POST /ldap/recover/password
 
 ```json
 {
@@ -95,7 +95,7 @@ All responses:
 {"result": "success"}
 ```
 
-### POST /ldap/reset/auth
+### POST /ldap/recover/password/auth
 
 ```json
 { 
diff --git a/src/main.rs b/src/main.rs
index 30b436c..1f7c3ff 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -20,9 +20,14 @@ async fn main() -> tide::Result<()> {
 
     let mut app = tide::with_state(state);
 
+    // for users to update their own profile
     app.at("/ldap/update").post(account_update::submit);
+    
+    // for new users
     app.at("/ldap/new/email").post(account_new::email::submit);
     app.at("/ldap/new/account").post(account_new::account::submit);
+    
+    // for folks who forget password/username
     app.at("/ldap/recover/password").post(account_recover::password::reset);
     app.at("/ldap/recover/password/auth").post(account_recover::password::auth);