Add comment

Author: trueleo

server/src/handlers/http.rs

@@ -162,11 +162,13 @@ pub fn configure_routes(cfg: &mut web::ServiceConfig) {
                 // GET "/logstream/{logstream}/retention" ==> Get retention for given logstream
                 .route(web::get().to(logstream::get_retention)),
         );
-
     let user_api = web::scope("/user")
+        // POST /user/create/{username} => Create a new user
         .service(web::resource("/create/{username}").route(web::post().to(rbac::put_user)))
-        .service(web::resource("/reset/{username}").route(web::put().to(rbac::reset_password)))
-        .service(web::resource("/delete/{username}").route(web::get().to(rbac::delete_user)));
+        // POST /user/reset/{username} => Reset password for a user
+        .service(web::resource("/reset/{username}").route(web::post().to(rbac::reset_password)))
+        // DELETE /user/delete/{username} => Delete a user
+        .service(web::resource("/delete/{username}").route(web::delete().to(rbac::delete_user)));
 
     cfg.service(
         // Base path "{url}/api/v1"

server/src/handlers/http/rbac.rs

@@ -32,6 +32,9 @@ use tokio::sync::Mutex;
 // async aware lock for updating storage metadata and user map atomicically
 static UPDATE_LOCK: Mutex<()> = Mutex::const_new(());
 
+// Handler for POST /api/v1/user/create/{username}
+// Creates a new user by username
+// returns password generated for this user
 pub async fn put_user(username: web::Path<String>) -> Result<impl Responder, RBACError> {
     let username = username.into_inner();
     validator::verify_username(&username)?;
@@ -57,6 +60,9 @@ pub async fn put_user(username: web::Path<String>) -> Result<impl Responder, RBA
     Ok(password)
 }
 
+// Handler for POST /api/v1/user/reset/{username}
+// Reset password for given username
+// returns new password generated for this user
 pub async fn reset_password(username: web::Path<String>) -> Result<impl Responder, RBACError> {
     let username = username.into_inner();
     let _ = UPDATE_LOCK.lock().await;
@@ -91,6 +97,7 @@ pub async fn reset_password(username: web::Path<String>) -> Result<impl Responde
     Ok(password)
 }
 
+// Handler for DELETE /api/v1/user/delete/{username}
 pub async fn delete_user(username: web::Path<String>) -> Result<impl Responder, RBACError> {
     let username = username.into_inner();
     let _ = UPDATE_LOCK.lock().await;