Models for Future Structured Tool State Work

.gitignore

@@ -153,6 +153,7 @@ doc/build
 doc/schema.md
 doc/source/admin/config_logging_default_yaml.rst
 doc/source/dev/schema.md
+doc/source/dev/plantuml.jar
 client/docs/dist
 
 # Webpack stats

doc/source/dev/image.Makefile

@@ -0,0 +1,11 @@
+MINDMAPS := $(wildcard *.mindmap.yml)
+INPUTS := $(wildcard *.plantuml.txt)
+OUTPUTS := $(INPUTS:.txt=.svg)
+
+all: plantuml.jar $(MINDMAPS) $(OUTPUTS)
+
+$(OUTPUTS): $(INPUTS) $(MINDMAPS)
+	java -jar plantuml.jar -c plantuml_options.txt -tsvg $(INPUTS)
+
+plantuml.jar:
+	wget http://jaist.dl.sourceforge.net/project/plantuml/plantuml.jar || curl --output plantuml.jar http://jaist.dl.sourceforge.net/project/plantuml/plantuml.jar

doc/source/dev/plantuml_options.txt

@@ -0,0 +1,51 @@
+' skinparam handwritten true
+' skinparam roundcorner 20
+
+skinparam class {
+    ArrowFontColor DarkOrange
+    BackgroundColor #FFEFD5
+    ArrowColor Orange
+    BorderColor DarkOrange
+}
+
+skinparam object {
+    ArrowFontColor DarkOrange
+    BackgroundColor #FFEFD5
+    BackgroundColor #FFEFD5
+    ArrowColor Orange
+    BorderColor DarkOrange
+}
+
+skinparam ComponentBackgroundColor #FFEFD5
+skinparam ComponentBorderColor DarkOrange
+
+skinparam DatabaseBackgroundColor #FFEFD5
+skinparam DatabaseBorderColor DarkOrange
+
+skinparam StorageBackgroundColor #FFEFD5
+skinparam StorageBorderColor DarkOrange
+
+skinparam QueueBackgroundColor #FFEFD5
+skinparam QueueBorderColor DarkOrange
+
+skinparam note {
+    BackgroundColor #FFEFD5
+    BorderColor #BF5700
+}
+
+skinparam sequence {
+    ArrowColor Orange
+    ArrowFontColor DarkOrange
+    ActorBorderColor DarkOrange
+    ActorBackgroundColor #FFEFD5
+
+    ParticipantBorderColor DarkOrange
+    ParticipantBackgroundColor #FFEFD5
+
+    LifeLineBorderColor DarkOrange
+    LifeLineBackgroundColor #FFEFD5
+
+    DividerBorderColor DarkOrange
+    GroupBorderColor DarkOrange
+}
+

doc/source/dev/plantuml_style.txt

@@ -0,0 +1,9 @@
+<style>
+mindmapDiagram {
+    node {
+        BackgroundColor #FFEFD5
+        BorderColor DarkOrange
+        LineColor Orange
+    }
+}
+</style>

doc/source/dev/tool_state_api.plantuml.txt

@@ -0,0 +1,17 @@
+@startuml
+'!include plantuml_options.txt
+participant "API Request" as apireq
+boundary    "Jobs API"    as api
+participant     "Job Service" as service
+database    Database    as database
+queue       TaskQueue   as queue
+apireq -> api : HTTP JSON
+api -> service : To boundary
+service -> service : Build RequestToolState
+service -> service : Validate RequestToolState (pydantic)
+service -> service : decode() RequestToolState \ninto RequestInternalToolState
+service -> database : Serialize RequestInternalToolState
+service -> queue : Queue QueueJobs with reference to\npersisted RequestInternalToolState
+service -> api : JobCreateResponse\n (pydantic model)
+api -> apireq : JobCreateResponse\n (as json)
+@enduml