From 493fe44b23d3f4c3f271278b5137f4968cba036c Mon Sep 17 00:00:00 2001 From: Tolmachev Igor Date: Thu, 25 Sep 2025 14:01:41 +0300 Subject: Fix grammar --- src/api.rs | 2 +- src/routers/account.rs | 22 +++++++++++----------- src/routers/queue.rs | 24 ++++++++++++++---------- 3 files changed, 26 insertions(+), 22 deletions(-) (limited to 'src') diff --git a/src/api.rs b/src/api.rs index 5c6813c..c419eb1 100644 --- a/src/api.rs +++ b/src/api.rs @@ -32,7 +32,7 @@ impl Modify for AuthModifier { #[openapi( info( title = "ITMO queue server API", - description = "Queuing service for labs works", + description = "Queue service", license( name = "AGPL-3.0", url="https://www.gnu.org/licenses/agpl-3.0.en.html#license-text" diff --git a/src/routers/account.rs b/src/routers/account.rs index 71ba496..1ae8c22 100644 --- a/src/routers/account.rs +++ b/src/routers/account.rs @@ -34,7 +34,7 @@ struct Token { } #[derive(Deserialize, ToSchema)] -#[schema(description = "Account register data")] +#[schema(description = "Body of the account registration request")] struct RegisterRequest { #[schema(examples("john_doe", "ivanov_ivan"))] username: String, @@ -57,7 +57,7 @@ enum TokenLifetime { } #[derive(Deserialize, ToSchema)] -#[schema(description = "Account login data")] +#[schema(description = "Body of the login request")] struct LoginRequest { #[schema(examples("john_doe", "ivanov_ivan"))] username: String, @@ -69,7 +69,7 @@ struct LoginRequest { } #[derive(Deserialize, ToSchema)] -#[schema(description = "Change account password data")] +#[schema(description = "Body of the change account password request")] struct ChangePasswordRequest { #[schema(examples("secret-password"))] old_password: String, @@ -78,14 +78,14 @@ struct ChangePasswordRequest { } #[derive(Deserialize, ToSchema)] -#[schema(description = "Change account password data")] +#[schema(description = "Body of the change account username request")] struct ChangeUsernameRequest { #[schema(examples("ivanov_ivan", "john_doe"))] new_username: String, } #[derive(Deserialize, ToSchema)] -#[schema(description = "Change account name data")] +#[schema(description = "Body of the change account name request")] struct ChangeNameRequest { #[schema(examples("John", "Иван"))] first_name: Option, @@ -94,7 +94,7 @@ struct ChangeNameRequest { } #[derive(Deserialize, ToSchema)] -#[schema(description = "Account delete data")] +#[schema(description = "Body of the delete account request")] struct DeleteUserRequest { #[schema(examples("secret-password"))] password: String, @@ -129,7 +129,7 @@ async fn me(Auth(user): Auth) -> ApiResult { responses( ( status = 200, body = SuccessResponse, - description = "Success response with created account data" + description = "Success response with your account data" ), GlobalResponses ), @@ -213,7 +213,7 @@ async fn login( responses( ( status = 200, body = SuccessResponse, - description = "Success response with changed account data" + description = "Success response with the updated account data" ), GlobalResponses ), @@ -246,7 +246,7 @@ async fn change_password( responses( ( status = 200, body = SuccessResponse, - description = "Success response with changed account data" + description = "Success response with the updated account data" ), GlobalResponses ), @@ -281,7 +281,7 @@ async fn change_username( responses( ( status = 200, body = SuccessResponse, - description = "Success response with changed account data" + description = "Success response with the updated account data" ), GlobalResponses ), @@ -315,7 +315,7 @@ async fn change_name( responses( ( status = 200, body = SuccessResponse, - description = "Success response with deleted account data" + description = "Success response with the deleted account data" ), GlobalResponses ), diff --git a/src/routers/queue.rs b/src/routers/queue.rs index 1e93b2a..df846fb 100644 --- a/src/routers/queue.rs +++ b/src/routers/queue.rs @@ -32,12 +32,14 @@ async fn get_owned_queue( } #[derive(Deserialize, ToSchema)] +#[schema(description = "Body of the create queue request")] struct CreateQueueRequest { #[schema(examples("John's queue", "Очередь Ивана"))] name: String, } #[derive(Deserialize, ToSchema)] +#[schema(description = "Body of the change queue name request")] struct ChangeQueueNameRequest { #[schema(examples(1))] id: i64, @@ -46,7 +48,8 @@ struct ChangeQueueNameRequest { } #[derive(Deserialize, ToSchema)] -struct ChangeQueueOwnerRequest { +#[schema(description = "Body of the change queue ownership request")] +struct ChangeQueueOwnershipRequest { #[schema(examples(1))] id: i64, #[schema(examples(1))] @@ -54,6 +57,7 @@ struct ChangeQueueOwnerRequest { } #[derive(Deserialize, ToSchema)] +#[schema(description = "Body of the delete queue request")] struct DeleteQueueRequest { #[schema(examples(1))] id: i64, @@ -64,7 +68,7 @@ struct DeleteQueueRequest { path = "/owned", tag = QUEUE, summary = "Get owned", - description = "Get your own queues", + description = "Get your queues", responses( ( status = 200, body = SuccessResponse>, @@ -96,7 +100,7 @@ async fn owned(State(state): State, Auth(user): Auth) -> ApiResult, - description = "Success response with created queue" + description = "Success response with the created queue" ), GlobalResponses ), @@ -129,7 +133,7 @@ async fn create( responses( ( status = 200, body = SuccessResponse, - description = "Success response with changed queue data" + description = "Success response with the changed queue data" ), GlobalResponses ), @@ -155,12 +159,12 @@ async fn change_name( path = "/change/owner", tag = QUEUE, summary = "Change owner", - description = "Transfer ownership of the queue", - request_body = ChangeQueueOwnerRequest, + description = "Reassign queue ownership", + request_body = ChangeQueueOwnershipRequest, responses( ( status = 200, body = SuccessResponse, - description = "Success response with changed queue data" + description = "Success response with the changed queue data" ), GlobalResponses ), @@ -169,7 +173,7 @@ async fn change_name( async fn change_owner( State(state): State, Auth(user): Auth, - ApiJson(req): ApiJson, + ApiJson(req): ApiJson, ) -> ApiResult { if !user_exists(req.new_owner_id, &state.db).await? { return Err(ClientError::UserNotFound { @@ -193,12 +197,12 @@ async fn change_owner( path = "/delete", tag = QUEUE, summary = "Delete", - description = "Delete queue", + description = "Delete the queue", request_body = DeleteQueueRequest, responses( ( status = 200, body = SuccessResponse, - description = "Success response with deleted queue data" + description = "Success response with the deleted queue data" ), GlobalResponses ), -- cgit v1.2.3