Add design doc

damccull · Oct 1, 2023 · 9a9bd41 · 9a9bd41
1 parent eb45b10
commit 9a9bd41
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/design_doc.md b/design_doc.md
@@ -0,0 +1,13 @@
+# Design Doc
+
+## Events DB Representation
+All events will contain the following metadata as database fields. Context about the type of event will be provided by its name in rust and the event_type field in the database.
+
+* event_id
+* ocieitem_id
+* event_type
+* created_timestamp
+* created_by
+* change_vector
+
+All events will contain json that contains arbitrary data fields. The deserialization will pick up only the fields it cares about, ignoring the rest.