utoipa: Add annotations to /site_metadata endpoints

Author: Turbo87

src/controllers/site_metadata.rs

@@ -2,10 +2,17 @@ use crate::app::AppState;
 use axum::response::IntoResponse;
 use axum_extra::json;
 
-/// Returns the JSON representation of the current deployed commit sha.
+/// Get crates.io metadata.
 ///
-/// The sha is contained within the `HEROKU_SLUG_COMMIT` environment variable.
-/// If `HEROKU_SLUG_COMMIT` is not set, returns `"unknown"`.
+/// Returns the current deployed commit SHA1 (or `unknown`), and whether the
+/// system is in read-only mode.
+#[utoipa::path(
+    get,
+    path = "/api/v1/site_metadata",
+    operation_id = "get_site_metadata",
+    tag = "other",
+    responses((status = 200, description = "Successful Response")),
+)]
 pub async fn show_deployed_sha(state: AppState) -> impl IntoResponse {
     let read_only = state.config.db.are_all_read_only();
 

src/router.rs

@@ -59,13 +59,10 @@ pub fn build_axum_router(state: AppState) -> Router<()> {
         .routes(routes!(summary::summary))
         .routes(routes!(user::me::confirm_user_email))
         .routes(routes!(user::resend::regenerate_token_and_send))
+        .routes(routes!(site_metadata::show_deployed_sha))
         .split_for_parts();
 
     let mut router = router
-        .route(
-            "/api/v1/site_metadata",
-            get(site_metadata::show_deployed_sha),
-        )
         // Session management
         .route("/api/private/session/begin", get(user::session::begin))
         .route(

src/snapshots/crates_io__openapi__tests__openapi_snapshot.snap

@@ -592,6 +592,21 @@ snapshot_kind: text
         ]
       }
     },
+    "/api/v1/site_metadata": {
+      "get": {
+        "description": "Returns the current deployed commit SHA1 (or `unknown`), and whether the\nsystem is in read-only mode.",
+        "operationId": "get_site_metadata",
+        "responses": {
+          "200": {
+            "description": "Successful Response"
+          }
+        },
+        "summary": "Get crates.io metadata.",
+        "tags": [
+          "other"
+        ]
+      }
+    },
     "/api/v1/summary": {
       "get": {
         "description": "This endpoint returns a summary of the most important data for the front\npage of crates.io.",