Merge pull request #420 from donwilson-rezare/donwilson-Descriptions

Descriptions added or modified
adewg · Sep 26, 2023 · 8211348 · 8211348
2 parents 6a32bbe + e5c9063
commit 8211348
Show file tree

Hide file tree

Showing 17 changed files with 39 additions and 24 deletions.
diff --git a/enums/icarPositionOnAnimalType.json b/enums/icarPositionOnAnimalType.json
@@ -1,5 +1,5 @@
 { 
-    "description": "Enumeration for treatment or diagnosed positions.",
+    "description": "Enumeration for the position on the animal where the diagnosis or treatment occurred.",
 
     "type": "string",
 

diff --git a/resources/icarDeviceResource.json b/resources/icarDeviceResource.json
@@ -38,6 +38,7 @@
     },
     "supportedMessages": {
       "type": "array",
+      "description": "Identifies message types supported for the device",
       "items": {
         "type": "object",
         "properties": {

diff --git a/resources/icarEventCoreResource.json b/resources/icarEventCoreResource.json
@@ -1,5 +1,5 @@
 {
-  "description": "",
+  "description": "Core schema for representing an event.",
 
   "allOf": [
     {

diff --git a/resources/icarGroupMovementArrivalEventResource.json b/resources/icarGroupMovementArrivalEventResource.json
@@ -10,11 +10,12 @@
 
             "properties": {
                 "arrivalReason": {
-                    "$ref": "../enums/icarArrivalReasonType.json"
+                    "$ref": "../enums/icarArrivalReasonType.json",
+                    "description": "Reason the group of animals arrived on the holding."
                 },
                 "consignment": {
-                    "$ref": "../types/icarConsignmentType.json"
-
+                    "$ref": "../types/icarConsignmentType.json",
+                    "description": "Identifies the consignment of the group of animals to the holding."
                 }
             }
         }

diff --git a/resources/icarMovementArrivalEventResource.json b/resources/icarMovementArrivalEventResource.json
@@ -9,13 +9,16 @@
 
       "properties": {
         "arrivalReason": {
-          "$ref": "../enums/icarArrivalReasonType.json"
+          "$ref": "../enums/icarArrivalReasonType.json",
+          "description": "Reason the animal arrived on the holding."
         },
         "animalDetail": {
-          "$ref": "icarAnimalCoreResource.json"
+          "$ref": "icarAnimalCoreResource.json",
+          "description": "Core animal details. Can be used if the animal has not already been defined on the holding."
         },
         "consignment": {
-          "$ref": "../types/icarConsignmentType.json"
+          "$ref": "../types/icarConsignmentType.json",
+          "description": "Identifies the consignment of the animal to the holding."
         }
       }
     }

diff --git a/resources/icarMovementBirthEventResource.json b/resources/icarMovementBirthEventResource.json
@@ -13,10 +13,12 @@
 
       "properties": {
         "registrationReason": {
-          "$ref": "../enums/icarRegistrationReasonType.json"
+          "$ref": "../enums/icarRegistrationReasonType.json",
+          "description": "Identifies whether this is a birth or a registration event"
         },
         "animalDetail": {
-          "$ref": "../resources/icarAnimalCoreResource.json"
+          "$ref": "../resources/icarAnimalCoreResource.json",
+          "description": "Core animal details.  Can be used if the animal has not already been defined on the holding."
         }
       }
     }

diff --git a/resources/icarMovementDeathEventResource.json b/resources/icarMovementDeathEventResource.json
@@ -29,7 +29,8 @@
           "description": "Reference (receipt, docket, or ID) for disposal."
         },
         "consignment": {
-          "$ref": "../types/icarConsignmentType.json"
+          "$ref": "../types/icarConsignmentType.json",
+          "description": "Identifies the consignment of the animal from the holding."
         },        
         "deathMethod": {
           "$ref": "../enums/icarDeathMethodType.json",

diff --git a/resources/icarMovementDepartureEventResource.json b/resources/icarMovementDepartureEventResource.json
@@ -9,13 +9,16 @@
 
       "properties": {
         "departureKind": {
-          "$ref": "../enums/icarDepartureKindType.json"
+          "$ref": "../enums/icarDepartureKindType.json",
+          "description": "Identifies the kind of departure of the animal from the holding."
         },
         "departureReason": {
-          "$ref": "../enums/icarDepartureReasonType.json"
+          "$ref": "../enums/icarDepartureReasonType.json",
+          "description": "Identifies the reason for the departure of the animal from the holding."
         },
         "consignment": {
-          "$ref": "../types/icarConsignmentType.json"
+          "$ref": "../types/icarConsignmentType.json",
+          "description": "Identifies the consignment of the animal from the holding."
         }
       }
     }

diff --git a/resources/icarReproPregnancyCheckEventResource.json b/resources/icarReproPregnancyCheckEventResource.json
@@ -14,7 +14,7 @@
         },
         "result": {
           "$ref": "../enums/icarReproPregnancyResultType.json",
-          "description": "Result - uknown, empty, pregnant."
+          "description": "Result - unknown, empty, pregnant."
         },
         "foetalAge": {
           "type": "integer",

diff --git a/types/icarConsumedFeedType.json b/types/icarConsumedFeedType.json
@@ -12,7 +12,7 @@
     },
     "entitlement": {
       "$ref": "../types/icarFeedQuantityType.json",
-      "description": "The amount of feed the animal was entitled to reveive"
+      "description": "The amount of feed the animal was entitled to receive"
     },
     "feedConsumption": {
       "$ref": "../types/icarFeedQuantityType.json",

diff --git a/types/icarConsumedRationType.json b/types/icarConsumedRationType.json
@@ -13,7 +13,7 @@
     },
     "entitlement": {
       "$ref": "../types/icarFeedQuantityType.json",
-      "description": "The amount of feed the animal was entitled to reveive"
+      "description": "The amount of feed the animal was entitled to receive"
     },
     "feedConsumption": {
       "$ref": "../types/icarFeedQuantityType.json",

diff --git a/types/icarDeviceReferenceType.json b/types/icarDeviceReferenceType.json
@@ -1,5 +1,5 @@
 {
-  "description": "",
+  "description": "Device reference details.",
 
   "allOf": [{
       "$ref": "../types/icarResourceReferenceType.json"

diff --git a/types/icarFeedDurationType.json b/types/icarFeedDurationType.json
@@ -14,7 +14,8 @@
     },
     "value": {
       "type": "number",
-      "format": "double"
+      "format": "double",
+      "description": "The duration of the feeding in the units specified."
     }
   }
 }
diff --git a/types/icarFeedQuantityType.json b/types/icarFeedQuantityType.json
@@ -15,7 +15,8 @@
     },
     "value": {
       "type": "number",
-      "format": "double"
+      "format": "double",
+      "description": "The feed quantity in the units specified."
     }
   }
 }
diff --git a/types/icarMedicineReferenceType.json b/types/icarMedicineReferenceType.json
@@ -13,7 +13,8 @@
                     "description": "An indicator whether the medicine or remedy is an approved medicine"
                 },
                 "registeredIdentifier": {
-                    "$ref": "../types/icarMedicineIdentifierType.json"
+                    "$ref": "../types/icarMedicineIdentifierType.json",
+                    "description": "The registered identifier of the medicine expressed as a scheme and id."
                 }
             }
         }

diff --git a/types/icarPositionType.json b/types/icarPositionType.json
@@ -6,7 +6,7 @@
   "properties": {
 
     "position": {      
-      "description": "The position to be treated or diagnosed.",
+      "description": "Position on the animal where the diagnosis or treatment occurred.",
       "$ref": "../enums/icarPositionOnAnimalType.json"
     }
   }

diff --git a/types/icarStatisticsType.json b/types/icarStatisticsType.json
@@ -6,14 +6,15 @@
   "properties": {
     "metric": {
       "$ref": "../types/icarMetricType.json",
-      "description": "The metric code for a specific statitics. See https://github.com/adewg/ICAR/wiki/Schemes for more info"
+      "description": "The metric code for a specific statistics. See https://github.com/adewg/ICAR/wiki/Schemes for more info"
     },
     "unit": {
       "type": "string",
       "description": "The unit of the metric. This must be appropriate to the metric and UN-CEFACT unit codes should be used where possible."
     },
     "aggregation": {
-      "$ref": "../enums/icarAggregationType.json"
+      "$ref": "../enums/icarAggregationType.json",
+      "description": "The aggregation applied to the metric."
     },
     "value": { 
       "type": "number",