fix(rust): add missing elements to the OpenAPI spec

agama-project · Jul 5, 2024 · 4db0996 · 4db0996
1 parent fde719c
commit 4db0996
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 25 deletions.
diff --git a/rust/Cargo.lock b/rust/Cargo.lock
diff --git a/rust/agama-lib/src/network/settings.rs b/rust/agama-lib/src/network/settings.rs
@@ -7,14 +7,14 @@ use std::default::Default;
 use std::net::IpAddr;
 
 /// Network settings for installation
-#[derive(Debug, Default, Serialize, Deserialize)]
+#[derive(Debug, Default, Serialize, Deserialize, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct NetworkSettings {
  /// Connections to use in the installation
  pub connections: Vec<NetworkConnection>,
 }
 
-#[derive(Clone, Debug, Default, Serialize, Deserialize)]
+#[derive(Clone, Debug, Default, Serialize, Deserialize, utoipa::ToSchema)]
 pub struct MatchSettings {
  #[serde(skip_serializing_if = "Vec::is_empty", default)]
  pub driver: Vec<String>,
@@ -35,7 +35,7 @@ impl MatchSettings {
  }
 }
 
-#[derive(Clone, Debug, Default, Serialize, Deserialize)]
+#[derive(Clone, Debug, Default, Serialize, Deserialize, utoipa::ToSchema)]
 pub struct WirelessSettings {
  #[serde(skip_serializing_if = "Option::is_none")]
  pub password: Option<String>,

diff --git a/rust/agama-lib/src/network/types.rs b/rust/agama-lib/src/network/types.rs
@@ -16,7 +16,7 @@ pub struct Device {
  pub state: DeviceState,
 }
 
-#[derive(Debug, Default, PartialEq, Clone, Serialize, Deserialize)]
+#[derive(Debug, Default, PartialEq, Clone, Serialize, Deserialize, utoipa::ToSchema)]
 pub struct SSID(pub Vec<u8>);
 
 impl SSID {
@@ -60,7 +60,7 @@ pub enum DeviceType {
 
 // For now this mirrors NetworkManager, because it was less mental work than coming up with
 // what exactly Agama needs. Expected to be adapted.
-#[derive(Debug, Default, Clone, Copy, PartialEq, Serialize, Deserialize)]
+#[derive(Debug, Default, Clone, Copy, PartialEq, Serialize, Deserialize, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
 pub enum DeviceState {
  #[default]
@@ -125,7 +125,7 @@ impl fmt::Display for DeviceState {
  }
 }
 
-#[derive(Debug, Default, Clone, Copy, PartialEq, Serialize, Deserialize)]
+#[derive(Debug, Default, Clone, Copy, PartialEq, Serialize, Deserialize, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
 pub enum Status {
  #[default]

diff --git a/rust/agama-locale-data/Cargo.toml b/rust/agama-locale-data/Cargo.toml
@@ -13,3 +13,4 @@ flate2 = "1.0.25"
 chrono-tz = "0.8.2"
 regex = "1"
 thiserror = "1.0.50"
+utoipa = "4.2.3"
diff --git a/rust/agama-locale-data/src/locale.rs b/rust/agama-locale-data/src/locale.rs
@@ -6,7 +6,7 @@ use std::sync::OnceLock;
 use std::{fmt::Display, str::FromStr};
 use thiserror::Error;
 
-#[derive(Clone, Debug, PartialEq, Serialize)]
+#[derive(Clone, Debug, PartialEq, Serialize, utoipa::ToSchema)]
 pub struct LocaleId {
  // ISO-639
  pub language: String,
@@ -80,9 +80,11 @@ static KEYMAP_ID_REGEX: OnceLock<Regex> = OnceLock::new();
 /// let id_with_dashes: KeymapId = "es-ast".parse().unwrap();
 /// assert_eq!(id, id_with_dashes);
 /// ```
-#[derive(Clone, Debug, PartialEq, Serialize)]
+#[derive(Clone, Debug, PartialEq, Serialize, utoipa::ToSchema)]
 pub struct KeymapId {
+ /// Keyboard layout (e.g., "es" in "es(ast)")
  pub layout: String,
+ /// Keyboard variante (e.g., "ast" in "es(ast)")
  pub variant: Option<String>,
 }
 

diff --git a/rust/agama-server/src/network/model.rs b/rust/agama-server/src/network/model.rs
@@ -652,7 +652,7 @@ impl TryFrom<Connection> for NetworkConnection {
  }
 }
 
-#[derive(Default, Debug, PartialEq, Clone, Serialize)]
+#[derive(Default, Debug, PartialEq, Clone, Serialize, utoipa::ToSchema)]
 pub enum ConnectionConfig {
  #[default]
  Ethernet,
@@ -666,7 +666,7 @@ pub enum ConnectionConfig {
  Tun(TunConfig),
 }
 
-#[derive(Default, Debug, PartialEq, Clone, Serialize)]
+#[derive(Default, Debug, PartialEq, Clone, Serialize, utoipa::ToSchema)]
 pub enum PortConfig {
  #[default]
  None,
@@ -689,7 +689,7 @@ impl From<WirelessConfig> for ConnectionConfig {
 #[error("Invalid MAC address: {0}")]
 pub struct InvalidMacAddress(String);
 
-#[derive(Debug, Default, Clone, PartialEq, Serialize)]
+#[derive(Debug, Default, Clone, PartialEq, Serialize, utoipa::ToSchema)]
 pub enum MacAddress {
  MacAddress(macaddr::MacAddr6),
  Preserve,
@@ -750,7 +750,7 @@ impl From<InvalidMacAddress> for zbus::fdo::Error {
 }
 
 #[skip_serializing_none]
-#[derive(Default, Debug, PartialEq, Clone, Serialize)]
+#[derive(Default, Debug, PartialEq, Clone, Serialize, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct IpConfig {
  pub method4: Ipv4Method,
@@ -766,7 +766,7 @@ pub struct IpConfig {
 }
 
 #[skip_serializing_none]
-#[derive(Debug, Default, PartialEq, Clone, Serialize)]
+#[derive(Debug, Default, PartialEq, Clone, Serialize, utoipa::ToSchema)]
 pub struct MatchConfig {
  #[serde(skip_serializing_if = "Vec::is_empty")]
  pub driver: Vec<String>,
@@ -895,7 +895,7 @@ impl From<&IpRoute> for HashMap<&str, Value<'_>> {
  }
 }
 
-#[derive(Debug, Default, PartialEq, Clone, Serialize)]
+#[derive(Debug, Default, PartialEq, Clone, Serialize, utoipa::ToSchema)]
 pub enum VlanProtocol {
  #[default]
  IEEE802_1Q,
@@ -928,15 +928,15 @@ impl fmt::Display for VlanProtocol {
  }
 }
 
-#[derive(Debug, Default, PartialEq, Clone, Serialize)]
+#[derive(Debug, Default, PartialEq, Clone, Serialize, utoipa::ToSchema)]
 pub struct VlanConfig {
  pub parent: String,
  pub id: u32,
  pub protocol: VlanProtocol,
 }
 
 #[serde_as]
-#[derive(Debug, Default, PartialEq, Clone, Serialize)]
+#[derive(Debug, Default, PartialEq, Clone, Serialize, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct WirelessConfig {
  pub mode: WirelessMode,
@@ -1035,7 +1035,7 @@ impl fmt::Display for WirelessMode {
  }
 }
 
-#[derive(Debug, Clone, Copy, Default, PartialEq, Serialize)]
+#[derive(Debug, Clone, Copy, Default, PartialEq, Serialize, utoipa::ToSchema)]
 pub enum SecurityProtocol {
  #[default]
  WEP, // No encryption or WEP ("none")
@@ -1207,7 +1207,7 @@ impl fmt::Display for BondOptions {
  }
 }
 
-#[derive(Debug, Default, PartialEq, Clone, Serialize)]
+#[derive(Debug, Default, PartialEq, Clone, Serialize, utoipa::ToSchema)]
 pub struct BondConfig {
  pub mode: BondMode,
  pub options: BondOptions,
@@ -1251,7 +1251,7 @@ impl TryFrom<BondConfig> for BondSettings {
  }
 }
 
-#[derive(Debug, Default, PartialEq, Clone, Serialize)]
+#[derive(Debug, Default, PartialEq, Clone, Serialize, utoipa::ToSchema)]
 pub struct BridgeConfig {
  pub stp: bool,
  #[serde(skip_serializing_if = "Option::is_none")]
@@ -1274,7 +1274,7 @@ pub struct BridgePortConfig {
  pub path_cost: Option<u32>,
 }
 
-#[derive(Default, Debug, PartialEq, Clone, Serialize)]
+#[derive(Default, Debug, PartialEq, Clone, Serialize, utoipa::ToSchema)]
 pub struct InfinibandConfig {
  pub p_key: Option<i32>,
  pub parent: Option<String>,
@@ -1321,7 +1321,7 @@ pub enum TunMode {
  Tap = 2,
 }
 
-#[derive(Default, Debug, PartialEq, Clone, Serialize)]
+#[derive(Default, Debug, PartialEq, Clone, Serialize, utoipa::ToSchema)]
 pub struct TunConfig {
  pub mode: TunMode,
  pub group: Option<String>,

diff --git a/rust/agama-server/src/web/docs.rs b/rust/agama-server/src/web/docs.rs
@@ -54,9 +54,15 @@ use utoipa::OpenApi;
  super::http::ping
  ),
  components(
+ schemas(agama_locale_data::KeymapId),
+ schemas(agama_locale_data::LocaleId),
  schemas(agama_lib::manager::InstallationPhase),
  schemas(agama_lib::network::settings::NetworkConnection),
+ schemas(agama_lib::network::settings::NetworkSettings),
+ schemas(agama_lib::network::settings::WirelessSettings),
+ schemas(agama_lib::network::types::DeviceState),
  schemas(agama_lib::network::types::DeviceType),
+ schemas(agama_lib::network::types::Status),
  schemas(agama_lib::product::Product),
  schemas(agama_lib::software::Pattern),
  schemas(agama_lib::storage::model::Action),
@@ -95,8 +101,21 @@ use utoipa::OpenApi;
  schemas(crate::l10n::TimezoneEntry),
  schemas(crate::l10n::web::LocaleConfig),
  schemas(crate::manager::web::InstallerStatus),
+ schemas(crate::network::model::BondConfig),
+ schemas(crate::network::model::BridgeConfig),
  schemas(crate::network::model::Connection),
+ schemas(crate::network::model::ConnectionConfig),
  schemas(crate::network::model::Device),
+ schemas(crate::network::model::InfinibandConfig),
+ schemas(crate::network::model::IpConfig),
+ schemas(crate::network::model::MacAddress),
+ schemas(crate::network::model::MatchConfig),
+ schemas(crate::network::model::PortConfig),
+ schemas(crate::network::model::SecurityProtocol),
+ schemas(crate::network::model::TunConfig),
+ schemas(crate::network::model::VlanConfig),
+ schemas(crate::network::model::VlanProtocol),
+ schemas(crate::network::model::WirelessConfig),
  schemas(crate::questions::web::Answer),
  schemas(crate::questions::web::GenericAnswer),
  schemas(crate::questions::web::GenericQuestion),