Merge pull request #438 from adewg/239-openapi-3.1

Update to OpenAPI version 3.1 Resolves #239 Resolves #451
adewg · May 2, 2024 · df6e1b3 · df6e1b3
2 parents 584f50e + 60fd2f9
commit df6e1b3
Show file tree

Hide file tree

Showing 24 changed files with 285 additions and 321 deletions.
diff --git a/.github/workflows/ValidateWithSpeccy.yml b/.github/workflows/ValidateWithSpeccy.yml
diff --git a/resources/icarAttentionEventResource.json b/resources/icarAttentionEventResource.json
@@ -12,8 +12,8 @@
 
         "properties": {
             "alertEndDateTime": {
+                "type": ["string", "null"],
                 "$ref": "../types/icarDateTimeType.json",
-                "nullable": true,
                 "description": "RFC3339 date time that represents the end time of an alert (start time is the eventDateTime) if it has ended."
             },
             "category": {

diff --git a/resources/icarBatchResult.json b/resources/icarBatchResult.json
@@ -11,9 +11,8 @@
             "description": "Metadata for the posted resource. Allows specification of the source, source Id to synchronise data."
         },        
         "messages": {
-            "type": "array",
-            "description": "An arry of errors for this resource.",
-            "nullable": true,
+            "type": ["array", "null"],
+            "description": "An array of errors for this resource. The messages array may be unspecified OR null.",
             "items": {
                 "$ref": "../resources/icarResponseMessageResource.json" 
             }

diff --git a/resources/icarHealthStatusObservedEventResource.json b/resources/icarHealthStatusObservedEventResource.json
@@ -10,8 +10,7 @@
       "properties": {
         "observedStatus": {
           "$ref": "../enums/icarAnimalHealthStatusType.json",
-          "description": "Health status of the animal (such as Healthy, Suspicious, Ill, InTreatment, ToBeCulled).",
-          "nullable": false
+          "description": "Health status of the animal (such as Healthy, Suspicious, Ill, InTreatment, ToBeCulled). A null value is not supported."
         }
       }
     }

diff --git a/resources/icarProgenyDetailsResource.json b/resources/icarProgenyDetailsResource.json
@@ -16,16 +16,15 @@
       "properties": {
         "identifier": {
           "description": "Unique animal scheme and identifier combination.",
-          "nullable": true,
+          "type": ["object", "null"],
           "allOf": [
             {
               "$ref": "../types/icarAnimalIdentifierType.json"
             }
           ]
         },
         "alternativeIdentifiers": {
-          "nullable": true,
-          "type": "array",
+          "type": ["array","null"],
           "items": {
             "$ref": "../types/icarAnimalIdentifierType.json"
           },
@@ -40,8 +39,7 @@
           "description": "Gender of the animal."
         },
         "managementTag": {
-          "type": "string",
-          "nullable": true,
+          "type": ["string", "null"],
           "description": "The identifier used by the farmer in day to day operations. In many cases this could be the animal number."
         },
         "name": {
@@ -54,7 +52,7 @@
         },
         "taggingDate": {
           "description": "Progeny tagging date in RFC3339 UTC (see https://ijmacd.github.io/rfc3339-iso8601/ for format guidance).",
-          "nullable": true,
+          "type": ["string", "null"],
           "allOf": [
             {
               "$ref": "../types/icarDateTimeType.json"
@@ -63,7 +61,7 @@
         },
         "birthStatus": {
           "description": "Birth status of the progeny.",
-          "nullable": true,
+          "type": ["string", "null"],
           "allOf": [
             {
               "$ref": "../enums/icarParturitionBirthStatusType.json"
@@ -72,7 +70,7 @@
         },
         "birthSize": {
           "description": "Size of the progeny.",
-          "nullable": true,
+          "type": ["string", "null"],
           "allOf": [
             {
               "$ref": "../enums/icarParturitionBirthSizeType.json"
@@ -81,7 +79,7 @@
         },
         "birthWeight": {
           "description": "Weight of the progeny.",
-          "nullable": true,
+          "type": ["object", "null"],
           "allOf": [
             {
               "$ref": "../types/icarMassMeasureType.json"

diff --git a/resources/icarReproDoNotBreedEventResource.json b/resources/icarReproDoNotBreedEventResource.json
@@ -8,9 +8,8 @@
       "type": "object",
       "properties": {
         "doNotBreed": {
-          "type": "boolean",
+          "type": ["boolean", "null"],
           "description": "Set this attribute to true if the animal should not be bred, false if it may now be bred.",
-          "nullable": true,
           "default": true
         }
       }

diff --git a/resources/icarReproParturitionEventResource.json b/resources/icarReproParturitionEventResource.json
@@ -29,16 +29,14 @@
           "description": "Calving ease (enum corresponds to traditional 1-5 values)."
         },
         "progenyDetails": {
-          "type": "array",
-          "nullable": true,
+          "type": ["array","null"],
           "items": {
             "$ref": "../resources/icarProgenyDetailsResource.json"
           },
           "description": "List of progeny details. May not be fully identified, but recommend that gender and status are supplied at least."
         },
         "progeny": {
-          "type": "array",
-          "nullable": true,
+          "type": ["array", "null"],
           "deprecated": true,
           "items": {
             "$ref": "../resources/icarAnimalCoreResource.json"

diff --git a/resources/icarResponseMessageResource.json b/resources/icarResponseMessageResource.json
@@ -13,10 +13,9 @@
       "description": "Distinguish errors, warnings, and informational messages."
     },
     "status": {
-      "type": "integer",
+      "type": ["integer", "null"],
       "description": "The HTTP status code applicable to this problem.",
-      "format": "int32",
-      "nullable": true
+      "format": "int32"
     },
     "title": {
       "type": "string",
@@ -27,9 +26,8 @@
       "description": "A human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized."
     },
     "instance": {
-      "type": "string",
-      "description": "A URI reference or internal JSON document reference to the specific data item that caused the problem.",
-      "nullable": true
+      "type": ["string", "null"],
+      "description": "A URI reference or internal JSON document reference to the specific data item that caused the problem."
     }
   }
 }
diff --git a/types/icarGroupSpecifierType.json b/types/icarGroupSpecifierType.json
@@ -5,23 +5,19 @@
 
   "properties": {
     "lactationNumberRangeMin": { 
-      "type": "number",
-      "nullable": true,
+      "type": ["number", "null"],
       "description": "minimum number of lactations for the animals in the group."
     },
     "lactationNumberRangeMax": { 
-      "type": "number",
-      "nullable": true,
+      "type": ["number", "null"],
       "description": "maximum number of lactations for the animals in the group."
     },
     "daysInMilkRangeMin": { 
-      "type": "number",
-      "nullable": true,
+      "type": ["number", "null"],
       "description": "minimum number of days in milk for the animals in the group."
     },
     "daysInMilkRangeMax": { 
-      "type": "number",
-      "nullable": true,
+      "type": ["number", "null"],
       "description": "maximum number of days in milk for the animals in the group."
     },
     "animalSetId": { 

diff --git a/types/icarIndividualWeightType.json b/types/icarIndividualWeightType.json
@@ -4,14 +4,13 @@
 
     "properties": {
         "animal": {
+            "type": ["object", "null"],
             "$ref": "../types/icarAnimalIdentifierType.json",
-            "description": "Unique animal scheme and identifier combination.",
-            "nullable": true
+            "description": "Unique animal scheme and identifier combination."
         },
         "weight": {
-            "type": "number",
-            "description": "The weight measurement",
-            "nullable": true
+            "type": ["number", "null"],
+            "description": "The weight measurement"
         }
     }
 }
diff --git a/types/icarInventoryClassificationType.json b/types/icarInventoryClassificationType.json
@@ -26,10 +26,9 @@
       "description": "Primary breed defined using an identifier and scheme."
     },
     "birthPeriod": {
-      "type": "string",
+      "type": ["string", "null"],
       "pattern": "^(([0-9]{4})|([0-9]{4}-[0-1][0-9])|([0-9]{4}-[0-1][0-9]-[0-3][0-9](Z?)(\/|--)[0-9]{4}-[0-1][0-9]-[0-3][0-9](Z?)))$",
-      "description": "The range of birth dates. Use YYYY (all one year), YYYY-MM (one month), or two RFC3339 date-times separated by / to represent a range.",
-      "nullable": true
+      "description": "The range of birth dates. Use YYYY (all one year), YYYY-MM (one month), or two RFC3339 date-times separated by / to represent a range."
     },      
     "reproductiveStatus": {
       "$ref": "../enums/icarAnimalReproductionStatusType.json",

diff --git a/types/icarMedicineCourseSummaryType.json b/types/icarMedicineCourseSummaryType.json
@@ -33,14 +33,12 @@
           "description": "Total dose proposed or administered."
         },
         "numberOfTreatments": {
-          "type": "number",
-          "description": "The number of treatments included in the course.",
-          "nullable": true
+          "type": ["number", "null"],
+          "description": "The number of treatments included in the course."
         },
         "treatmentInterval": {
-          "type": "integer",
-          "description": "The interval between treatments specified in HOURS.",
-          "nullable": true
+          "type": ["integer", "null"],
+          "description": "The interval between treatments specified in HOURS."
         },
         "batches": {
             "type": "array",

diff --git a/types/icarMetaDataType.json b/types/icarMetaDataType.json
@@ -26,7 +26,7 @@
     },
     "created": {
       "description": "RFC3339 UTC date/time of creation (see https://ijmacd.github.io/rfc3339-iso8601/ for format guidance).",
-      "nullable": true,
+      "type": ["string", "null"],
       "allOf": [
         {
           "$ref": "../types/icarDateTimeType.json"
@@ -39,7 +39,7 @@
     },
     "validFrom": {
       "description": "RFC3339 UTC start of period when the resource is valid (see https://ijmacd.github.io/rfc3339-iso8601/ for format guidance).",
-      "nullable": true,
+      "type": ["string", "null"],
       "allOf": [
         {
           "$ref": "../types/icarDateTimeType.json"
@@ -48,7 +48,7 @@
     },
     "validTo": {
       "description": "RFC3339 UTC end of the period when the resoure is valid (see https://ijmacd.github.io/rfc3339-iso8601/ for format guidance).",
-      "nullable": true,
+      "type": ["string", "null"],
       "allOf": [
         {
           "$ref": "../types/icarDateTimeType.json"

diff --git a/types/icarQuarterMilkingType.json b/types/icarQuarterMilkingType.json
@@ -15,18 +15,15 @@
       ]
     },
     "xposition": { 
-      "type": "number",
-      "nullable": true,
+      "type": ["number", "null"],
       "description": "Optional milking robot X position. Vendors may choose not to provide this."
     },
     "yposition": { 
-      "type": "number",
-      "nullable": true,
+      "type": ["number", "null"],
       "description": "Optional milking robot Y position. Vendors may choose not to provide this."
     },
     "zposition": { 
-      "type": "number",
-      "nullable": true,
+      "type": ["number", "null"],
       "description": "Optional milking robot Z position. Vendors may choose not to provide this."
     },
     "quarterMilkingDuration": {

diff --git a/types/icarResourceReferenceType.json b/types/icarResourceReferenceType.json
@@ -15,8 +15,7 @@
     },
     "@type": {
       "type": "string",
-      "description": "Deprecated - use reltype. Specifies whether this is a single resource Link or a Collection.",
-      "enum": ["Link"]
+      "description": "Deprecated - use reltype. Specifies whether this is a single resource Link or a Collection."
     },
     "identifier": {
       "$ref": "../types/icarIdentifierType.json",

diff --git a/types/icarStatisticsGroupType.json b/types/icarStatisticsGroupType.json
@@ -8,8 +8,7 @@
       "$ref": "../enums/icarGroupType.json"
     },
     "denominator": { 
-      "type": "number",
-      "nullable": true,
+      "type": ["number", "null"],
       "description": "Number of animals in the group."
     },
     "icarGroupSpecifier": {