utoipa: Add annotations to /me/email_notifications endpoints

Author: Turbo87

src/controllers/user/me.rs

@@ -133,7 +133,18 @@ pub async fn confirm_user_email(state: AppState, Path(token): Path<String>) -> A
     ok_true()
 }
 
-/// Handles `PUT /me/email_notifications` route
+/// Update email notification settings for the authenticated user.
+///
+/// This endpoint was implemented for an experimental feature that was never
+/// fully implemented. It is now deprecated and will be removed in the future.
+#[utoipa::path(
+    put,
+    path = "/api/v1/me/email_notifications",
+    operation_id = "update_email_notifications",
+    tag = "users",
+    responses((status = 200, description = "Successful Response")),
+)]
+#[deprecated]
 pub async fn update_email_notifications(app: AppState, req: BytesRequest) -> AppResult<Response> {
     use diesel::pg::upsert::excluded;
 

src/router.rs

@@ -55,13 +55,10 @@ pub fn build_axum_router(state: AppState) -> Router<()> {
         .routes(routes!(crate_owner_invitation::list))
         .routes(routes!(crate_owner_invitation::handle_invite))
         .routes(routes!(crate_owner_invitation::handle_invite_with_token))
+        .routes(routes!(user::me::update_email_notifications))
         .split_for_parts();
 
     let mut router = router
-        .route(
-            "/api/v1/me/email_notifications",
-            put(user::me::update_email_notifications),
-        )
         .route("/api/v1/summary", get(summary::summary))
         .route(
             "/api/v1/confirm/:email_token",

src/snapshots/crates_io__openapi__tests__openapi_snapshot.snap

@@ -496,6 +496,22 @@ snapshot_kind: text
         ]
       }
     },
+    "/api/v1/me/email_notifications": {
+      "put": {
+        "deprecated": true,
+        "description": "This endpoint was implemented for an experimental feature that was never\nfully implemented. It is now deprecated and will be removed in the future.",
+        "operationId": "update_email_notifications",
+        "responses": {
+          "200": {
+            "description": "Successful Response"
+          }
+        },
+        "summary": "Update email notification settings for the authenticated user.",
+        "tags": [
+          "users"
+        ]
+      }
+    },
     "/api/v1/me/tokens": {
       "get": {
         "operationId": "list_api_tokens",