From b4cac391576f17d7c70b993d659277fd51cb7876 Mon Sep 17 00:00:00 2001
From: Awiteb
Date: Sat, 27 Jul 2024 05:27:06 +0300
Subject: [PATCH] docs: Improve schemas docs
Fixes: https://git.4rs.nl/OxideTalis/oxidetalis/issues/32
Signed-off-by: Awiteb
---
crates/oxidetalis/src/schemas/mod.rs | 10 +---------
crates/oxidetalis/src/schemas/user.rs | 2 ++
2 files changed, 3 insertions(+), 9 deletions(-)
diff --git a/crates/oxidetalis/src/schemas/mod.rs b/crates/oxidetalis/src/schemas/mod.rs
index 041c2d9..ac90111 100644
--- a/crates/oxidetalis/src/schemas/mod.rs
+++ b/crates/oxidetalis/src/schemas/mod.rs
@@ -33,15 +33,7 @@ mod user;
pub use user::*;
-/// Json message schema, used for returning messages to the client, the message
-/// must be human readable.
-///
-/// # Example
-/// ```json
-/// {
-/// "message": "Message"
-/// }
-/// ```
+/// Message schema, used for returning messages.
#[derive(Serialize, Deserialize, Clone, Debug, ToSchema, derive_new::new)]
#[salvo(schema(name = MessageSchema, example = json!(MessageSchema::new("Message".to_owned()))))]
pub struct MessageSchema {
diff --git a/crates/oxidetalis/src/schemas/user.rs b/crates/oxidetalis/src/schemas/user.rs
index 0dad035..1630590 100644
--- a/crates/oxidetalis/src/schemas/user.rs
+++ b/crates/oxidetalis/src/schemas/user.rs
@@ -24,6 +24,7 @@ use oxidetalis_entities::prelude::*;
use salvo::oapi::ToSchema;
use serde::{Deserialize, Serialize};
+/// WhiteListed user schema, represents a whitelisted user.
#[derive(Serialize, Deserialize, Clone, Debug, ToSchema, derive_new::new)]
#[salvo(schema(name = WhiteListedUser, example = json!(WhiteListedUser::default())))]
pub struct WhiteListedUser {
@@ -33,6 +34,7 @@ pub struct WhiteListedUser {
pub whitelisted_at: DateTime,
}
+/// Blacklisted user schema, represents a blacklisted user.
#[derive(Serialize, Deserialize, Clone, Debug, ToSchema, derive_new::new)]
#[salvo(schema(name = BlackListedUser, example = json!(BlackListedUser::default())))]
pub struct BlackListedUser {