From 153ac723e3f095fe0aa7d672b09209b948d3a03e Mon Sep 17 00:00:00 2001 From: Andrew Cooke <45248509+cookeac@users.noreply.github.com> Date: Fri, 1 Dec 2023 17:26:41 +1300 Subject: [PATCH 1/4] Update OpenAPI API schemes to 3.1.0 and ADE 1.4 --- url-schemes/exampleUrlScheme.json | 148 ++++++++++++------------- url-schemes/feedURLscheme.json | 50 ++++----- url-schemes/healthURLScheme.json | 48 ++++---- url-schemes/managementURLScheme.json | 44 ++++---- url-schemes/milkURLScheme.json | 38 +++---- url-schemes/performanceURLScheme.json | 30 ++--- url-schemes/registrationURLScheme.json | 62 +++++------ url-schemes/reproductionURLScheme.json | 70 ++++++------ 8 files changed, 245 insertions(+), 245 deletions(-) diff --git a/url-schemes/exampleUrlScheme.json b/url-schemes/exampleUrlScheme.json index 8412e59..ea27000 100644 --- a/url-schemes/exampleUrlScheme.json +++ b/url-schemes/exampleUrlScheme.json @@ -1,9 +1,9 @@ { - "openapi": "3.0.1", + "openapi": "3.1.0", "info": { "title": "Release Candidate Messages", "description": "The specifications of messages which are ready for ICAR approval and release", - "version": "1.3", + "version": "1.4", "contact": { "name": "Animal Data Exchange Working Group", "url": "https://www.icar.org/index.php/technical-bodies/working-groups/animal-data-exchange-wg/", @@ -14,43 +14,43 @@ "url": "https://icar-ade.standard.com" }], "tags": [{ - "name": "ADE-1.3 additions", + "name": "ADE-1.4 additions", "description": "new endpoints not yet approved" }, { - "name": "ADE-1.3-feed", + "name": "ADE-1.4-feed", "description": "Feed messages approved by the working group" }, { - "name": "ADE-1.3-health", + "name": "ADE-1.4-health", "description": "Health messages approved by the working group" }, { - "name": "ADE-1.3-management", + "name": "ADE-1.4-management", "description": "Management messages approved by the working group" }, { - "name": "ADE-1.3-milk", + "name": "ADE-1.4-milk", "description": "Milk messages approved by the working group" }, { - "name": "ADE-1.3-performance", + "name": "ADE-1.4-performance", "description": "Performance messages approved by the working group" }, { - "name": "ADE-1.3-registration", + "name": "ADE-1.4-registration", "description": "Registration messages approved by the working group" }, { - "name": "ADE-1.3-reproduction", + "name": "ADE-1.4-reproduction", "description": "Reproduction messages approved by the working group" }, { - "name": "ADE-1.3-carcass", + "name": "ADE-1.4-carcass", "description": "Carcass messages approved by the working group" }, { - "name": "ADE-1.3-scheme", + "name": "ADE-1.4-scheme", "description": "Scheme definitions approved by the working group" } ], @@ -61,7 +61,7 @@ "summary": "Get available schema/id combinations for locations.", "description": "# Purpose\nProvide a list of available locations.\nShould return only those combinations the user currently logged in has access to.", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "responses": { "200": { @@ -91,7 +91,7 @@ "summary": "Get the milking-withdrawals for a certain location", "description": "# Purpose\nProvides the milking-withdrawals for a certain location\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -130,7 +130,7 @@ "summary": "Get the data for milking visits", "description": "# Purpose\nProvides data from visits of animals to a milking parlour.\n \nThis comprises all possible data. Anybody can choose to define API's that return less information in the response.\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -173,7 +173,7 @@ "summary": "Get the test days", "description": "# Purpose\nProvides data from the test days on a farm that intersects with the given start/end date if provided. Otherwise returns all available entries.", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -216,7 +216,7 @@ "summary": "Get the data for test day results", "description": "# Purpose\nProvides data from the test day for animals on a farm\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -259,7 +259,7 @@ "summary": "Get the milk predictions for a certain location", "description": "# Purpose\nProvides the milk predictions for a location\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -298,7 +298,7 @@ "summary": "Get daily averages for milking-visits of a animals", "description": "# Purpose\nProvides daily averages of the milking-visits of per animal.", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -336,7 +336,7 @@ "summary": "Get the data for lactations", "description": "# Purpose\nProvides data from lactations of animals.", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -368,7 +368,7 @@ "summary": "Get the list of observed changes to lactation status for animals.", "description": "# Purpose\nProvides a list of events arising from observed changes to lactation status.", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -406,7 +406,7 @@ "summary": "Get the births for a certain location", "description": "# Purpose\nProvides the born animals on a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -444,7 +444,7 @@ "summary": "Get the deaths for a certain location", "description": "# Purpose\nProvides the died animals on a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -482,7 +482,7 @@ "summary": "Get the arrivals for a certain location", "description": "# Purpose\nProvides the arrived animals on a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -525,7 +525,7 @@ "summary": "Get the departures for a certain location", "description": "# Purpose\nProvides the departed animals from a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -563,7 +563,7 @@ "summary": "Get the animals for a certain location", "description": "# Purpose\nProvides the animals on a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -595,7 +595,7 @@ "summary": "Get the animal sets for a certain location", "description": "# Purpose\nProvides the animal sets on a location. If animal-scheme and animal-id are provided, the sets containing that animal are returned.\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -635,7 +635,7 @@ "summary": "Get the animal set join events for a certain location", "description": "# Purpose\nProvides the animal set join events on a location\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -679,7 +679,7 @@ "summary": "Get the animal set leave events for a certain location", "description": "# Purpose\nProvides the animal set leave events on a location\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -723,7 +723,7 @@ "summary": "Get the service sires matching your query parameters - for now we only implement the query by some identifier, like lifetime number, ai-code, ... ", "description": "# Purpose\nProvides the service sires.\nOnly animal fields relevant to service sires will be populated (location is not expected, for example).", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [{ "$ref": "#/components/parameters/identifier-scheme" @@ -755,7 +755,7 @@ "summary": "Get the statistics for a certain location", "description": "# Purpose\nProvides the statistics for a location\n One can specify the period for which the statistics can be calculated by specifying a date to and date from parameter. Also the purpose can be provided to limit the purpose of the statistics", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -797,7 +797,7 @@ "summary": "Get the pregnancy checks for a certain location", "description": "# Purpose\nProvides the pregnancy checks on a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -840,7 +840,7 @@ "summary": "Get the heats for a certain location", "description": "# Purpose\nProvides the Heats on a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -878,7 +878,7 @@ "summary": "Get the inseminations for a certain location", "description": "# Purpose\nProvides the Inseminations on a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -921,7 +921,7 @@ "summary": "Get the drying off for a certain location", "description": "# Purpose\nProvides the drying off on a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -967,7 +967,7 @@ "summary": "Get the abortion events for a certain location", "description": "# Purpose\nProvides the abortion events on a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1005,7 +1005,7 @@ "summary": "Get the animals that were assigned as do-not-breed for a certain location", "description": "# Purpose\nProvides the not be bred animals on a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1043,7 +1043,7 @@ "summary": "Get the parturition events for a certain location", "description": "# Purpose\nProvides the Parturition events on a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1081,7 +1081,7 @@ "summary": "Get the embryo flushing events for a certain location", "description": "# Purpose\nProvides the embryo flushing events on a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1119,7 +1119,7 @@ "summary": "Get the weight data of animals", "description": "# Purpose\nProvides weight data from animals on a farm.", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1157,7 +1157,7 @@ "summary": "Get the device data for a location", "description": "# Purpose\nProvides device data for devices present on a farm.", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1195,7 +1195,7 @@ "summary": "Get the feed storage device data for a location", "description": "# Purpose\nProvides feed storage device data for storages present on a farm.", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1238,7 +1238,7 @@ "summary": "Get the breeding values of the animals of a location", "description": "# Purpose\nProvides breeding values of the animals present on a farm.", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1276,7 +1276,7 @@ "summary": "Get the mating recommendations for a certain location", "description": "# Purpose\nProvides the mating recommendations on a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1314,7 +1314,7 @@ "summary": "Get the conformation scores for a certain location", "description": "# Purpose\nProvides the conformation scores on a location\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1352,7 +1352,7 @@ "summary": "Get the type classification events for a certain location", "description": "# Purpose\nProvides the animal type classification events for a location\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { @@ -1391,7 +1391,7 @@ "summary": "Get the diagnoses for a certain location", "description": "# Purpose\nProvides the animal health diagnoses for a location\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1429,7 +1429,7 @@ "summary": "Get the treatments for a certain location", "description": "# Purpose\nProvides the animal health treatments for a location\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1467,7 +1467,7 @@ "summary": "Get the treatment programs for a certain location", "description": "# Purpose\nProvides the animal health treatment programs for a location\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1505,7 +1505,7 @@ "summary": "Get the health-status-observed of an animal for a certain location", "description": "# Purpose\nProvides the animal health-status for a location\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -1544,7 +1544,7 @@ "summary": "Get the gestations for a certain location", "description": "# Purpose\nProvides the gestations for a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1582,7 +1582,7 @@ "summary": "Get the feeds available on a certain location", "description": "# Purpose\nProvides the feeds for a location. We recommend using the fao.org scheme for the type of feeds and the icar.org scheme for the feed properties\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1620,7 +1620,7 @@ "summary": "Get the rations for a certain location", "description": "# Purpose\nProvides the rations for a location\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1658,7 +1658,7 @@ "summary": "Get the feed intakes for a certain location", "description": "# Purpose\nProvides the feed intakes for a location\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1696,7 +1696,7 @@ "summary": "Get the group feeding events for a certain location", "description": "# Purpose\nProvides the group feeding events for a location.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1735,7 +1735,7 @@ "summary": "Get the feed recommendations for a certain location", "description": "# Purpose\nProvides the feed recommendations for a location\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1773,7 +1773,7 @@ "summary": "Get the feed reports for animals on a certain location for a certain period. One can use the report-start- and report-end-date-time paramters to get a daily feed report. ", "description": "# Purpose\nProvides the feed reports for animal on a location\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1817,7 +1817,7 @@ "summary": "Get the list of observed changes to animal reproductive status", "description": "# Purpose\nProvides a collection of events where a change to animal reproductive status has been observed.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1855,7 +1855,7 @@ "summary": "Get the list of schemata/schema types supported", "description": "# Purpose\nProvides a list of schemata/schema types supported.\n", "tags": [ - "ADE-1.3-scheme" + "ADE-1.4-scheme" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1892,7 +1892,7 @@ "summary": "Get the list of schema type schemes", "description": "# Purpose\nProvides a list of schemata/schema types supported.\n", "tags": [ - "ADE-1.3-scheme" + "ADE-1.4-scheme" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1935,7 +1935,7 @@ "summary": "Get the list of values for specidif sheme", "description": "# Purpose\nProvides a list of scheme values for specific scheme\n", "tags": [ - "ADE-1.3-scheme" + "ADE-1.4-scheme" ], "parameters": [{ "$ref": "#/components/parameters/location-scheme" @@ -1978,7 +1978,7 @@ "summary": "Get the group treatments for a certain location", "description": "# Purpose\nProvides the group health treatments for a location\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -2017,7 +2017,7 @@ "summary": "Get the weights for a certain location", "description": "# Purpose\nProvides the group weights for a location\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { @@ -2056,7 +2056,7 @@ "summary": "Get the group arrival events for a certain location", "description": "# Purpose\nProvides the group arrival records for a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -2095,7 +2095,7 @@ "summary": "Get the group birth or registration events for a certain location", "description": "# Purpose\nProvides the group birth records for a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -2134,7 +2134,7 @@ "summary": "Get the group death events for a certain location", "description": "# Purpose\nProvides the group death records for a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -2173,7 +2173,7 @@ "summary": "Get the group departure events for a certain location", "description": "# Purpose\nProvides the group departure records for a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -2212,7 +2212,7 @@ "summary": "Get the processing lots that relate to a certain location", "description": "# Purpose\nProvides the carcass processing lots relating to a location\n", "tags": [ - "ADE-1.3-carcass" + "ADE-1.4-carcass" ], "parameters": [ { @@ -2251,7 +2251,7 @@ "summary": "Get the carcasses that relate to a certain location", "description": "# Purpose\nProvides the carcasses relating to a location\n", "tags": [ - "ADE-1.3-carcass" + "ADE-1.4-carcass" ], "parameters": [ { @@ -2290,7 +2290,7 @@ "summary": "Get the carcass observation events that relate to a certain location", "description": "# Purpose\nProvides the carcass observation events relating to a location\n", "tags": [ - "ADE-1.3-carcass" + "ADE-1.4-carcass" ], "parameters": [ { @@ -2329,7 +2329,7 @@ "summary": "Get the inventory transactions that relate to a certain location", "description": "# Purpose\nProvides the inventory transactions relating to a location\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -2383,7 +2383,7 @@ "summary": "Get the feed inventory transactions that relate to a certain location", "description": "# Purpose\nProvides the feed inventory transactions relating to a location\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -2434,7 +2434,7 @@ "summary": "Get the medicine inventory transactions that relate to a certain location", "description": "# Purpose\nProvides the medicine inventory transactions relating to a location\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -2485,7 +2485,7 @@ "summary": "Get attention events.", "description": "# Purpose\nProvides the attention events for a location. These are individual animal events, typically generated by devices such as wearables and sensors.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { diff --git a/url-schemes/feedURLscheme.json b/url-schemes/feedURLscheme.json index 3f02ba8..2d7d7d4 100644 --- a/url-schemes/feedURLscheme.json +++ b/url-schemes/feedURLscheme.json @@ -1,9 +1,9 @@ { - "openapi": "3.0.1", + "openapi": "3.1.0", "info": { "title": "Feed-related events and messages API Specifications", "description": "Specifications for messages that support livestock feeding and feed management.", - "version": "1.3", + "version": "1.4", "contact": { "name": "Animal Data Exchange Working Group", "url": "https://www.icar.org/index.php/technical-bodies/working-groups/animal-data-exchange-wg/", @@ -17,7 +17,7 @@ ], "tags": [ { - "name": "ADE-1.3-feed", + "name": "ADE-1.4-feed", "description": "Feeding messages approved by the working group" } ], @@ -28,7 +28,7 @@ "summary": "Get the feeds for a certain location", "description": "# Purpose\nProvides the animal feeds for a location\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -65,7 +65,7 @@ "summary": "Add a single new feed.", "description": "# Purpose\nAllows a client to add a single feed.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -133,7 +133,7 @@ "summary": "Get the rations for a certain location", "description": "# Purpose\nProvides the animal rations for a location\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -170,7 +170,7 @@ "summary": "Add a single new ration.", "description": "# Purpose\nAllows a client to add a single ration.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -238,7 +238,7 @@ "summary": "Get the feed intake events for a certain location", "description": "# Purpose\nProvides the animal feed intake events for a location\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -275,7 +275,7 @@ "summary": "Add a single new feed intake event.", "description": "# Purpose\nAllows a client to add a single feed intake event.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -343,7 +343,7 @@ "summary": "Get the feed recommendations for a certain location", "description": "# Purpose\nProvides the animal feed recommendations for a location\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -380,7 +380,7 @@ "summary": "Add a single new feed recommendation.", "description": "# Purpose\nAllows a client to add a single feed recommendation.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -448,7 +448,7 @@ "summary": "Get the feed reports for animals on a certain location for a certain period. One can use the report-start- and report-end-date-time paramters to get a daily feed report. If you need feed-reports for AnimalSets please refer to the WIKI pages : https://github.com/adewg/ICAR/wiki/Feed-Reporting", "description": "# Purpose\nProvides the feed reports for animal on a location\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -493,7 +493,7 @@ "summary": "Get the feed storage devices for a certain location", "description": "# Purpose\nProvides the animal feed storage devices for a location\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -535,7 +535,7 @@ "summary": "Add a single new feed storage.", "description": "# Purpose\nAllows a client to add a single feed-storage.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -603,7 +603,7 @@ "summary": "Get the feed inventory transactions that relate to a certain location", "description": "# Purpose\nProvides the feed inventory transactions relating to a location\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -652,7 +652,7 @@ "summary": "Add a single new feed inventory transaction.", "description": "# Purpose\nAllows a client to add a single feed inventory transaction.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -720,7 +720,7 @@ "summary": "Get the group feeding events for a certain location", "description": "# Purpose\nProvides the group feeding events for a location\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -757,7 +757,7 @@ "summary": "Add a single new group feeding event.", "description": "# Purpose\nAllows a client to add a single group feeding event.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -825,7 +825,7 @@ "summary": "Add an array of feeds.", "description": "# Purpose \nAllows a client to add a collection of feeds.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -900,7 +900,7 @@ "summary": "Add an array of rations.", "description": "# Purpose \nAllows a client to add a collection of rations.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -975,7 +975,7 @@ "summary": "Add an array of feed intake events.", "description": "# Purpose \nAllows a client to add a collection of feed intake events.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -1050,7 +1050,7 @@ "summary": "Add an array of feed recommendations.", "description": "# Purpose \nAllows a client to add a collection of feed recommendations.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -1125,7 +1125,7 @@ "summary": "Add an array of feed storages.", "description": "# Purpose \nAllows a client to add a collection of feed storages.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -1200,7 +1200,7 @@ "summary": "Add an array of feed inventory transactions.", "description": "# Purpose \nAllows a client to add a collection of feed inventory transactions.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { @@ -1275,7 +1275,7 @@ "summary": "Add an array of group feeding events.", "description": "# Purpose \nAllows a client to add a collection of group feeding events.\n", "tags": [ - "ADE-1.3-feed" + "ADE-1.4-feed" ], "parameters": [ { diff --git a/url-schemes/healthURLScheme.json b/url-schemes/healthURLScheme.json index 5162ba3..e9ac3fa 100644 --- a/url-schemes/healthURLScheme.json +++ b/url-schemes/healthURLScheme.json @@ -1,9 +1,9 @@ { - "openapi": "3.0.1", + "openapi": "3.1.0", "info": { "title": "Health Diagnosis and Treatment API Specifications", "description": "Specifications for messages that support livestock health and disease diagnosis and treatments.", - "version": "1.3", + "version": "1.4", "contact": { "name": "Animal Data Exchange Working Group", "url": "https://www.icar.org/index.php/technical-bodies/working-groups/animal-data-exchange-wg/", @@ -17,7 +17,7 @@ ], "tags": [ { - "name": "ADE-1.3-health", + "name": "ADE-1.4-health", "description": "Health messages approved by the working group" } ], @@ -28,7 +28,7 @@ "summary": "Get the diagnoses for a certain location", "description": "# Purpose\nProvides the animal health diagnoses for a location\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -65,7 +65,7 @@ "summary": "Add a single new diagnosis event", "description": "# Purpose \nAllows a client to add a single animal health diagnosis event.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -133,7 +133,7 @@ "summary": "Get the treatments for a certain location", "description": "# Purpose\nProvides the animal health treatments for a location\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -170,7 +170,7 @@ "summary": "Add a single new health treatment event", "description": "# Purpose \nAllows a client to add a single animal health treatment event.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -220,7 +220,7 @@ "summary": "Get the group treatments for a certain location", "description": "# Purpose\nProvides the group health treatments for a location\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -257,7 +257,7 @@ "summary": "Add one group health treatment event", "description": "# Purpose \nAllows a client to add one group health treatment event.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -307,7 +307,7 @@ "summary": "Get the treatment programs for a certain location", "description": "# Purpose\nProvides the animal health treatment programs for a location\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -344,7 +344,7 @@ "summary": "Add a single new health treatment programme.", "description": "# Purpose \nAllows a client to add a single animal health treatment programme.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -394,7 +394,7 @@ "summary": "Get the health-status-observed of an animal for a certain location", "description": "# Purpose\nProvides the animal health-status for a location\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -431,7 +431,7 @@ "summary": "Add a single new health status observed.", "description": "# Purpose \nAllows a client to add a single animal health status observed.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -481,7 +481,7 @@ "summary": "Get medicine inventory transactions.", "description": "# Purpose\nProvides the medicine inventory transactions for a location\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -530,7 +530,7 @@ "summary": "Add a single new medicine inventory transaction.", "description": "# Purpose \nAllows a client to add a single medicine inventory transaction.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -580,7 +580,7 @@ "summary": "Get attention events.", "description": "# Purpose\nProvides the attention events for a location. These are individual animal events, typically generated by devices such as wearables and sensors.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -629,7 +629,7 @@ "summary": "Add a single new attention event.", "description": "# Purpose \nAllows a client to add a single attention event (typically generated by a device, wearable, or sensor).\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -679,7 +679,7 @@ "summary": "Add a single new diagnosis event", "description": "# Purpose \nAllows a client to add a collection of animal health diagnosis events.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -754,7 +754,7 @@ "summary": "Add a collection of health treatment events", "description": "# Purpose \nAllows a client to add a collection of animal health treatment events.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -829,7 +829,7 @@ "summary": "Add a collection of group health treatment events", "description": "# Purpose \nAllows a client to add a collection of group health treatment events.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -904,7 +904,7 @@ "summary": "Add a collection of animal health treatment program events.", "description": "# Purpose \nAllows a client to add a collection of animal health treatment program events.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -979,7 +979,7 @@ "summary": "Add new health status observed events", "description": "# Purpose \nAllows a client to add a collection of animal health status observed events.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -1054,7 +1054,7 @@ "summary": "Add an array of medicine inventory transactions.", "description": "# Purpose \nAllows a client to add a collection of medicine inventory transactions.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { @@ -1129,7 +1129,7 @@ "summary": "Add an array of attention events.", "description": "# Purpose \nAllows a client to add a collection of attention events for animals. These are typically generated by devices such as wearables and sensors.\n", "tags": [ - "ADE-1.3-health" + "ADE-1.4-health" ], "parameters": [ { diff --git a/url-schemes/managementURLScheme.json b/url-schemes/managementURLScheme.json index ff9fd65..6d3cf94 100644 --- a/url-schemes/managementURLScheme.json +++ b/url-schemes/managementURLScheme.json @@ -1,9 +1,9 @@ { - "openapi": "3.0.1", + "openapi": "3.1.0", "info": { "title": "Management events and messages API Specifications", "description": "Specifications for messages that support livestock management activities.", - "version": "1.3", + "version": "1.4", "contact": { "name": "Animal Data Exchange Working Group", "url": "https://www.icar.org/index.php/technical-bodies/working-groups/animal-data-exchange-wg/", @@ -17,7 +17,7 @@ ], "tags": [ { - "name": "ADE-1.3-management", + "name": "ADE-1.4-management", "description": "Management messages approved by the working group" } ], @@ -28,7 +28,7 @@ "summary": "Get the animal sets for a certain location", "description": "# Purpose\nProvides the animal animal sets for a location\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -65,7 +65,7 @@ "summary": "Add a single new animal set.", "description": "# Purpose\nAllows a client to add a single animal set.\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -133,7 +133,7 @@ "summary": "Get the animal set joins events for a certain location", "description": "# Purpose\nProvides the animal animal set join events for a location\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -170,7 +170,7 @@ "summary": "Add a single new animal set join event.", "description": "# Purpose\nAllows a client to add a single animal-set-join.\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -238,7 +238,7 @@ "summary": "Get the animal set leave events for a certain location", "description": "# Purpose\nProvides the animal animal set leave events for a location\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -275,7 +275,7 @@ "summary": "Add a single new animal set leave event.", "description": "# Purpose\nAllows a client to add a single animal set leave event.\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -343,7 +343,7 @@ "summary": "Get the devices for a certain location", "description": "# Purpose\nProvides the animal devices for a location\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -380,7 +380,7 @@ "summary": "Add a single new device.", "description": "# Purpose\nAllows a client to add a single device.\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -448,7 +448,7 @@ "summary": "Get the statistics for a certain location", "description": "# Purpose\nProvides the statistics for a location\n One can specify the period for which the statistics can be calculated by specifying a date to and date from parameter. Also the purpose can be provided to limit the purpose of the statistics", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -490,7 +490,7 @@ "summary": "Get the inventory transactions that relate to a certain location", "description": "# Purpose\nProvides the inventory transactions relating to a location\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -544,7 +544,7 @@ "summary": "Get the feed inventory transactions that relate to a certain location", "description": "# Purpose\nProvides the feed inventory transactions relating to a location\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -595,7 +595,7 @@ "summary": "Get the medicine inventory transactions that relate to a certain location", "description": "# Purpose\nProvides the medicine inventory transactions relating to a location\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -646,7 +646,7 @@ "summary": "Add an array of animal-sets.", "description": "# Purpose \nAllows a client to add a collection of animal-sets.\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -721,7 +721,7 @@ "summary": "Add an array of animal-set join events.", "description": "# Purpose \nAllows a client to add a collection of animal-set join events.\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -796,7 +796,7 @@ "summary": "Add an array of animal set leave events.", "description": "# Purpose \nAllows a client to add a collection of animal set leave events.\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -871,7 +871,7 @@ "summary": "Add an array of devices.", "description": "# Purpose \nAllows a client to add a collection of devices.\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -946,7 +946,7 @@ "summary": "Add an array of inventory transactions.", "description": "# Purpose \nAllows a client to add a collection of inventory transactions.\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -1021,7 +1021,7 @@ "summary": "Add an array of feed inventory transactions.", "description": "# Purpose \nAllows a client to add a collection of feed inventory transactions.\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { @@ -1096,7 +1096,7 @@ "summary": "Add an array of medicine inventory transactions.", "description": "# Purpose \nAllows a client to add a collection of medicine inventory transactions.\n", "tags": [ - "ADE-1.3-management" + "ADE-1.4-management" ], "parameters": [ { diff --git a/url-schemes/milkURLScheme.json b/url-schemes/milkURLScheme.json index 638ee55..4513310 100644 --- a/url-schemes/milkURLScheme.json +++ b/url-schemes/milkURLScheme.json @@ -1,9 +1,9 @@ { - "openapi": "3.0.1", + "openapi": "3.1.0", "info": { "title": "Milk recording and lactation information API Specifications", "description": "Specifications for messages that support dairy milking visits, lactation, and related information.", - "version": "1.3", + "version": "1.4", "contact": { "name": "Animal Data Exchange Working Group", "url": "https://www.icar.org/index.php/technical-bodies/working-groups/animal-data-exchange-wg/", @@ -17,7 +17,7 @@ ], "tags": [ { - "name": "ADE-1.3-milk", + "name": "ADE-1.4-milk", "description": "Milking-related messages approved by the working group" } ], @@ -28,7 +28,7 @@ "summary": "Get the milking-visits for a certain location", "description": "# Purpose\nProvides the animal milking-visits for a location\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -65,7 +65,7 @@ "summary": "Add a single new milking-visits.", "description": "# Purpose\nAllows a client to add a single milking-visits.\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -133,7 +133,7 @@ "summary": "Get the test-day for a certain location", "description": "# Purpose\nProvides the animal test-day for a location\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -170,7 +170,7 @@ "summary": "Add a single new test-day.", "description": "# Purpose\nAllows a client to add a single test-day.\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -238,7 +238,7 @@ "summary": "Get the test-day-result for a certain location", "description": "# Purpose\nProvides the animal test-day-result for a location\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -275,7 +275,7 @@ "summary": "Add a single new test-day-result.", "description": "# Purpose\nAllows a client to add a single test-day-result.\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -343,7 +343,7 @@ "summary": "Get the daily milking averages for a certain location", "description": "# Purpose\nProvides the animal daily milking averages for a location\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -382,7 +382,7 @@ "summary": "Get the milk predictions for a certain location", "description": "# Purpose\nProvides the milk predictions for a location\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -421,7 +421,7 @@ "summary": "Get the lactations for a certain location", "description": "# Purpose\nProvides the animal lactation for a location\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -454,7 +454,7 @@ "summary": "Get the lactation status observations for a certain location", "description": "# Purpose\nProvides the animal lactation status observations for a location\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -491,7 +491,7 @@ "summary": "Add a single new lactation status observation event.", "description": "# Purpose\nAllows a client to add a single lactation status observation event.\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -559,7 +559,7 @@ "summary": "Get the milking-withdrawals for a certain location", "description": "# Purpose\nProvides the milking-withdrawals for a certain location\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -598,7 +598,7 @@ "summary": "Add a single new milking-visits event", "description": "# Purpose \nAllows a client to add a collection of milking visits.\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -673,7 +673,7 @@ "summary": "Add batch of test-days.", "description": "# Purpose \nAllows a client to add a collection of test-days.\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -748,7 +748,7 @@ "summary": "Add an array of test-day-results.", "description": "# Purpose \nAllows a client to add a collection of test-day-result.\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { @@ -823,7 +823,7 @@ "summary": "Add an array of lactation status observations.", "description": "# Purpose \nAllows a client to add a collection of lactation status observations.\n", "tags": [ - "ADE-1.3-milk" + "ADE-1.4-milk" ], "parameters": [ { diff --git a/url-schemes/performanceURLScheme.json b/url-schemes/performanceURLScheme.json index 4ce0ccc..5a3873c 100644 --- a/url-schemes/performanceURLScheme.json +++ b/url-schemes/performanceURLScheme.json @@ -1,9 +1,9 @@ { - "openapi": "3.0.1", + "openapi": "3.1.0", "info": { "title": "Performance observation events and messages API Specifications", "description": "Specifications for messages that support livestock performance assessment other than milk production.", - "version": "1.3", + "version": "1.4", "contact": { "name": "Animal Data Exchange Working Group", "url": "https://www.icar.org/index.php/technical-bodies/working-groups/animal-data-exchange-wg/", @@ -17,7 +17,7 @@ ], "tags": [ { - "name": "ADE-1.3-performance", + "name": "ADE-1.4-performance", "description": "Performance messages approved by the working group" } ], @@ -28,7 +28,7 @@ "summary": "Get the weights for a certain location", "description": "# Purpose\nProvides the animal weights for a location\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { @@ -65,7 +65,7 @@ "summary": "Add a single new weight.", "description": "# Purpose\nAllows a client to add a single weight.\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { @@ -133,7 +133,7 @@ "summary": "Get the weights for a certain location", "description": "# Purpose\nProvides the group weights for a location\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { @@ -170,7 +170,7 @@ "summary": "Add a single group weight.", "description": "# Purpose\nAllows a client to add a single group weight.\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { @@ -238,7 +238,7 @@ "summary": "Get the breeding values for a certain location", "description": "# Purpose\nProvides the animal breeding values for a location\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { @@ -277,7 +277,7 @@ "summary": "Get the conformation score events for a certain location", "description": "# Purpose\nProvides the animal conformation score events for a location\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { @@ -314,7 +314,7 @@ "summary": "Add a single new conformation score.", "description": "# Purpose\nAllows a client to add a single conformation score.\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { @@ -382,7 +382,7 @@ "summary": "Get the type classification events for a certain location", "description": "# Purpose\nProvides the animal type classification events for a location\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { @@ -419,7 +419,7 @@ "summary": "Add a single new type classificatione.", "description": "# Purpose\nAllows a client to add a single type classification.\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { @@ -487,7 +487,7 @@ "summary": "Add an array of weights.", "description": "# Purpose \nAllows a client to add a collection of weights.\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { @@ -562,7 +562,7 @@ "summary": "Add an array of weights.", "description": "# Purpose \nAllows a client to add a collection of group weights.\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { @@ -637,7 +637,7 @@ "summary": "Add an array of conformation-scores.", "description": "# Purpose \nAllows a client to add a collection of conformation scores.\n", "tags": [ - "ADE-1.3-performance" + "ADE-1.4-performance" ], "parameters": [ { diff --git a/url-schemes/registrationURLScheme.json b/url-schemes/registrationURLScheme.json index 0caa7fc..ae3d573 100644 --- a/url-schemes/registrationURLScheme.json +++ b/url-schemes/registrationURLScheme.json @@ -1,9 +1,9 @@ { - "openapi": "3.0.1", + "openapi": "3.1.0", "info": { "title": "Animal Registration and Movement API Specifications", "description": "Specifications for messages that support livestock movement information and registration (sometimes called I&R).", - "version": "1.3", + "version": "1.4", "contact": { "name": "Animal Data Exchange Working Group", "url": "https://www.icar.org/index.php/technical-bodies/working-groups/animal-data-exchange-wg/", @@ -17,7 +17,7 @@ ], "tags": [ { - "name": "ADE-1.3-registration", + "name": "ADE-1.4-registration", "description": "Registration and movement messages approved by the working group" } ], @@ -28,7 +28,7 @@ "summary": "Get available schema/id combinations for locations.", "description": "# Purpose\nProvide a list of available locations.\nShould return only those combinations the user currently logged in has access to.", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "responses": { "200": { @@ -58,7 +58,7 @@ "summary": "Get the animals for a certain location", "description": "# Purpose\nProvides the animals on a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -89,7 +89,7 @@ "summary": "Add a single animal resource.", "description": "# Purpose \nAllows a client to add a single animal resource. Many servers do not support adding animals, requiring a registration event instead.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -157,7 +157,7 @@ "summary": "Get the births for a certain location", "description": "# Purpose\nProvides the animal birth records for a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -194,7 +194,7 @@ "summary": "Add a single new birth or initial registration event", "description": "# Purpose \nAllows a client to add a single animal birth or initial registration event.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -262,7 +262,7 @@ "summary": "Get the group birth or registration events for a certain location", "description": "# Purpose\nProvides the group birth records for a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -299,7 +299,7 @@ "summary": "Add one group birth or registration event", "description": "# Purpose \nAllows a client to add one group birth or registration event.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -367,7 +367,7 @@ "summary": "Get the group death events for a certain location", "description": "# Purpose\nProvides the group death records for a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -404,7 +404,7 @@ "summary": "Add one group death event", "description": "# Purpose \nAllows a client to add a group death event.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -472,7 +472,7 @@ "summary": "Get the deaths for a certain location", "description": "# Purpose\nProvides the animal death records for a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -509,7 +509,7 @@ "summary": "Add a single new death event", "description": "# Purpose \nAllows a client to add a single animal death event.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -577,7 +577,7 @@ "summary": "Get the arrivals for a certain location", "description": "# Purpose\nProvides the animal arrival records for a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -614,7 +614,7 @@ "summary": "Add a single new arrival event", "description": "# Purpose \nAllows a client to add a single animal arrival event.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -682,7 +682,7 @@ "summary": "Get the group arrival events for a certain location", "description": "# Purpose\nProvides the group arrival records for a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -719,7 +719,7 @@ "summary": "Add a group arrival event", "description": "# Purpose \nAllows a client to add a group arrival event.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -787,7 +787,7 @@ "summary": "Get the departures for a certain location", "description": "# Purpose\nProvides the animal departure records for a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -824,7 +824,7 @@ "summary": "Add a single new departure event", "description": "# Purpose \nAllows a client to add a single animal departure event.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -892,7 +892,7 @@ "summary": "Get the group departure events for a certain location", "description": "# Purpose\nProvides the group departure records for a location\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -929,7 +929,7 @@ "summary": "Add a group departure event", "description": "# Purpose \nAllows a client to add a group departure event.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -997,7 +997,7 @@ "summary": "Add an array of animal resources", "description": "# Purpose \nAllows a client to add a collection of animal resources. Many servers do not support adding animals, requiring registration events instead.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -1072,7 +1072,7 @@ "summary": "Add an array of birth or initial registration events", "description": "# Purpose \nAllows a client to add a collection of animal birth events.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -1147,7 +1147,7 @@ "summary": "Add an array of group birth or initial registration events", "description": "# Purpose \nAllows a client to add an array of group birth events.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -1222,7 +1222,7 @@ "summary": "Add an array of death events", "description": "# Purpose \nAllows a client to add a collection of animal death events.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -1297,7 +1297,7 @@ "summary": "Add an array of group death events", "description": "# Purpose \nAllows a client to add an array of group death events.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -1372,7 +1372,7 @@ "summary": "Add an array of arrival events", "description": "# Purpose \nAllows a client to add a collection of animal arrival events.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -1447,7 +1447,7 @@ "summary": "Add an array of group arrival events", "description": "# Purpose \nAllows a client to add an array of group arrival events.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -1522,7 +1522,7 @@ "summary": "Add an array of departure events", "description": "# Purpose \nAllows a client to add a collection of animal departure events.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { @@ -1597,7 +1597,7 @@ "summary": "Add an array of group departure events", "description": "# Purpose \nAllows a client to add an array of group departure events.\n", "tags": [ - "ADE-1.3-registration" + "ADE-1.4-registration" ], "parameters": [ { diff --git a/url-schemes/reproductionURLScheme.json b/url-schemes/reproductionURLScheme.json index a03d8bc..01517e7 100644 --- a/url-schemes/reproductionURLScheme.json +++ b/url-schemes/reproductionURLScheme.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.1", + "openapi": "3.1.0", "info": { "title": "Reproduction API Specifications", "description": "Specifications for messages that support livestock reproduction recording.", @@ -17,7 +17,7 @@ ], "tags": [ { - "name": "ADE-1.3-reproduction", + "name": "ADE-1.4-reproduction", "description": "Reproduction messages approved by the working group" } ], @@ -28,7 +28,7 @@ "summary": "Get the pregnancy-checks for a certain location", "description": "# Purpose\nProvides the animal pregnancy-checks for a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -65,7 +65,7 @@ "summary": "Add a single new pregnancy-check.", "description": "# Purpose\nAllows a client to add a single pregnancy-check.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -133,7 +133,7 @@ "summary": "Get the heats for a certain location", "description": "# Purpose\nProvides the animal heats for a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -170,7 +170,7 @@ "summary": "Add a single new heat.", "description": "# Purpose\nAllows a client to add a single heat.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -238,7 +238,7 @@ "summary": "Get the inseminations for a certain location", "description": "# Purpose\nProvides the animal inseminations for a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -275,7 +275,7 @@ "summary": "Add a single new insemination.", "description": "# Purpose\nAllows a client to add a single insemination.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -343,7 +343,7 @@ "summary": "Get the drying-off events for a certain location", "description": "# Purpose\nProvides the animal drying off events for a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -380,7 +380,7 @@ "summary": "Add a single new drying off event.", "description": "# Purpose\nAllows a client to add a single drying-off.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -448,7 +448,7 @@ "summary": "Get the abortions for a certain location", "description": "# Purpose\nProvides the animal abortions for a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -485,7 +485,7 @@ "summary": "Add a single new abortion.", "description": "# Purpose\nAllows a client to add a single abortion.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -553,7 +553,7 @@ "summary": "Get the do-not-breed events for a certain location", "description": "# Purpose\nProvides the animal do-not-breed events for a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -590,7 +590,7 @@ "summary": "Add a single new do-not-breed.", "description": "# Purpose\nAllows a client to add a single do-not-breed.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -658,7 +658,7 @@ "summary": "Get the parturitions for a certain location", "description": "# Purpose\nProvides the animal parturition (birth) events for a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -695,7 +695,7 @@ "summary": "Add a single new parturition.", "description": "# Purpose\nAllows a client to add a single parturition.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -763,7 +763,7 @@ "summary": "Get the mating recommendations for a certain location", "description": "# Purpose\nProvides the animal mating recommendations for a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -800,7 +800,7 @@ "summary": "Add a single new mating recommendation.", "description": "# Purpose\nAllows a client to add a single mating recommendation.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -868,7 +868,7 @@ "summary": "Get the gestations for a certain location", "description": "# Purpose\nProvides the animal gestations for a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -905,7 +905,7 @@ "summary": "Add a single new gestation.", "description": "# Purpose\nAllows a client to add a single gestation.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -973,7 +973,7 @@ "summary": "Get the reproductive status observations for a certain location", "description": "# Purpose\nProvides the animal reproductive status observations for a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1010,7 +1010,7 @@ "summary": "Add a single new repro-status-observation.", "description": "# Purpose\nAllows a client to add a single reproductive status observation.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1078,7 +1078,7 @@ "summary": "Get the embryo flushings for a certain location", "description": "# Purpose\nProvides the animal embryo flushings for a location\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1115,7 +1115,7 @@ "summary": "Add a single new embyro flushing.", "description": "# Purpose\nAllows a client to add a single embryo flushing event.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1183,7 +1183,7 @@ "summary": "Add an array of pregnancy-checks.", "description": "# Purpose \nAllows a client to add a collection of pregnancy-checks.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1258,7 +1258,7 @@ "summary": "Add an array of heats.", "description": "# Purpose \nAllows a client to add a collection of heats.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1333,7 +1333,7 @@ "summary": "Add an array of inseminations.", "description": "# Purpose \nAllows a client to add a collection of inseminations.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1408,7 +1408,7 @@ "summary": "Add an array of drying-off events.", "description": "# Purpose \nAllows a client to add a collection of drying-off events.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1483,7 +1483,7 @@ "summary": "Add an array of abortions.", "description": "# Purpose \nAllows a client to add a collection of abortions.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1558,7 +1558,7 @@ "summary": "Add an array of do-not-breed events.", "description": "# Purpose \nAllows a client to add a collection of do-not-breed events.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1633,7 +1633,7 @@ "summary": "Add an array of parturitions.", "description": "# Purpose \nAllows a client to add a collection of parturitions.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1708,7 +1708,7 @@ "summary": "Add an array of mating recommendations.", "description": "# Purpose \nAllows a client to add a collection of mating recommendations.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1783,7 +1783,7 @@ "summary": "Add an array of gestations.", "description": "# Purpose \nAllows a client to add a collection of gestations.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1858,7 +1858,7 @@ "summary": "Add an array of reproductive status observations.", "description": "# Purpose \nAllows a client to add a collection of reproductive status observations.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { @@ -1933,7 +1933,7 @@ "summary": "Add an array of embryo-flushings.", "description": "# Purpose \nAllows a client to add a collection of embryo-flushings.\n", "tags": [ - "ADE-1.3-reproduction" + "ADE-1.4-reproduction" ], "parameters": [ { From a494b5273a822031550123d661ec0ecf3f140b98 Mon Sep 17 00:00:00 2001 From: Andrew Cooke <45248509+cookeac@users.noreply.github.com> Date: Fri, 1 Dec 2023 17:53:12 +1300 Subject: [PATCH 2/4] Replace nullable with array types with "null" --- resources/icarAttentionEventResource.json | 2 +- resources/icarBatchResult.json | 5 ++--- .../icarHealthStatusObservedEventResource.json | 3 +-- resources/icarProgenyDetailsResource.json | 16 +++++++--------- resources/icarReproDoNotBreedEventResource.json | 3 +-- resources/icarReproParturitionEventResource.json | 6 ++---- resources/icarResponseMessageResource.json | 10 ++++------ types/icarGroupSpecifierType.json | 12 ++++-------- types/icarIndividualWeightType.json | 9 ++++----- types/icarInventoryClassificationType.json | 5 ++--- types/icarMedicineCourseSummaryType.json | 10 ++++------ types/icarMetaDataType.json | 6 +++--- types/icarQuarterMilkingType.json | 9 +++------ types/icarStatisticsGroupType.json | 3 +-- 14 files changed, 39 insertions(+), 60 deletions(-) diff --git a/resources/icarAttentionEventResource.json b/resources/icarAttentionEventResource.json index 958b8ee..477c32d 100644 --- 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 index e087e80..03c6ffa 100644 --- 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 index 8dc4fdc..e43dd14 100644 --- 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 index 00ea968..966f828 100644 --- a/resources/icarProgenyDetailsResource.json +++ b/resources/icarProgenyDetailsResource.json @@ -16,7 +16,7 @@ "properties": { "identifier": { "description": "Unique animal scheme and identifier combination.", - "nullable": true, + "type": ["object", "null"], "allOf": [ { "$ref": "../types/icarAnimalIdentifierType.json" @@ -24,8 +24,7 @@ ] }, "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 index eaf4f9c..ce7fbb3 100644 --- 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 index e6a6f90..4208dd4 100644 --- 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 index 8f50b02..a97c2f8 100644 --- 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." } } } \ No newline at end of file diff --git a/types/icarGroupSpecifierType.json b/types/icarGroupSpecifierType.json index 8e05016..4c6a4d3 100644 --- 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 index 5bce0bd..501be0f 100644 --- 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" } } } \ No newline at end of file diff --git a/types/icarInventoryClassificationType.json b/types/icarInventoryClassificationType.json index 10153de..845e9e2 100644 --- 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 index fcdad68..19c7757 100644 --- 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 index d1c2cc2..f0083d7 100644 --- a/types/icarMetaDataType.json +++ b/types/icarMetaDataType.json @@ -27,7 +27,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" @@ -40,7 +40,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" @@ -49,7 +49,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 index 072e743..c08ae24 100644 --- 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/icarStatisticsGroupType.json b/types/icarStatisticsGroupType.json index 6992906..7fc789c 100644 --- 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": { From 919f4c9667c65d54d1d4a80bbea3e3d5984f20da Mon Sep 17 00:00:00 2001 From: Andrew Cooke <45248509+cookeac@users.noreply.github.com> Date: Fri, 1 Dec 2023 18:07:23 +1300 Subject: [PATCH 3/4] Remove Speccy (does not support OpenAPI 3.1) --- .github/workflows/ValidateWithSpeccy.yml | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 .github/workflows/ValidateWithSpeccy.yml diff --git a/.github/workflows/ValidateWithSpeccy.yml b/.github/workflows/ValidateWithSpeccy.yml deleted file mode 100644 index 1b787f3..0000000 --- a/.github/workflows/ValidateWithSpeccy.yml +++ /dev/null @@ -1,14 +0,0 @@ -name: Speccy JSON Validation CI - -on: [push] - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - name: validate JSON URL scheme - run: | - docker run wework/speccy lint -v -j https://raw.githubusercontent.com/${{github.repository}}/${GITHUB_REF##*/}/url-schemes/exampleUrlScheme.json --skip openapi-tags-alphabetical - From 87eed85484880084db94153a138e4e59d5f51973 Mon Sep 17 00:00:00 2001 From: cookeac Date: Thu, 18 Apr 2024 11:06:32 +1200 Subject: [PATCH 4/4] Remove enum from @type @type is already deprecated, but the use of "enum": ["Link"] to provide a constant value causes errors in code generation under OpenAPI 3.1. Fixes #451 --- types/icarResourceReferenceType.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/types/icarResourceReferenceType.json b/types/icarResourceReferenceType.json index 09ed987..6634b26 100644 --- 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",