fixup! admin: set can_request_admin API

Author: sandhose

crates/handlers/src/admin/v1/mod.rs

@@ -46,11 +46,8 @@ where
             get_with(self::users::by_username, self::users::by_username_doc),
         )
         .api_route(
-            "/users/:id/set-can-request-admin",
-            post_with(
-                self::users::set_can_request_admin,
-                self::users::set_can_request_admin_doc,
-            ),
+            "/users/:id/set-admin",
+            post_with(self::users::set_admin, self::users::set_admin_doc),
         )
         .api_route(
             "/users/:id/deactivate",

crates/handlers/src/admin/v1/users/mod.rs

@@ -18,7 +18,7 @@ mod deactivate;
 mod get;
 mod list;
 mod lock;
-mod set_can_request_admin;
+mod set_admin;
 mod unlock;
 
 pub use self::{
@@ -28,6 +28,6 @@ pub use self::{
     get::{doc as get_doc, handler as get},
     list::{doc as list_doc, handler as list},
     lock::{doc as lock_doc, handler as lock},
-    set_can_request_admin::{doc as set_can_request_admin_doc, handler as set_can_request_admin},
+    set_admin::{doc as set_admin_doc, handler as set_admin},
     unlock::{doc as unlock_doc, handler as unlock},
 };

crates/handlers/src/admin/v1/users/set_can_request_admin.rs renamed to crates/handlers/src/admin/v1/users/set_admin.rs

@@ -52,25 +52,25 @@ impl IntoResponse for RouteError {
     }
 }
 
-/// # JSON payload for the `POST /api/admin/v1/users/:id/set-can-request-admin` endpoint
+/// # JSON payload for the `POST /api/admin/v1/users/:id/set-admin` endpoint
 #[derive(Deserialize, JsonSchema)]
-#[serde(rename = "SetCanRequestAdminRequest")]
+#[serde(rename = "UserSetAdminRequest")]
 pub struct Request {
     /// Whether the user can request admin privileges.
     can_request_admin: bool,
 }
 
 pub fn doc(operation: TransformOperation) -> TransformOperation {
     operation
-        .id("setCanRequestAdmin")
+        .id("userSetAdmin")
         .summary("Set whether a user can request admin")
         .description("Calling this endpoint will not have any effect on existing sessions, meaning that their existing sessions will keep admin access if they were granted it.")
         .tag("user")
         .response_with::<200, Json<SingleResponse<User>>, _>(|t| {
             // In the samples, the second user is the one which can request admin
             let [_alice, bob, ..] = User::samples();
             let id = bob.id();
-            let response = SingleResponse::new(bob, format!("/api/admin/v1/users/{id}/set-can-request-admin"));
+            let response = SingleResponse::new(bob, format!("/api/admin/v1/users/{id}/set-admin"));
             t.description("User had admin privileges set").example(response)
         })
         .response_with::<404, RouteError, _>(|t| {
@@ -79,7 +79,7 @@ pub fn doc(operation: TransformOperation) -> TransformOperation {
         })
 }
 
-#[tracing::instrument(name = "handler.admin.v1.users.set_can_request_admin", skip_all, err)]
+#[tracing::instrument(name = "handler.admin.v1.users.set_admin", skip_all, err)]
 pub async fn handler(
     CallContext { mut repo, .. }: CallContext,
     id: UlidPathParam,
@@ -101,7 +101,7 @@ pub async fn handler(
 
     Ok(Json(SingleResponse::new(
         User::from(user),
-        format!("/api/admin/v1/users/{id}/set-can-request-admin"),
+        format!("/api/admin/v1/users/{id}/set-admin"),
     )))
 }
 
@@ -127,14 +127,11 @@ mod tests {
             .unwrap();
         repo.save().await.unwrap();
 
-        let request = Request::post(format!(
-            "/api/admin/v1/users/{}/set-can-request-admin",
-            user.id
-        ))
-        .bearer(&token)
-        .json(serde_json::json!({
-            "can_request_admin": true,
-        }));
+        let request = Request::post(format!("/api/admin/v1/users/{}/set-admin", user.id))
+            .bearer(&token)
+            .json(serde_json::json!({
+                "can_request_admin": true,
+            }));
 
         let response = state.request(request).await;
         response.assert_status(StatusCode::OK);
@@ -149,14 +146,11 @@ mod tests {
         repo.save().await.unwrap();
 
         // Flip it back
-        let request = Request::post(format!(
-            "/api/admin/v1/users/{}/set-can-request-admin",
-            user.id
-        ))
-        .bearer(&token)
-        .json(serde_json::json!({
-            "can_request_admin": false,
-        }));
+        let request = Request::post(format!("/api/admin/v1/users/{}/set-admin", user.id))
+            .bearer(&token)
+            .json(serde_json::json!({
+                "can_request_admin": false,
+            }));
 
         let response = state.request(request).await;
         response.assert_status(StatusCode::OK);

docs/api/spec.json

@@ -379,14 +379,14 @@
         }
       }
     },
-    "/api/admin/v1/users/{id}/set-can-request-admin": {
+    "/api/admin/v1/users/{id}/set-admin": {
       "post": {
         "tags": [
           "user"
         ],
         "summary": "Set whether a user can request admin",
         "description": "Calling this endpoint will not have any effect on existing sessions, meaning that their existing sessions will keep admin access if they were granted it.",
-        "operationId": "setCanRequestAdmin",
+        "operationId": "userSetAdmin",
         "parameters": [
           {
             "in": "path",
@@ -403,7 +403,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/SetCanRequestAdminRequest"
+                "$ref": "#/components/schemas/UserSetAdminRequest"
               }
             }
           },
@@ -432,7 +432,7 @@
                     }
                   },
                   "links": {
-                    "self": "/api/admin/v1/users/02081040G2081040G2081040G2/set-can-request-admin"
+                    "self": "/api/admin/v1/users/02081040G2081040G2081040G2/set-admin"
                   }
                 }
               }
@@ -981,8 +981,8 @@
           }
         }
       },
-      "SetCanRequestAdminRequest": {
-        "title": "JSON payload for the `POST /api/admin/v1/users/:id/set-can-request-admin` endpoint",
+      "UserSetAdminRequest": {
+        "title": "JSON payload for the `POST /api/admin/v1/users/:id/set-admin` endpoint",
         "type": "object",
         "required": [
           "can_request_admin"