Add OpenAPI schemas for the sbom details.

JimFuller-RedHat · Jul 19, 2024 · 54e4744 · 54e4744
1 parent 23f4fae
commit 54e4744
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/modules/fundamental/src/sbom/endpoints/mod.rs b/modules/fundamental/src/sbom/endpoints/mod.rs
@@ -63,7 +63,12 @@ pub fn configure(config: &mut web::ServiceConfig, db: Database) {
         crate::sbom::model::SbomPackage,
         crate::sbom::model::SbomPackageRelation,
         crate::sbom::model::SbomSummary,
+        crate::sbom::model::details::SbomDetails,
+        crate::sbom::model::details::SbomAdvisory,
+        crate::sbom::model::details::SbomStatus,
+        crate::sbom::model::SbomHead,
         crate::sbom::model::Which,
+        crate::purl::model::details::purl::StatusContext,
         trustify_common::advisory::AdvisoryVulnerabilityAssertions,
         trustify_common::advisory::Assertion,
         trustify_common::purl::Purl,
@@ -165,7 +170,7 @@ pub async fn all_related(
         ("id" = string, Path, description = "Digest/hash of the document, prefixed by hash type, such as 'sha256:<hash>' or 'urn:uuid:<uuid>'"),
     ),
     responses(
-        (status = 200, description = "Matching SBOM", body = SbomSummary),
+        (status = 200, description = "Matching SBOM", body = SbomDetails),
         (status = 404, description = "Matching SBOM not found"),
     ),
 )]

diff --git a/modules/fundamental/src/sbom/model/details.rs b/modules/fundamental/src/sbom/model/details.rs
@@ -10,8 +10,9 @@ use std::collections::HashMap;
 use time::OffsetDateTime;
 use trustify_common::cpe::CpeCompare;
 use trustify_common::db::ConnectionOrTransaction;
+use utoipa::ToSchema;
 
-#[derive(Debug, Serialize, Deserialize)]
+#[derive(Debug, Serialize, Deserialize, ToSchema)]
 pub struct SbomDetails {
     #[serde(flatten)]
     pub head: SbomHead,
@@ -27,7 +28,7 @@ pub struct SbomDetails {
     pub advisories: Vec<SbomAdvisory>,
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, ToSchema)]
 pub struct SbomAdvisory {
     #[serde(flatten)]
     pub head: AdvisoryHead,
@@ -146,7 +147,7 @@ impl SbomAdvisory {
     }
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, ToSchema)]
 pub struct SbomStatus {
     pub vulnerability_id: String,
     pub status: String,