feat: [#229] add schemars 1.1 dependency and JsonSchema derives to config types

Author: josecelano

Cargo.toml

@@ -50,6 +50,7 @@ figment = { version = "0.10", features = [ "json" ] }
 parking_lot = "0.12"
 reqwest = "0.12"
 rust-embed = "8.0"
+schemars = "1.1"
 serde = { version = "1.0", features = [ "derive" ] }
 serde_json = "1.0"
 tempfile = "3.0"

src/application/command_handlers/create/config/environment_config.rs

@@ -4,6 +4,7 @@
 //! all configuration needed to create a deployment environment. It handles
 //! deserialization from configuration sources and conversion to domain types.
 
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 use crate::adapters::ssh::SshCredentials;
@@ -69,7 +70,7 @@ use super::tracker::TrackerSection;
 /// let config: EnvironmentCreationConfig = serde_json::from_str(json)?;
 /// # Ok::<(), Box<dyn std::error::Error>>(())
 /// ```
-#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
 pub struct EnvironmentCreationConfig {
     /// Environment-specific settings
     pub environment: EnvironmentSection,
@@ -93,7 +94,7 @@ pub struct EnvironmentCreationConfig {
 /// Environment-specific configuration section
 ///
 /// Contains configuration specific to the environment being created.
-#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 pub struct EnvironmentSection {
     /// Name of the environment to create
     ///

src/application/command_handlers/create/config/provider/hetzner.rs

@@ -4,6 +4,7 @@
 //! Uses raw `String` fields for JSON deserialization, which are then validated
 //! when converting to domain types.
 
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 /// Hetzner-specific configuration section
@@ -23,7 +24,7 @@ use serde::{Deserialize, Serialize};
 ///     image: "ubuntu-24.04".to_string(),
 /// };
 /// ```
-#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 pub struct HetznerProviderSection {
     /// Hetzner API token (raw string).
     pub api_token: String,

src/application/command_handlers/create/config/provider/lxd.rs

@@ -4,6 +4,7 @@
 //! Uses raw `String` for JSON deserialization, which is then validated
 //! when converting to domain types.
 
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 /// LXD-specific configuration section
@@ -20,7 +21,7 @@ use serde::{Deserialize, Serialize};
 ///     profile_name: "torrust-profile-dev".to_string(),
 /// };
 /// ```
-#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 pub struct LxdProviderSection {
     /// LXD profile name (raw string - validated on conversion).
     pub profile_name: String,

src/application/command_handlers/create/config/provider/mod.rs

@@ -40,6 +40,7 @@ mod lxd;
 pub use hetzner::HetznerProviderSection;
 pub use lxd::LxdProviderSection;
 
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 use crate::application::command_handlers::create::config::CreateConfigError;
@@ -71,7 +72,7 @@ use crate::domain::ProfileName;
 /// let config = section.to_provider_config().unwrap();
 /// assert_eq!(config.provider_name(), "lxd");
 /// ```
-#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 #[serde(tag = "provider")]
 pub enum ProviderSection {
     /// LXD provider configuration

src/application/command_handlers/create/config/ssh_credentials_config.rs

@@ -4,9 +4,11 @@
 //! SSH credentials in the configuration layer (distinct from the adapter layer).
 //! It handles string-based paths and usernames that will be converted to domain types.
 
-use serde::{Deserialize, Serialize};
 use std::path::PathBuf;
 
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+
 use crate::adapters::ssh::SshCredentials;
 use crate::shared::Username;
 
@@ -36,7 +38,7 @@ const DEFAULT_SSH_PORT: u16 = 22;
 ///     port: 22,
 /// };
 /// ```
-#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
 pub struct SshCredentialsConfig {
     /// Path to the SSH private key file (as string in config)
     pub private_key_path: String,

src/application/command_handlers/create/config/tracker/http_api_section.rs

@@ -1,11 +1,12 @@
 use std::net::SocketAddr;
 
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 use crate::application::command_handlers::create::config::errors::CreateConfigError;
 use crate::domain::tracker::HttpApiConfig;
 
-#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, JsonSchema)]
 pub struct HttpApiSection {
     pub bind_address: String,
     pub admin_token: String,

src/application/command_handlers/create/config/tracker/http_tracker_section.rs

@@ -1,11 +1,12 @@
 use std::net::SocketAddr;
 
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 use crate::application::command_handlers::create::config::errors::CreateConfigError;
 use crate::domain::tracker::HttpTrackerConfig;
 
-#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, JsonSchema)]
 pub struct HttpTrackerSection {
     pub bind_address: String,
 }

src/application/command_handlers/create/config/tracker/tracker_core_section.rs

@@ -4,6 +4,7 @@
 //! used for JSON deserialization and validation before converting
 //! to domain types.
 
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 use crate::application::command_handlers::create::config::errors::CreateConfigError;
@@ -22,7 +23,7 @@ use crate::domain::tracker::{DatabaseConfig, TrackerCoreConfig};
 ///   "database_name": "tracker.db"
 /// }
 /// ```
-#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, JsonSchema)]
 #[serde(tag = "driver")]
 pub enum DatabaseSection {
     /// `SQLite` file-based database
@@ -65,7 +66,7 @@ impl DatabaseSection {
 ///   "private": false
 /// }
 /// ```
-#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, JsonSchema)]
 pub struct TrackerCoreSection {
     /// Database configuration
     pub database: DatabaseSection,

src/application/command_handlers/create/config/tracker/tracker_section.rs

@@ -3,6 +3,7 @@
 //! This module provides the aggregated DTO for complete tracker configuration,
 //! used for JSON deserialization and validation before converting to domain types.
 
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 use super::{HttpApiSection, HttpTrackerSection, TrackerCoreSection, UdpTrackerSection};
@@ -37,7 +38,7 @@ use crate::domain::tracker::{HttpApiConfig, HttpTrackerConfig, TrackerConfig, Ud
 ///   }
 /// }
 /// ```
-#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
+#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, JsonSchema)]
 pub struct TrackerSection {
     /// Core tracker configuration (database, privacy mode)
     pub core: TrackerCoreSection,