refactor(api_admin)!: use query instead of body (#69)

* refactor(api_admin)!: use query instead of body

* chore(justfile): update recipe

* docs: update create-account

Justfile

@@ -72,9 +72,7 @@ account method name:
   fi
 
 _account method name:
-  curl -X POST "http://localhost:${HATSU_LISTEN_PORT}/api/v0/admin/{{method}}-account?token=${HATSU_ACCESS_TOKEN}" \
-  -H "Content-Type: application/json" \
-  -d "{\"name\": \"{{name}}\"}"
+  curl -X POST "http://localhost:${HATSU_LISTEN_PORT}/api/v0/admin/{{method}}-account?name={{name}}&token=${HATSU_ACCESS_TOKEN}"
 
 # /api/v0/admin/block-url
 block-url url:

crates/api_admin/src/entities/create_remove_account.rs

@@ -1,8 +1,8 @@
 use serde::{Deserialize, Serialize};
-use utoipa::ToSchema;
+use utoipa::{IntoParams, ToSchema};
 
-#[derive(Deserialize, ToSchema)]
-pub struct CreateRemoveAccount {
+#[derive(Deserialize, IntoParams)]
+pub struct CreateRemoveAccountQuery {
     pub name: String,
 }
 

crates/api_admin/src/entities/mod.rs

@@ -2,4 +2,4 @@ mod block_url_or_acct;
 mod create_remove_account;
 
 pub use block_url_or_acct::{BlockUrlQuery, BlockUrlResult};
-pub use create_remove_account::{CreateRemoveAccount, CreateRemoveAccountResult};
+pub use create_remove_account::{CreateRemoveAccountQuery, CreateRemoveAccountResult};

crates/api_admin/src/routes/create_account.rs

@@ -1,14 +1,14 @@
 use std::ops::Deref;
 
 use activitypub_federation::config::Data;
-use axum::{debug_handler, http::StatusCode, Json};
+use axum::{debug_handler, extract::Query, http::StatusCode, Json};
 use hatsu_apub::actors::ApubUser;
 use hatsu_db_schema::prelude::User;
 use hatsu_utils::{AppData, AppError};
 use sea_orm::{ActiveModelTrait, EntityTrait, IntoActiveModel};
 
 use crate::{
-    entities::{CreateRemoveAccount, CreateRemoveAccountResult},
+    entities::{CreateRemoveAccountQuery, CreateRemoveAccountResult},
     TAG,
 };
 
@@ -17,6 +17,7 @@ use crate::{
     post,
     tag = TAG,
     path = "/api/v0/admin/create-account",
+    params(CreateRemoveAccountQuery),
     responses(
         (status = CREATED, description = "create successfully", body = CreateRemoveAccountResult),
         (status = BAD_REQUEST, description = "error", body = AppError)
@@ -26,10 +27,10 @@ use crate::{
 #[debug_handler]
 pub async fn create_account(
     data: Data<AppData>,
-    Json(payload): Json<CreateRemoveAccount>,
+    query: Query<CreateRemoveAccountQuery>,
 ) -> Result<(StatusCode, Json<CreateRemoveAccountResult>), AppError> {
     if let Some(account) = User::find_by_id(
-        hatsu_utils::url::generate_user_url(data.domain(), &payload.name)?.to_string(),
+        hatsu_utils::url::generate_user_url(data.domain(), &query.name)?.to_string(),
     )
     .one(&data.conn)
     .await?
@@ -40,7 +41,7 @@ pub async fn create_account(
             Some(StatusCode::BAD_REQUEST),
         ))
     } else {
-        let account = ApubUser::new(data.domain(), &payload.name)
+        let account = ApubUser::new(data.domain(), &query.name)
             .await?
             .deref()
             .clone()

crates/api_admin/src/routes/mod.rs

@@ -13,7 +13,7 @@ use utoipa::{
 };
 use utoipa_axum::{router::OpenApiRouter, routes};
 
-use crate::entities::{BlockUrlResult, CreateRemoveAccount, CreateRemoveAccountResult};
+use crate::entities::{BlockUrlResult, CreateRemoveAccountResult};
 
 mod block_url;
 mod create_account;
@@ -26,7 +26,6 @@ pub const TAG: &str = "hatsu::admin";
 #[openapi(
     components(schemas(
         BlockUrlResult,
-        CreateRemoveAccount,
         CreateRemoveAccountResult
     )),
     modifiers(&SecurityAddon),

crates/api_admin/src/routes/remove_account.rs

@@ -1,11 +1,11 @@
 use activitypub_federation::config::Data;
-use axum::{debug_handler, http::StatusCode, Json};
+use axum::{debug_handler, extract::Query, http::StatusCode, Json};
 use hatsu_db_schema::prelude::User;
 use hatsu_utils::{AppData, AppError};
 use sea_orm::EntityTrait;
 
 use crate::{
-    entities::{CreateRemoveAccount, CreateRemoveAccountResult},
+    entities::{CreateRemoveAccountQuery, CreateRemoveAccountResult},
     TAG,
 };
 
@@ -14,6 +14,7 @@ use crate::{
     post,
     tag = TAG,
     path = "/api/v0/admin/remove-account",
+    params(CreateRemoveAccountQuery),
     responses(
         // (status = OK, description = "remove successfully", body = CreateRemoveAccountResult),
         (status = METHOD_NOT_ALLOWED, description = "not implemented", body = CreateRemoveAccountResult),
@@ -24,10 +25,10 @@ use crate::{
 #[debug_handler]
 pub async fn remove_account(
     data: Data<AppData>,
-    Json(payload): Json<CreateRemoveAccount>,
+    query: Query<CreateRemoveAccountQuery>,
 ) -> Result<(StatusCode, Json<CreateRemoveAccountResult>), AppError> {
     match User::find_by_id(
-        hatsu_utils::url::generate_user_url(data.domain(), &payload.name)?.to_string(),
+        hatsu_utils::url::generate_user_url(data.domain(), &query.name)?.to_string(),
     )
     .one(&data.conn)
     .await?
@@ -47,18 +48,15 @@ pub async fn remove_account(
                 Ok((
                     StatusCode::METHOD_NOT_ALLOWED,
                     Json(CreateRemoveAccountResult {
-                        name: payload.name.clone(),
+                        name: query.name.clone(),
                         // message: format!("Successfully removed account: {}", payload.name),
-                        message: format!(
-                            "Remove account API not yet implemented: {}",
-                            payload.name
-                        ),
+                        message: format!("Remove account API not yet implemented: {}", query.name),
                     }),
                 ))
             }
         },
         None => Err(AppError::new(
-            format!("The account does not exist: {}", payload.name),
+            format!("The account does not exist: {}", query.name),
             None,
             Some(StatusCode::BAD_REQUEST),
         )),

docs/src/admins/create-account.md

@@ -21,7 +21,5 @@ docker exec -it hatsu /bin/bash
 You can also access the API via curl, as `Justfile` does.
 
 ```bash
-curl -X POST "http://localhost:$(echo $HATSU_LISTEN_PORT)/api/v0/admin/create-account?token=$(echo $HATSU_ACCESS_TOKEN)" \
-  -H "Content-Type: application/json" \
-  -d "{\"name\": \"example.com\"}"
+NAME="example.com" curl -X POST "http://localhost:$(echo $HATSU_LISTEN_PORT)/api/v0/admin/create-account?name=$(echo $NAME)&token=$(echo $HATSU_ACCESS_TOKEN)"
 ```