fix: generate config schema and ensure they are up-to-date

.github/workflows/ci.yaml

@@ -49,3 +49,11 @@ jobs:
           RUST_LOG: info,sqlx=error,sea_orm=error
       - name: Validate Generated Openapi Spec
         run: cargo xtask validate-openapi
+      - name: Ensure schemas are up-to-date
+        run: |
+          cargo xtask generate-schemas
+          git diff --quiet
+          if [ $? -gt 0 ]; then
+              echo "::error::Uncommitted changes (run `cargo xtask generate-schemas` after making changes to the models)"
+              exit 1
+          fi

entity/Cargo.toml

@@ -9,6 +9,7 @@ trustify-cvss = { workspace = true }
 
 async-graphql = { workspace = true, features = ["uuid", "time"] }
 cpe = { workspace = true }
+schemars = { workspace = true }
 sea-orm = { workspace = true, features = [
     "sqlx-postgres",
     "runtime-tokio-rustls",

entity/src/labels.rs

@@ -14,6 +14,7 @@ use utoipa::ToSchema;
     ::serde::Serialize,
     ::serde::Deserialize,
     sea_orm::FromJsonQueryResult,
+    schemars::JsonSchema,
 )]
 pub struct Labels(pub HashMap<String, String>);
 

modules/importer/Cargo.toml

@@ -24,6 +24,7 @@ osv = { workspace = true, features = ["schema"] }
 parking_lot = { workspace = true }
 regex = { workspace = true }
 sbom-walker = { workspace = true }
+schemars = { workspace = true, features = ["url"] }
 sea-orm = { workspace = true, features = ["sea-query-binder", "sqlx-postgres", "runtime-tokio-rustls", "macros", "debug-print"] }
 sea-query = { workspace = true }
 serde = { workspace = true, features = ["derive"] }

modules/importer/src/lib.rs

@@ -1,3 +1,5 @@
+#![recursion_limit = "256"]
+
 pub mod endpoints;
 pub mod model;
 pub mod server;

modules/importer/src/model/csaf.rs

@@ -1,6 +1,15 @@
 use super::*;
 
-#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize, ToSchema)]
+#[derive(
+    Clone,
+    Debug,
+    PartialEq,
+    Eq,
+    serde::Serialize,
+    serde::Deserialize,
+    ToSchema,
+    schemars::JsonSchema,
+)]
 #[serde(rename_all = "camelCase")]
 pub struct CsafImporter {
     #[serde(flatten)]

modules/importer/src/model/cve.rs

@@ -1,7 +1,16 @@
 use super::*;
 use std::collections::HashSet;
 
-#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize, ToSchema)]
+#[derive(
+    Clone,
+    Debug,
+    PartialEq,
+    Eq,
+    serde::Serialize,
+    serde::Deserialize,
+    ToSchema,
+    schemars::JsonSchema,
+)]
 #[serde(rename_all = "camelCase")]
 pub struct CveImporter {
     #[serde(flatten)]

modules/importer/src/model/mod.rs

@@ -83,7 +83,16 @@ pub struct ImporterData {
     pub continuation: serde_json::Value,
 }
 
-#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize, ToSchema)]
+#[derive(
+    Clone,
+    Debug,
+    PartialEq,
+    Eq,
+    serde::Serialize,
+    serde::Deserialize,
+    ToSchema,
+    schemars::JsonSchema,
+)]
 #[serde(rename_all = "camelCase")]
 pub enum ImporterConfiguration {
     Sbom(SbomImporter),
@@ -116,7 +125,16 @@ impl DerefMut for ImporterConfiguration {
     }
 }
 
-#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize, ToSchema)]
+#[derive(
+    Clone,
+    Debug,
+    PartialEq,
+    Eq,
+    serde::Serialize,
+    serde::Deserialize,
+    ToSchema,
+    schemars::JsonSchema,
+)]
 #[serde(rename_all = "camelCase")]
 pub struct CommonImporter {
     /// A flag to disable the importer, without deleting it.
@@ -125,6 +143,7 @@ pub struct CommonImporter {
 
     /// The period the importer should be run.
     #[serde(with = "humantime_serde")]
+    #[schemars(with = "HumantimeSerde")]
     pub period: Duration,
 
     /// A description for users.
@@ -136,6 +155,10 @@ pub struct CommonImporter {
     pub labels: Labels,
 }
 
+// Just here to create a schema for humantime_serde.
+#[derive(schemars::JsonSchema)]
+struct HumantimeSerde(#[allow(unused)] String);
+
 impl TryFrom<Model> for Importer {
     type Error = serde_json::Error;
 

modules/importer/src/model/osv.rs

@@ -1,6 +1,15 @@
 use super::*;
 
-#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize, ToSchema)]
+#[derive(
+    Clone,
+    Debug,
+    PartialEq,
+    Eq,
+    serde::Serialize,
+    serde::Deserialize,
+    ToSchema,
+    schemars::JsonSchema,
+)]
 #[serde(rename_all = "camelCase")]
 pub struct OsvImporter {
     #[serde(flatten)]

modules/importer/src/model/sbom.rs

@@ -1,6 +1,15 @@
 use super::*;
 
-#[derive(Clone, Debug, PartialEq, Eq, serde::Serialize, serde::Deserialize, ToSchema)]
+#[derive(
+    Clone,
+    Debug,
+    PartialEq,
+    Eq,
+    serde::Serialize,
+    serde::Deserialize,
+    ToSchema,
+    schemars::JsonSchema,
+)]
 #[serde(rename_all = "camelCase")]
 pub struct SbomImporter {
     #[serde(flatten)]

xtask/Cargo.toml

@@ -9,12 +9,14 @@ anyhow = { workspace = true }
 clap = { workspace = true, features = ["derive", "env"] }
 log = { workspace = true }
 postgresql_commands = { workspace = true }
-serde= { workspace = true}
+schemars = { workspace = true }
+serde = { workspace = true }
 serde_json = { workspace = true }
 serde_yaml = { workspace = true }
 tokio = { workspace = true, features = ["full"] }
 tracing-subscriber = { workspace = true, features = ["env-filter", "tracing-log", "ansi"] }
 
+trustify-auth = { workspace = true }
 trustify-common = { workspace = true }
 trustify-module-importer = { workspace = true }
 trustify-module-ingestor = { workspace = true }