Fix OpenAPI for api-v2 (#2864)

imobachgs · web-flow · commit 1bfeb9b60041 · 2026-03-05T07:17:19.000Z
## Problem

The OpenAPI specification is missing some types that implement the
`ToSchema` trait due to name conflicts.

## Solution

Qualify the names so they do not conflict anymore and all of them are
included in the output.

## Testing

- Tested manually
diff --git a/rust/agama-server/src/web/docs/config.rs b/rust/agama-server/src/web/docs/config.rs
@@ -91,21 +91,33 @@ impl ApiDocBuilder for ConfigApiDocBuilder {
             .schema_from::<agama_network::types::SSID>()
             .schema_from::<agama_network::types::Status>()
             .schema_from::<agama_network::types::LinkLocal>()
+            .schema_from::<agama_utils::api::software::Config>()
             .schema_from::<agama_utils::api::software::AddonConfig>()
             .schema_from::<agama_utils::api::software::ProductConfig>()
+            .schema_from::<agama_utils::api::software::SoftwareProposal>()
+            .schema_from::<agama_utils::api::software::SelectedBy>()
+            .schema_from::<agama_utils::api::software::Pattern>()
+            .schema_from::<agama_utils::api::software::Repository>()
+            .schema_from::<agama_utils::api::software::RegistrationInfo>()
+            .schema_from::<agama_utils::api::software::AddonInfo>()
+            .schema_from::<agama_utils::api::software::AddonRegistration>()
             .schema_from::<agama_utils::api::files::BaseScript>()
             .schema_from::<agama_utils::api::files::InitScript>()
             .schema_from::<agama_utils::api::files::PostPartitioningScript>()
             .schema_from::<agama_utils::api::files::PostScript>()
             .schema_from::<agama_utils::api::files::PreScript>()
             .schema_from::<agama_utils::api::files::Script>()
             .schema_from::<agama_utils::api::files::ScriptsConfig>()
+            .schema_from::<agama_utils::api::files::Config>()
             .schema_from::<agama_utils::api::software::PatternsMap>()
             .schema_from::<agama_utils::api::software::PatternsConfig>()
             .schema_from::<agama_utils::api::software::SoftwareConfig>()
             .schema_from::<agama_utils::api::manager::LanguageTag>()
             .schema_from::<agama_utils::api::manager::License>()
             .schema_from::<agama_utils::api::manager::LicenseContent>()
+            .schema_from::<agama_utils::api::manager::Product>()
+            .schema_from::<agama_utils::api::manager::ProductMode>()
+            .schema_from::<agama_utils::api::manager::HardwareInfo>()
             .schema_from::<agama_locale_data::KeymapId>()
             .schema_from::<agama_locale_data::LocaleId>()
             .schema_from::<agama_locale_data::TimezoneId>()
@@ -117,16 +129,39 @@ impl ApiDocBuilder for ConfigApiDocBuilder {
             .schema_from::<agama_utils::api::Patch>()
             .schema_from::<agama_utils::api::Progress>()
             .schema_from::<agama_utils::api::Proposal>()
+            .schema_from::<agama_utils::api::hostname::Proposal>()
+            .schema_from::<agama_utils::api::network::Proposal>()
+            .schema_from::<agama_utils::api::software::Proposal>()
+            .schema_from::<agama_utils::api::l10n::Proposal>()
             .schema_from::<agama_utils::api::Scope>()
             .schema_from::<agama_utils::api::Status>()
             .schema_from::<agama_utils::api::SystemInfo>()
+            .schema_from::<agama_utils::api::manager::SystemInfo>()
+            .schema_from::<agama_utils::api::hostname::SystemInfo>()
+            .schema_from::<agama_utils::api::l10n::SystemInfo>()
+            .schema_from::<agama_utils::api::software::SystemInfo>()
+            .schema_from::<agama_utils::api::network::SystemInfo>()
+            .schema_from::<agama_utils::api::s390::SystemInfo>()
+            .schema_from::<agama_utils::api::bootloader::Config>()
+            .schema_from::<agama_utils::api::hostname::Config>()
+            .schema_from::<agama_utils::api::proxy::Config>()
+            .schema_from::<agama_utils::api::security::Config>()
+            .schema_from::<agama_utils::api::security::SSLFingerprint>()
+            .schema_from::<agama_utils::api::security::SSLFingerprintAlgorithm>()
+            .schema_from::<agama_utils::api::network::Config>()
+            .schema_from::<agama_utils::api::iscsi::Config>()
+            .schema_from::<agama_utils::api::users::Config>()
+            .schema_from::<agama_utils::api::users::config::FirstUserConfig>()
+            .schema_from::<agama_utils::api::users::config::RootUserConfig>()
+            .schema_from::<agama_utils::api::users::config::UserPassword>()
+            .schema_from::<agama_utils::api::s390::Config>()
+            .schema_from::<agama_utils::api::RawConfig>()
             .schema_from::<agama_utils::api::l10n::Config>()
             .schema_from::<agama_utils::api::l10n::Keymap>()
             .schema_from::<agama_utils::api::l10n::LocaleEntry>()
-            .schema_from::<agama_utils::api::l10n::Proposal>()
             .schema_from::<agama_utils::api::l10n::SystemConfig>()
-            .schema_from::<agama_utils::api::l10n::SystemInfo>()
             .schema_from::<agama_utils::api::l10n::TimezoneEntry>()
+            .schema_from::<agama_utils::api::l10n::Translations>()
             .schema_from::<agama_utils::api::network::AccessPoint>()
             .schema_from::<agama_utils::api::network::Device>()
             .schema_from::<agama_utils::api::network::Dhcp4Settings>()
@@ -146,8 +181,6 @@ impl ApiDocBuilder for ConfigApiDocBuilder {
             .schema_from::<agama_utils::api::network::NetworkConnection>()
             .schema_from::<agama_utils::api::network::NetworkConnectionWithState>()
             .schema_from::<agama_utils::api::network::NetworkConnectionsCollection>()
-            .schema_from::<agama_utils::api::network::NetworkSettings>()
-            .schema_from::<agama_utils::api::network::NetworkSettings>()
             .schema_from::<agama_utils::api::network::StateSettings>()
             .schema_from::<agama_utils::api::network::VlanSettings>()
             .schema_from::<agama_utils::api::network::WirelessSettings>()
@@ -160,6 +193,7 @@ impl ApiDocBuilder for ConfigApiDocBuilder {
             .schema_from::<agama_utils::api::question::QuestionSpec>()
             .schema_from::<agama_utils::api::question::SelectionOption>()
             .schema_from::<agama_utils::api::question::UpdateQuestion>()
+            .schema_from::<agama_utils::api::storage::Config>()
             .schema_from::<agama_utils::api::software::RepositoryConfig>()
             .schema_from::<agama_utils::api::status::Stage>()
             .schema_from::<agama_utils::api::query::SolveStorageModel>()
diff --git a/rust/agama-utils/src/api/bootloader.rs b/rust/agama-utils/src/api/bootloader.rs
@@ -26,6 +26,7 @@ use serde::{Deserialize, Serialize};
 #[derive(Clone, Debug, Serialize, Deserialize, Default, Merge, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
 #[merge(strategy = merge::option::overwrite_none)]
+#[schema(as = bootloader::Config)]
 pub struct Config {
     /// Whether bootloader should stop on boot menu.
     #[serde(skip_serializing_if = "Option::is_none")]
diff --git a/rust/agama-utils/src/api/files/config.rs b/rust/agama-utils/src/api/files/config.rs
@@ -29,6 +29,7 @@ use crate::api::files::{
 };
 
 #[derive(Clone, Debug, Default, Serialize, Deserialize, Merge, utoipa::ToSchema)]
+#[schema(as = files::Config)]
 pub struct Config {
     #[serde(skip_serializing_if = "Option::is_none")]
     #[merge(strategy = merge::option::overwrite_none)]
diff --git a/rust/agama-utils/src/api/hostname/config.rs b/rust/agama-utils/src/api/hostname/config.rs
@@ -24,6 +24,7 @@ use serde::{Deserialize, Serialize};
 /// Hostname config.
 #[derive(Clone, Debug, Default, Merge, Serialize, Deserialize, PartialEq, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
+#[schema(as = hostname::Config)]
 pub struct Config {
     #[serde(skip_serializing_if = "Option::is_none")]
     #[merge(strategy = merge::option::overwrite_none)]
diff --git a/rust/agama-utils/src/api/hostname/proposal.rs b/rust/agama-utils/src/api/hostname/proposal.rs
@@ -22,6 +22,7 @@ use serde::{Deserialize, Serialize};
 
 /// Describes what Agama proposes for the target system.
 #[derive(Clone, Debug, Deserialize, Serialize, utoipa::ToSchema)]
+#[schema(as = hostname::Proposal)]
 pub struct Proposal {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub r#static: Option<String>,
diff --git a/rust/agama-utils/src/api/hostname/system_info.rs b/rust/agama-utils/src/api/hostname/system_info.rs
@@ -22,6 +22,7 @@ use serde::{Deserialize, Serialize};
 
 /// Describes the current system hostname information
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize, utoipa::ToSchema)]
+#[schema(as = hostname::SystemInfo)]
 pub struct SystemInfo {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub r#static: Option<String>,
diff --git a/rust/agama-utils/src/api/iscsi/config.rs b/rust/agama-utils/src/api/iscsi/config.rs
@@ -24,6 +24,7 @@ use serde_json::Value;
 
 #[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq, utoipa::ToSchema)]
 #[serde(transparent)]
+#[schema(as = iscsi::Config)]
 pub struct Config(pub Value);
 
 impl Merge for Config {
diff --git a/rust/agama-utils/src/api/l10n/config.rs b/rust/agama-utils/src/api/l10n/config.rs
@@ -24,6 +24,7 @@ use serde::{Deserialize, Serialize};
 /// Localization config.
 #[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Merge, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
+#[schema(as = l10n::Config)]
 pub struct Config {
     /// Locale (e.g., "en_US.UTF-8").
     #[serde(skip_serializing_if = "Option::is_none")]
diff --git a/rust/agama-utils/src/api/l10n/proposal.rs b/rust/agama-utils/src/api/l10n/proposal.rs
@@ -25,6 +25,7 @@ use serde_with::{serde_as, DisplayFromStr};
 /// Describes what Agama proposes for the target system.
 #[serde_as]
 #[derive(Clone, Debug, Deserialize, Serialize, utoipa::ToSchema)]
+#[schema(as = l10n::Proposal)]
 pub struct Proposal {
     /// Keymap (e.g., "us", "cz(qwerty)", etc.).
     #[serde_as(as = "DisplayFromStr")]
diff --git a/rust/agama-utils/src/api/l10n/system_config.rs b/rust/agama-utils/src/api/l10n/system_config.rs
@@ -21,6 +21,7 @@
 use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Debug, Serialize, Deserialize, utoipa::ToSchema)]
+#[schema(as = l10n::SystemConfig)]
 pub struct SystemConfig {
     pub locale: Option<String>,
     pub keymap: Option<String>,
diff --git a/rust/agama-utils/src/api/l10n/system_info.rs b/rust/agama-utils/src/api/l10n/system_info.rs
@@ -27,6 +27,7 @@ use serde_with::{serde_as, DisplayFromStr};
 /// Localization-related information of the system where the installer is running.
 #[serde_as]
 #[derive(Clone, Default, Debug, Serialize, utoipa::ToSchema)]
+#[schema(as = l10n::SystemInfo)]
 pub struct SystemInfo {
     /// List of know locales.
     pub locales: Vec<LocaleEntry>,
diff --git a/rust/agama-utils/src/api/manager/system_info.rs b/rust/agama-utils/src/api/manager/system_info.rs
@@ -23,6 +23,7 @@ use serde::Serialize;
 
 /// Global information of the system where the installer is running.
 #[derive(Clone, Debug, Default, Serialize, utoipa::ToSchema)]
+#[schema(as = manager::SystemInfo)]
 pub struct SystemInfo {
     /// List of known products.
     pub products: Vec<Product>,
diff --git a/rust/agama-utils/src/api/network/config.rs b/rust/agama-utils/src/api/network/config.rs
@@ -28,6 +28,7 @@ use std::default::Default;
 /// Network config settings for installation
 #[derive(Clone, Debug, Default, Serialize, Deserialize, Merge, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
+#[schema(as = network::Config)]
 pub struct Config {
     /// Connections to use in the installation
     #[serde(skip_serializing_if = "Option::is_none")]
diff --git a/rust/agama-utils/src/api/network/proposal.rs b/rust/agama-utils/src/api/network/proposal.rs
@@ -27,6 +27,7 @@ use std::default::Default;
 /// Network proposal settings for installation
 #[derive(Clone, Debug, Default, Serialize, Deserialize, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
+#[schema(as = network::Proposal)]
 pub struct Proposal {
     /// Connections to use in the installation
     pub connections: NetworkConnectionsCollection,
diff --git a/rust/agama-utils/src/api/network/system_info.rs b/rust/agama-utils/src/api/network/system_info.rs
@@ -27,6 +27,7 @@ use std::default::Default;
 /// Network settings for installation
 #[derive(Clone, Debug, Default, Serialize, Deserialize, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
+#[schema(as = network::SystemInfo)]
 pub struct SystemInfo {
     pub access_points: Vec<AccessPoint>, // networks or access_points shold be returned
     /// Connections to use in the installation
diff --git a/rust/agama-utils/src/api/proxy/config.rs b/rust/agama-utils/src/api/proxy/config.rs
@@ -24,6 +24,7 @@ use serde::{Deserialize, Serialize};
 /// Proxy config.
 #[derive(Clone, Debug, Default, Merge, Serialize, Deserialize, PartialEq, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
+#[schema(as = proxy::Config)]
 pub struct Config {
     #[serde(skip_serializing_if = "Option::is_none")]
     #[merge(strategy = merge::option::overwrite_none)]
diff --git a/rust/agama-utils/src/api/question.rs b/rust/agama-utils/src/api/question.rs
@@ -34,6 +34,7 @@ pub enum Error {
 /// Questions configuration.
 #[derive(Clone, Debug, Default, Serialize, Deserialize, Merge, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
+#[schema(as = questions::Config)]
 pub struct Config {
     #[serde(skip_serializing_if = "Option::is_none")]
     #[merge(strategy = merge::option::overwrite_none)]
diff --git a/rust/agama-utils/src/api/s390/config.rs b/rust/agama-utils/src/api/s390/config.rs
@@ -27,6 +27,7 @@ use serde_with::skip_serializing_none;
 #[derive(Clone, Debug, Default, Deserialize, Serialize, Merge, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
 #[merge(strategy = merge::option::recurse)]
+#[schema(as = s390::Config)]
 /// s390 configuration.
 pub struct Config {
     /// Configuration of the DASD devices.
diff --git a/rust/agama-utils/src/api/s390/system_info.rs b/rust/agama-utils/src/api/s390/system_info.rs
@@ -25,6 +25,7 @@ use serde_with::skip_serializing_none;
 #[skip_serializing_none]
 #[derive(Clone, Debug, Serialize, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
+#[schema(as = s390::SystemInfo)]
 pub struct SystemInfo {
     pub dasd: Option<Value>,
 }
diff --git a/rust/agama-utils/src/api/security.rs b/rust/agama-utils/src/api/security.rs
@@ -27,6 +27,7 @@ use serde::{Deserialize, Deserializer, Serialize};
 /// Security settings for installation
 #[derive(Clone, Debug, Default, Serialize, Deserialize, Merge, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
+#[schema(as = security::Config)]
 pub struct Config {
     /// List of user selected patterns to install.
     #[serde(skip_serializing_if = "Option::is_none")]
diff --git a/rust/agama-utils/src/api/software/proposal.rs b/rust/agama-utils/src/api/software/proposal.rs
@@ -49,6 +49,7 @@ pub struct SoftwareProposal {
 /// Describes what Agama proposes for the target system.
 #[derive(Clone, Default, Debug, Deserialize, Serialize, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
+#[schema(as = software::Proposal)]
 pub struct Proposal {
     /// Software specific proposal
     #[serde(flatten, skip_serializing_if = "Option::is_none")]
diff --git a/rust/agama-utils/src/api/software/system_info.rs b/rust/agama-utils/src/api/software/system_info.rs
@@ -27,6 +27,7 @@ use serde_with::skip_serializing_none;
 /// is running.
 #[skip_serializing_none]
 #[derive(Clone, Debug, Default, Serialize, utoipa::ToSchema)]
+#[schema(as = software::SystemInfo)]
 pub struct SystemInfo {
     /// List of known patterns.
     pub patterns: Vec<Pattern>,
diff --git a/rust/agama-utils/src/api/storage/config.rs b/rust/agama-utils/src/api/storage/config.rs
@@ -24,6 +24,7 @@ use serde_json::Value;
 
 #[derive(Clone, Debug, Default, Serialize, Deserialize, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
+#[schema(as = storage::Config)]
 pub struct Config {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub storage: Option<Value>,
diff --git a/rust/agama-utils/src/api/users/config.rs b/rust/agama-utils/src/api/users/config.rs
@@ -26,6 +26,7 @@ use serde::{Deserialize, Serialize};
 /// Holds the user settings for the installation.
 #[derive(Clone, Debug, Default, Merge, Serialize, Deserialize, PartialEq, utoipa::ToSchema)]
 #[serde(rename_all = "camelCase")]
+#[schema(as = users::Config)]
 pub struct Config {
     #[merge(strategy = merge::option::overwrite_none)]
     #[serde(rename = "user")]
diff --git a/rust/package/agama.changes b/rust/package/agama.changes
@@ -1,3 +1,9 @@
+-------------------------------------------------------------------
+Thu Mar  5 07:14:07 UTC 2026 - Imobach Gonzalez Sosa <igonzalezsosa@suse.com>
+
+- Fix the generation of the OpenAPI specification
+  (gh#agama-project/agama#2864).
+
 -------------------------------------------------------------------
 Wed Mar  4 07:03:28 UTC 2026 - Imobach Gonzalez Sosa <igonzalezsosa@suse.com>
 
