Adding description attribute to activity classes - closes #30

biocaddie · Aug 25, 2016 · 2b2de9a · 2b2de9a
1 parent 97fd07a
commit 2b2de9a
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 5 deletions.
diff --git a/json-schemas/activity_schema.json b/json-schemas/activity_schema.json
@@ -29,6 +29,10 @@
       "description": "The name of the activity, usually one sentece or short description of the activity.",
       "type" :  "string"
     },
+    "description" : {
+      "description": "A textual narrative comprised of one or more statements describing the activity.",
+      "type" : "string"
+    },
     "startDate": {
       "description": "A timestamp to record the starting point of the activity.",
       "$ref": "date_info_schema.json#"
@@ -37,7 +41,7 @@
       "description": "A timestamp to record the end point of the activity.",
       "$ref": "date_info_schema.json#"
     },
-     "dates" : {
+    "dates" : {
       "description": "Relevant dates for the datasets, a date must be added, e.g. creation date or last modification date should be added.",
       "type" : "array",
       "items" : {

diff --git a/json-schemas/data_acquisition_schema.json b/json-schemas/data_acquisition_schema.json
@@ -26,9 +26,13 @@
             }
         },
         "name": {
-            "description": "The name of the activity, usually one sentece or short description of the activity.",
+            "description": "The name of the activity, usually one sentece or short description of the data acquisition.",
             "type" :  "string"
         },
+        "description" : {
+            "description": "A textual narrative comprised of one or more statements describing the data acquisition.",
+            "type" : "string"
+        },
         "startDate": {
             "description": "A timestamp to record the starting point of the activity.",
             "$ref": "date_info_schema.json#"

diff --git a/json-schemas/data_analysis_schema.json b/json-schemas/data_analysis_schema.json
@@ -26,9 +26,13 @@
       }
     },
     "name": {
-      "description": "The name of the activity, usually one sentece or short description of the activity.",
+      "description": "The name of the activity, usually one sentece or short description of the data analysis.",
       "type" :  "string"
     },
+    "description" : {
+      "description": "A textual narrative comprised of one or more statements describing the data analysis.",
+      "type" : "string"
+    },
     "startDate": {
       "description": "A timestamp to record the starting point of the activity.",
       "$ref": "date_info_schema.json#"

diff --git a/json-schemas/study_schema.json b/json-schemas/study_schema.json
@@ -26,9 +26,13 @@
       }
     },
     "name": {
-      "description": "The name of the activity, usually one sentece or short description of the activity.",
+      "description": "The name of the activity, usually one sentece or short description of the study.",
       "type": "string"
     },
+    "description" : {
+      "description": "A textual narrative comprised of one or more statements describing the study.",
+      "type" : "string"
+    },
     "types": {
       "description": "The types of study (e.g. intervention or observation or meta-analysis or clinical trials, or behavioural study, or the study design).",
       "type": "array",

diff --git a/json-schemas/treatment_schema.json b/json-schemas/treatment_schema.json
@@ -26,9 +26,13 @@
       }
     },
     "name": {
-      "description": "The name of the activity, usually one sentece or short description of the activity.",
+      "description": "The name of the activity, usually one sentece or short description of the treatment.",
       "type" :  "string"
     },
+    "description" : {
+      "description": "A textual narrative comprised of one or more statements describing the treatment.",
+      "type" : "string"
+    },
     "startDate": {
       "description": "A timestamp to record the starting point of the activity.",
       "$ref": "date_info_schema.json#"