utoipa: Add annotations to /confirm/{email_token} endpoints

Author: Turbo87

src/controllers/user/me.rs

@@ -115,7 +115,14 @@ pub async fn updates(app: AppState, req: Parts) -> AppResult<ErasedJson> {
     }))
 }
 
-/// Handles the `PUT /confirm/:email_token` route
+/// Marks the email belonging to the given token as verified.
+#[utoipa::path(
+    put,
+    path = "/api/v1/confirm/{email_token}",
+    operation_id = "confirm_user_email",
+    tag = "users",
+    responses((status = 200, description = "Successful Response")),
+)]
 pub async fn confirm_user_email(state: AppState, Path(token): Path<String>) -> AppResult<Response> {
     use diesel::update;
 

src/router.rs

@@ -57,13 +57,10 @@ pub fn build_axum_router(state: AppState) -> Router<()> {
         .routes(routes!(crate_owner_invitation::handle_invite_with_token))
         .routes(routes!(user::me::update_email_notifications))
         .routes(routes!(summary::summary))
+        .routes(routes!(user::me::confirm_user_email))
         .split_for_parts();
 
     let mut router = router
-        .route(
-            "/api/v1/confirm/:email_token",
-            put(user::me::confirm_user_email),
-        )
         .route(
             "/api/v1/users/:user_id/resend",
             put(user::regenerate_token_and_send),

src/snapshots/crates_io__openapi__tests__openapi_snapshot.snap

@@ -62,6 +62,20 @@ snapshot_kind: text
         ]
       }
     },
+    "/api/v1/confirm/{email_token}": {
+      "put": {
+        "operationId": "confirm_user_email",
+        "responses": {
+          "200": {
+            "description": "Successful Response"
+          }
+        },
+        "summary": "Marks the email belonging to the given token as verified.",
+        "tags": [
+          "users"
+        ]
+      }
+    },
     "/api/v1/crates": {
       "get": {
         "description": "Called in a variety of scenarios in the front end, including:\n- Alphabetical listing of crates\n- List of crates under a specific owner\n- Listing a user's followed crates",