docs: describe IngestResult struct and fields

trustification · Jul 11, 2024 · b941d7e · b941d7e
1 parent df55ad3
commit b941d7e
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/modules/ingestor/src/model.rs b/modules/ingestor/src/model.rs
@@ -1,9 +1,13 @@
 use trustify_common::id::Id;
 
+/// The result of the ingestion process
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
 pub struct IngestResult {
+    /// The internal ID of the document
     pub id: Id,
+    /// The ID declared by the document
     pub document_id: String,
+    /// Warnings that occurred during the import process
     #[serde(default, skip_serializing_if = "Vec::is_empty")]
     pub warnings: Vec<String>,
 }