OpenAPI: Describe authentication requirements

Author: Turbo87

crates/crates_io_session/src/lib.rs

@@ -9,7 +9,7 @@ use parking_lot::RwLock;
 use std::collections::HashMap;
 use std::sync::Arc;
 
-static COOKIE_NAME: &str = "cargo_session";
+pub static COOKIE_NAME: &str = "cargo_session";
 static MAX_AGE_DAYS: i64 = 90;
 
 #[derive(Clone, FromRequestParts)]

src/controllers/crate_owner_invitation.rs

@@ -27,6 +27,7 @@ use std::collections::{HashMap, HashSet};
 #[utoipa::path(
     get,
     path = "/api/v1/me/crate_owner_invitations",
+    security(("cookie" = [])),
     tag = "owners",
     responses((status = 200, description = "Successful Response")),
 )]
@@ -90,6 +91,7 @@ pub struct ListQueryParams {
     get,
     path = "/api/private/crate_owner_invitations",
     params(ListQueryParams, PaginationQueryParams),
+    security(("cookie" = [])),
     tag = "owners",
     responses((status = 200, description = "Successful Response")),
 )]
@@ -316,6 +318,10 @@ pub struct OwnerInvitation {
     params(
         ("crate_id" = i32, Path, description = "ID of the crate"),
     ),
+    security(
+        ("api_token" = []),
+        ("cookie" = []),
+    ),
     tag = "owners",
     responses((status = 200, description = "Successful Response")),
 )]

src/controllers/krate/delete.rs

@@ -31,6 +31,7 @@ const AVAILABLE_AFTER: TimeDelta = TimeDelta::hours(24);
     delete,
     path = "/api/v1/crates/{name}",
     params(CratePath),
+    security(("cookie" = [])),
     tag = "crates",
     responses((status = 200, description = "Successful Response")),
 )]

src/controllers/krate/follow.rs

@@ -34,6 +34,10 @@ async fn follow_target(
     put,
     path = "/api/v1/crates/{name}/follow",
     params(CratePath),
+    security(
+        ("api_token" = []),
+        ("cookie" = []),
+    ),
     tag = "crates",
     responses((status = 200, description = "Successful Response")),
 )]
@@ -55,6 +59,10 @@ pub async fn follow_crate(app: AppState, path: CratePath, req: Parts) -> AppResu
     delete,
     path = "/api/v1/crates/{name}/follow",
     params(CratePath),
+    security(
+        ("api_token" = []),
+        ("cookie" = []),
+    ),
     tag = "crates",
     responses((status = 200, description = "Successful Response")),
 )]
@@ -72,6 +80,7 @@ pub async fn unfollow_crate(app: AppState, path: CratePath, req: Parts) -> AppRe
     get,
     path = "/api/v1/crates/{name}/following",
     params(CratePath),
+    security(("cookie" = [])),
     tag = "crates",
     responses((status = 200, description = "Successful Response")),
 )]

src/controllers/krate/owners.rs

@@ -88,6 +88,10 @@ pub async fn get_user_owners(state: AppState, path: CratePath) -> AppResult<Eras
     put,
     path = "/api/v1/crates/{name}/owners",
     params(CratePath),
+    security(
+        ("api_token" = []),
+        ("cookie" = []),
+    ),
     tag = "owners",
     responses((status = 200, description = "Successful Response")),
 )]
@@ -105,6 +109,10 @@ pub async fn add_owners(
     delete,
     path = "/api/v1/crates/{name}/owners",
     params(CratePath),
+    security(
+        ("api_token" = []),
+        ("cookie" = []),
+    ),
     tag = "owners",
     responses((status = 200, description = "Successful Response")),
 )]

src/controllers/krate/publish.rs

@@ -56,6 +56,10 @@ const MAX_DESCRIPTION_LENGTH: usize = 1000;
 #[utoipa::path(
     put,
     path = "/api/v1/crates/new",
+    security(
+        ("api_token" = []),
+        ("cookie" = []),
+    ),
     tag = "publish",
     responses((status = 200, description = "Successful Response")),
 )]

src/controllers/krate/search.rs

@@ -38,6 +38,11 @@ use crate::util::RequestUtils;
     get,
     path = "/api/v1/crates",
     params(ListQueryParams, PaginationQueryParams),
+    security(
+        (),
+        ("api_token" = []),
+        ("cookie" = []),
+    ),
     tag = "crates",
     responses((status = 200, description = "Successful Response")),
 )]

src/controllers/session.rs

@@ -173,6 +173,7 @@ async fn find_user_by_gh_id(conn: &mut AsyncPgConnection, gh_id: i32) -> QueryRe
 #[utoipa::path(
     delete,
     path = "/api/private/session",
+    security(("cookie" = [])),
     tag = "session",
     responses((status = 200, description = "Successful Response")),
 )]

src/controllers/token.rs

@@ -39,6 +39,7 @@ impl GetParams {
 #[utoipa::path(
     get,
     path = "/api/v1/me/tokens",
+    security(("cookie" = [])),
     tag = "api_tokens",
     responses((status = 200, description = "Successful Response")),
 )]
@@ -86,6 +87,7 @@ pub struct NewApiTokenRequest {
 #[utoipa::path(
     put,
     path = "/api/v1/me/tokens",
+    security(("cookie" = [])),
     tag = "api_tokens",
     responses((status = 200, description = "Successful Response")),
 )]
@@ -184,6 +186,10 @@ pub async fn create_api_token(
     params(
         ("id" = i32, Path, description = "ID of the API token"),
     ),
+    security(
+        ("api_token" = []),
+        ("cookie" = []),
+    ),
     tag = "api_tokens",
     responses((status = 200, description = "Successful Response")),
 )]
@@ -211,6 +217,10 @@ pub async fn find_api_token(
     params(
         ("id" = i32, Path, description = "ID of the API token"),
     ),
+    security(
+        ("api_token" = []),
+        ("cookie" = []),
+    ),
     tag = "api_tokens",
     responses((status = 200, description = "Successful Response")),
 )]
@@ -237,6 +247,7 @@ pub async fn revoke_api_token(
 #[utoipa::path(
     delete,
     path = "/api/v1/tokens/current",
+    security(("api_token" = [])),
     tag = "api_tokens",
     responses((status = 200, description = "Successful Response")),
 )]

src/controllers/user/email_notifications.rs

@@ -24,6 +24,10 @@ pub struct CrateEmailNotifications {
 #[utoipa::path(
     put,
     path = "/api/v1/me/email_notifications",
+    security(
+        ("api_token" = []),
+        ("cookie" = []),
+    ),
     tag = "users",
     responses((status = 200, description = "Successful Response")),
 )]