utoipa: Add annotations to /summary endpoints

Author: Turbo87

src/controllers/summary.rs

@@ -12,7 +12,17 @@ use diesel_async::{AsyncPgConnection, RunQueryDsl};
 use futures_util::FutureExt;
 use std::future::Future;
 
-/// Handles the `GET /summary` route.
+/// Get front page data.
+///
+/// This endpoint returns a summary of the most important data for the front
+/// page of crates.io.
+#[utoipa::path(
+    get,
+    path = "/api/v1/summary",
+    operation_id = "get_summary",
+    tag = "other",
+    responses((status = 200, description = "Successful Response")),
+)]
 pub async fn summary(state: AppState) -> AppResult<ErasedJson> {
     let mut conn = state.db_read().await?;
 

src/router.rs

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

src/snapshots/crates_io__openapi__tests__openapi_snapshot.snap

@@ -578,6 +578,21 @@ snapshot_kind: text
         ]
       }
     },
+    "/api/v1/summary": {
+      "get": {
+        "description": "This endpoint returns a summary of the most important data for the front\npage of crates.io.",
+        "operationId": "get_summary",
+        "responses": {
+          "200": {
+            "description": "Successful Response"
+          }
+        },
+        "summary": "Get front page data.",
+        "tags": [
+          "other"
+        ]
+      }
+    },
     "/api/v1/teams/{team}": {
       "get": {
         "operationId": "get_team",