Merge pull request #429 from cookeac/sourceid-documentation-366

Update descriptions re meta and sourceId. Resolves #366. Includes feedback from meeting 2023-11-30.
adewg · Nov 30, 2023 · c50dca1 · c50dca1
2 parents be446a6 + 0f094a4
commit c50dca1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/resources/icarResource.json b/resources/icarResource.json
@@ -22,7 +22,8 @@
     },
     "meta": {
       "$ref": "../types/icarMetaDataType.json",
-      "description": "Meta-data for the resource. Mandatory if you wish to support synchronisation."
+      "description": "Meta-data for the resource. Mandatory if you wish to support synchronisation.\n Systems should maintain and provide meta data if at all possible.",
+      "$comment": "ICAR ADE working group intend meta to be required in the next major release of ADE."
     },
     "location": {
       "$ref": "../types/icarLocationIdentifierType.json",

diff --git a/types/icarMetaDataType.json b/types/icarMetaDataType.json
@@ -14,7 +14,8 @@
     },
     "sourceId": {
       "type": "string",
-      "description": "Unique Id (ideally UUID) for the resource in the original source system. Treat source and sourceId as an icarIdentifierType."
+      "description": "Unique Id within Source (e.g. UUID, IRI, URI, or composite ID if needed) for the resource in the original source system. \n Systems should generate (if needed), store, and return sourceId if at all possible.",
+      "$comment": "ICAR ADE working group intend to make use of metadata, source and sourceId mandatory in the next major release (2.0)."
     },  
     "isDeleted": {
       "type": "boolean",