From b941d7e7b6c9e92f6e4c01c52d53d84132862124 Mon Sep 17 00:00:00 2001
From: Jens Reimann <ctron@dentrassi.de>
Date: Wed, 10 Jul 2024 09:36:51 +0200
Subject: [PATCH] docs: describe IngestResult struct and fields

---
 modules/ingestor/src/model.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/modules/ingestor/src/model.rs b/modules/ingestor/src/model.rs
index 685a9bbc..7f6fad4d 100644
--- 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>,
 }