diff --git a/.gitignore b/.gitignore index 7c30ceeb..8e05b9a0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ target/ .vscode/ -release.properties \ No newline at end of file +release.properties +*~ diff --git a/docs/dev/model/README.md b/docs/dev/model/README.md index bfac5aea..a8dbd19e 100644 --- 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~ deleted file mode 100644 index 00a81ac3..00000000 --- a/docs/dev/model/README.md~ +++ /dev/null @@ -1,32 +0,0 @@ -# PASS Data Model - -PASS provides a unified user interface that allow its users to deposit their manuscripts into multiple repositories as required by the associated funding agency's public access policies. - -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 - -## Model Objects -The data model consists of the following components. Each is documented in full on its own page, you can see all of these pages in the [documentation](documentation/) folder - -* [Contributor](documentation/Contributor.md) -* [Deposit](documentation/Deposit.md) -* [File](documentation/File.md) -* [Funder](documentation/Funder.md) -* [Grant](documentation/Grant.md) -* [Journal](documentation/Journal.md) -* [Policy](documentation/Policy.md) -* [Publication](documentation/Publication.md) -* [Publisher](documentation/Publisher.md) -* [Repository](documentation/Repository.md) -* [RepositoryCopy](documentation/RepositoryCopy.md) -* [Submission](documentation/Submission.md) -* [SubmissionEvent](documentation/SubmissionEvent.md) -* [User](documentation/User.md) - -The system also automatically creates additional properties for each entity. These are documented in [System Properties](SystemProperties.md). - -## Model Diagram - -![data model](pass_data_model.jpg) -