Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft: Add sequence diagram draft #29

Closed
wants to merge 1 commit into from
Closed

Draft: Add sequence diagram draft #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions sequence.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}

```
Loading