From 61799c95295bbfa50ac8767ef4a0c28976429a30 Mon Sep 17 00:00:00 2001
From: Philipp Wissmann <philipp.wissmann@ethz.ch>
Date: Mon, 28 Oct 2024 09:56:57 +0100
Subject: [PATCH] Add sequence diagram draft

---
 sequence.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 sequence.md

diff --git a/sequence.md b/sequence.md
new file mode 100644
index 0000000..83ab502
--- /dev/null
+++ b/sequence.md
@@ -0,0 +1,48 @@
+# Ingestion Sequence
+
+* Participants
+* Expected sequence
+* Endpoints
+* Data
+
+```mermaid
+sequenceDiagram
+  participant S as Scicat Backend
+  participant U as Ingestor UI 
+  participant B as Ingestor Backend 
+  participant M as Metadata Extractor
+
+    S -->> U: Serve Ingestor UI
+    U -->> B: Establish Connection: GET /version
+    activate B
+    B -->> U: version
+    deactivate B
+
+    U -->> B: Get Available Extractors: GET /extractors
+    activate B
+    B -->> U: extractor names
+    deactivate B
+
+    U -->> B: Get Folder List: GET /datasets
+    activate B
+    B -->> U: folders
+    deactivate B
+    
+    activate B
+    U -->> B: Extract Metadata: POST /extract {folder}
+    B -->> M: Invoke Extractor
+    activate M
+    M -->> M: write metadata.json
+    M -->> B: return status code
+    deactivate M
+    B -->> B: read metadata.json
+    B -->> U: return metdata.json
+    deactivate B
+
+    U -->> U: Display extracted metadata
+
+    U -->> U: Add user metadata
+
+    U -->> B: Start ingestion: POST /transfer {folder, metadata}
+    
+```