Update descriptions re meta and sourceId

Update the descriptions of meta and sourceId to show that they SHOULD be filled, stored, and retained if at all possible. Will be required in future major release. Resolves adewg#366 (sort of)
cookeac · Nov 16, 2023 · 25c0ce5 · 25c0ce5
1 parent 4b8a90e
commit 25c0ce5
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 or composite ID if needed) for the resource in the original source system. \n Systems are expected to populate, 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."
     },  
     "isDeleted": {
       "type": "boolean",