Add specific patch document for config

Author: joseivanlopez

rust/agama-server/src/server/types.rs

@@ -20,12 +20,12 @@
 
 //! This module defines some ancillary types for the HTTP API.
 
-use std::collections::HashMap;
-
+use agama_lib::install_settings::InstallSettings;
 use agama_utils::issue;
-use serde::Serialize;
+use serde::{Deserialize, Serialize};
+use std::collections::HashMap;
 
-#[derive(Serialize, utoipa::ToSchema)]
+#[derive(Deserialize, Serialize, utoipa::ToSchema)]
 /// Holds the installation issues for each scope.
 pub struct IssuesMap {
     /// iSCSI issues.
@@ -60,3 +60,10 @@ impl From<HashMap<String, Vec<issue::Issue>>> for IssuesMap {
         }
     }
 }
+
+#[derive(Deserialize, Serialize, utoipa::ToSchema)]
+/// Patch for the config.
+pub struct ConfigPatch {
+    /// Update for the current config.
+    pub update: Option<InstallSettings>,
+}

rust/agama-server/src/server/web.rs

@@ -20,6 +20,7 @@
 
 //! This module implements Agama's HTTP API.
 
+use crate::server::types::{ConfigPatch, IssuesMap};
 use agama_lib::{error::ServiceError, http, install_settings::InstallSettings};
 use agama_manager::{self as manager, message, SystemInfo};
 use agama_utils::actor::Handler;
@@ -34,8 +35,6 @@ use hyper::StatusCode;
 use serde::Serialize;
 use serde_json::json;
 
-use super::types::IssuesMap;
-
 #[derive(thiserror::Error, Debug)]
 pub enum Error {
     #[error(transparent)]
@@ -52,13 +51,6 @@ impl IntoResponse for Error {
     }
 }
 
-fn to_option_response<T: Serialize>(value: Option<T>) -> Response {
-    match value {
-        Some(inner) => Json(inner).into_response(),
-        None => StatusCode::NOT_FOUND.into_response(),
-    }
-}
-
 #[derive(Clone)]
 pub struct ServerState {
     manager: Handler<manager::Service>,
@@ -197,12 +189,14 @@ async fn put_config(
 )]
 async fn patch_config(
     State(state): State<ServerState>,
-    Json(config): Json<InstallSettings>,
+    Json(patch): Json<ConfigPatch>,
 ) -> ServerResult<()> {
-    state
-        .manager
-        .call(message::UpdateConfig::new(config))
-        .await?;
+    if let Some(config) = patch.update {
+        state
+            .manager
+            .call(message::UpdateConfig::new(config))
+            .await?;
+    }
     Ok(())
 }
 
@@ -256,3 +250,10 @@ async fn run_action(
     state.manager.call(message::RunAction::new(action)).await?;
     Ok(())
 }
+
+fn to_option_response<T: Serialize>(value: Option<T>) -> Response {
+    match value {
+        Some(inner) => Json(inner).into_response(),
+        None => StatusCode::NOT_FOUND.into_response(),
+    }
+}

rust/agama-server/src/web/docs/config.rs

@@ -159,6 +159,8 @@ impl ApiDocBuilder for ConfigApiDocBuilder {
             .schema_from::<agama_lib::users::RootUserSettings>()
             .schema_from::<agama_lib::users::UserPassword>()
             .schema_from::<agama_lib::users::UserSettings>()
+            .schema_from::<crate::server::types::ConfigPatch>()
+            .schema_from::<crate::server::types::IssuesMap>()
             .schema_from::<crate::software::web::SoftwareProposal>()
             .schema_from::<agama_manager::message::Action>()
             .schema_from::<agama_manager::message::Status>()

rust/agama-server/tests/server_service.rs

@@ -150,13 +150,15 @@ async fn test_put_config() -> Result<(), Box<dyn Error>> {
 #[test]
 #[cfg(not(ci))]
 async fn test_patch_config() -> Result<(), Box<dyn Error>> {
+    use agama_server::server::types::ConfigPatch;
+
     let localization = Config {
         locale: Some("es_ES.UTF-8".to_string()),
         keymap: Some("es".to_string()),
         timezone: Some("Atlantic/Canary".to_string()),
     };
 
-    let mut config = InstallSettings {
+    let config = InstallSettings {
         localization: Some(localization),
         ..Default::default()
     };
@@ -177,13 +179,18 @@ async fn test_patch_config() -> Result<(), Box<dyn Error>> {
         keymap: Some("en".to_string()),
         timezone: None,
     };
-    config.localization = Some(localization);
+    let patch = ConfigPatch {
+        update: Some(InstallSettings {
+            localization: Some(localization),
+            ..Default::default()
+        }),
+    };
 
     let request = Request::builder()
         .uri("/config")
         .header("Content-Type", "application/json")
         .method(Method::PATCH)
-        .body(serde_json::to_string(&config)?)
+        .body(serde_json::to_string(&patch)?)
         .unwrap();
 
     let response = server_service.clone().oneshot(request).await.unwrap();