Merge pull request #22 from TheAwiteb/null-update-value

`UpdateTodoSchema` that supports null values for unchanged fields

src/api/todo/update.rs

@@ -1,7 +1,7 @@
 use crate::api::auth::utils::req_auth;
 use crate::api::todo::utils;
 use crate::errors::Result as ApiResult;
-use crate::schemas::todo::{TodoContentSchema, TodoSchema};
+use crate::schemas::todo::{TodoSchema, UpdateTodoSchema};
 use crate::schemas::{message::MessageSchema, traits::OpenApiExample};
 use actix_web::{put, web, HttpRequest};
 use sea_orm::DatabaseConnection;
@@ -10,7 +10,7 @@ use uuid::Uuid;
 /// Update a single todo by uuid, only the title and status can be updated.
 #[utoipa::path(
     context_path = "/api/todos",
-    request_body = TodoContentSchema,
+    request_body = UpdateTodoSchema,
     params(
         (
             "uuid", description = "The uuid of the todo",
@@ -33,7 +33,7 @@ use uuid::Uuid;
 #[put("/{uuid}")]
 pub async fn update_todo(
     req: HttpRequest,
-    payload: web::Json<TodoContentSchema>,
+    payload: web::Json<UpdateTodoSchema>,
     uuid: web::Path<Uuid>,
     db: web::Data<DatabaseConnection>,
 ) -> ApiResult<TodoSchema> {
@@ -42,8 +42,8 @@ pub async fn update_todo(
     let user = req_auth(req, db).await?;
     let todo = utils::find_todo_by_uuid(*uuid, user.id, db).await?;
     // If the title is not changed, then set it to None. Otherwise, set it to Some(payload.title)
-    let todo_title = todo.title.ne(&payload.title).then_some(payload.title);
-    utils::update_todo(todo, todo_title, Some(payload.status), db)
+    let todo_title = payload.title.filter(|title| title != &todo.title);
+    utils::update_todo(todo, todo_title, payload.status, db)
         .await
         .map(TodoSchema::from)
 }

src/api_docs.rs

@@ -34,6 +34,7 @@ use utoipa::{Modify, OpenApi};
             crate::schemas::todo::TodoSchema,
             crate::schemas::todo::TodoListSchema,
             crate::schemas::todo::TodoListMetaSchema,
+            crate::schemas::todo::UpdateTodoSchema,
             // Server metadata
             crate::schemas::server_metadata::ServerMetadataSchema,
         )

src/schemas/todo/mod.rs

@@ -1,8 +1,9 @@
 mod content;
 mod list;
+mod update;
 
 use actix_web::{body::BoxBody, Responder};
-pub use {content::*, list::*};
+pub use {content::*, list::*, update::*};
 
 use entity::todo::Status as TodoStatus;
 use serde::{Deserialize, Serialize};

src/schemas/todo/update.rs

@@ -0,0 +1,23 @@
+use entity::todo::Status as TodoStatus;
+use serde::{Deserialize, Serialize};
+use utoipa::ToSchema;
+
+/// The schema used to update a todo, supports null values for unchanged fields
+#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
+pub struct UpdateTodoSchema {
+    /// The title of the todo, can be `null` to keep the original title
+    #[schema(example = "Todo title")]
+    pub title: Option<String>,
+    /// The status of the todo, can be `null` to keep the original status
+    #[schema(value_type = Option<String>, example = "completed")]
+    pub status: Option<TodoStatus>,
+}
+
+impl Default for UpdateTodoSchema {
+    fn default() -> Self {
+        Self {
+            title: Some("Todo title".to_string()),
+            status: None,
+        }
+    }
+}