From b5ab155e2bf950b43bcba329329b4d681699dfe1 Mon Sep 17 00:00:00 2001 From: Erwin Speybroeck Date: Fri, 28 Jul 2023 08:35:48 +0200 Subject: [PATCH 1/6] Update exampleUrlScheme.json added service-sires --- url-schemes/exampleUrlScheme.json | 50 +++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/url-schemes/exampleUrlScheme.json b/url-schemes/exampleUrlScheme.json index 6e37583..c708a27 100644 --- a/url-schemes/exampleUrlScheme.json +++ b/url-schemes/exampleUrlScheme.json @@ -717,6 +717,38 @@ } } }, + "/service-sires": { + "get": { + "operationId": "get-service-sires", + "summary": "Get the service sires", + "description": "# Purpose\nProvides the service sires\n", + "tags": [ + "ADE-1.3-registration" + ], + "parameters": [{ + "$ref": "#/components/parameters/identifier-scheme" + }, + { + "$ref": "#/components/parameters/identifier" + } + ], + "responses": { + "200": { + "description": "Successful. The response contains the animals for the given location", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/icarAnimalCoreCollection" + } + } + } + }, + "default": { + "$ref": "#/components/responses/default" + } + } + } + }, "/locations/{location-scheme}/{location-id}/statistics": { "get": { "operationId": "get-statistics", @@ -2610,6 +2642,24 @@ "type": "string" } }, + "identifier": { + "name": "identifier", + "in": "query", + "description": "The identifier of an animal.", + "required": true, + "schema": { + "type": "string" + } + }, + "identifier-scheme": { + "name": "identifier-scheme", + "in": "query", + "description": "The scheme id for the animal identifier..", + "required": true, + "schema": { + "type": "string" + } + }, "meta-modified-from": { "name": "meta-modified-from", "in": "query", From efa2e82ad3b2b598def3a5129bf8da68df6ca52e Mon Sep 17 00:00:00 2001 From: Erwin Speybroeck Date: Fri, 28 Jul 2023 08:42:16 +0200 Subject: [PATCH 2/6] Update exampleUrlScheme.json seems identifier-scheme already existed ;-) --- url-schemes/exampleUrlScheme.json | 20 +------------------- 1 file changed, 1 insertion(+), 19 deletions(-) diff --git a/url-schemes/exampleUrlScheme.json b/url-schemes/exampleUrlScheme.json index c708a27..37aba9a 100644 --- a/url-schemes/exampleUrlScheme.json +++ b/url-schemes/exampleUrlScheme.json @@ -729,7 +729,7 @@ "$ref": "#/components/parameters/identifier-scheme" }, { - "$ref": "#/components/parameters/identifier" + "$ref": "#/components/parameters/identifier-id" } ], "responses": { @@ -2642,24 +2642,6 @@ "type": "string" } }, - "identifier": { - "name": "identifier", - "in": "query", - "description": "The identifier of an animal.", - "required": true, - "schema": { - "type": "string" - } - }, - "identifier-scheme": { - "name": "identifier-scheme", - "in": "query", - "description": "The scheme id for the animal identifier..", - "required": true, - "schema": { - "type": "string" - } - }, "meta-modified-from": { "name": "meta-modified-from", "in": "query", From 1baf688dfd01a68f8f988fbff7adf0ca9d6ddfb2 Mon Sep 17 00:00:00 2001 From: Erwin Speybroeck Date: Fri, 28 Jul 2023 08:48:11 +0200 Subject: [PATCH 3/6] Update exampleUrlScheme.json tweaked some swagger comments --- url-schemes/exampleUrlScheme.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/url-schemes/exampleUrlScheme.json b/url-schemes/exampleUrlScheme.json index 37aba9a..1b88847 100644 --- a/url-schemes/exampleUrlScheme.json +++ b/url-schemes/exampleUrlScheme.json @@ -719,8 +719,8 @@ }, "/service-sires": { "get": { - "operationId": "get-service-sires", - "summary": "Get the service sires", + "operationId": "get-service-sires for a given id", + "summary": "Get the service sires matching your query parameters", "description": "# Purpose\nProvides the service sires\n", "tags": [ "ADE-1.3-registration" @@ -734,7 +734,7 @@ ], "responses": { "200": { - "description": "Successful. The response contains the animals for the given location", + "description": "Successful. The response contains the service sires matching your query parameters", "content": { "application/json": { "schema": { From f2b58879b949ef8eaf31e13b375b89f49409bb9f Mon Sep 17 00:00:00 2001 From: Erwin Speybroeck <47346780+erwinspeybroeck@users.noreply.github.com> Date: Tue, 8 Aug 2023 15:00:17 +0200 Subject: [PATCH 4/6] Update exampleUrlScheme.json corrected operation id --- url-schemes/exampleUrlScheme.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/url-schemes/exampleUrlScheme.json b/url-schemes/exampleUrlScheme.json index 1b88847..2d0a55b 100644 --- a/url-schemes/exampleUrlScheme.json +++ b/url-schemes/exampleUrlScheme.json @@ -719,7 +719,7 @@ }, "/service-sires": { "get": { - "operationId": "get-service-sires for a given id", + "operationId": "get-service-sires", "summary": "Get the service sires matching your query parameters", "description": "# Purpose\nProvides the service sires\n", "tags": [ From 3562dd2fee6c03347caedce19bdbcd9d8d123875 Mon Sep 17 00:00:00 2001 From: Erwin Speybroeck <47346780+erwinspeybroeck@users.noreply.github.com> Date: Thu, 10 Aug 2023 09:13:10 +0200 Subject: [PATCH 5/6] Update url-schemes/exampleUrlScheme.json Co-authored-by: Andrew Cooke <45248509+cookeac@users.noreply.github.com> --- url-schemes/exampleUrlScheme.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/url-schemes/exampleUrlScheme.json b/url-schemes/exampleUrlScheme.json index 2d0a55b..5ba7c44 100644 --- a/url-schemes/exampleUrlScheme.json +++ b/url-schemes/exampleUrlScheme.json @@ -721,7 +721,7 @@ "get": { "operationId": "get-service-sires", "summary": "Get the service sires matching your query parameters", - "description": "# Purpose\nProvides the service sires\n", + "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" ], From 3e14f123e89c2336961b159a9b728611e0586684 Mon Sep 17 00:00:00 2001 From: Erwin Speybroeck <47346780+erwinspeybroeck@users.noreply.github.com> Date: Thu, 10 Aug 2023 09:15:43 +0200 Subject: [PATCH 6/6] Update url-schemes/exampleUrlScheme.json --- url-schemes/exampleUrlScheme.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/url-schemes/exampleUrlScheme.json b/url-schemes/exampleUrlScheme.json index 5ba7c44..4136249 100644 --- a/url-schemes/exampleUrlScheme.json +++ b/url-schemes/exampleUrlScheme.json @@ -720,7 +720,7 @@ "/service-sires": { "get": { "operationId": "get-service-sires", - "summary": "Get the service sires matching your query parameters", + "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"