Update model documentation

eclipse-pass · Nov 9, 2023 · bce9305 · bce9305
1 parent 412f3b2
commit bce9305
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 37 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 target/
 .vscode/
-release.properties
+release.properties
+*~
diff --git a/docs/dev/model/README.md b/docs/dev/model/README.md
@@ -1,5 +1,7 @@
 # PASS Data Model
 
+The PASS data model is represented using (JSON API)[https://jsonapi.org/].
+
 In this project you will find
 * [Model Objects](#model-objects) - a description of the fields for each object in the model
 * [Model Diagram](#model-diagram) - a diagram showing the relationships between each object
@@ -24,12 +26,12 @@ The data model consists of the following components. Each is documented in full
 
 ![data model](pass_data_model.jpg)
 
+## Notes
 
-## JSON API
-
-Note that an object is uniquely idnetified by an identifier type tuple. See specification. See elide.
+### Identifiers
 
+An object is uniquely identified by a tuple consiting of its id attribute and its type.
 
-## DateTime attributes
+### DateTime attributes
 
 DateTime attributes are strings formatted as per the Java DateTimeFormatter with pattern `yyyy-MM-dd'T'HH:mm:ss.SSSX`.
diff --git a/docs/dev/model/README.md~ b/docs/dev/model/README.md~