From ea3be857bbb7983e8e434e2017c612dedbf1a17e Mon Sep 17 00:00:00 2001 From: Michael Baudis Date: Thu, 21 Mar 2024 19:18:12 +0100 Subject: [PATCH 1/6] fixing ResultsOKResponse for cohorts --- .../cohorts/endpoints.json | 26 +++---------------- .../cohorts/endpoints.yaml | 21 +++++---------- 2 files changed, 10 insertions(+), 37 deletions(-) diff --git a/models/json/beacon-v2-default-model/cohorts/endpoints.json b/models/json/beacon-v2-default-model/cohorts/endpoints.json index 1e36b7462..417c26028 100644 --- a/models/json/beacon-v2-default-model/cohorts/endpoints.json +++ b/models/json/beacon-v2-default-model/cohorts/endpoints.json @@ -50,26 +50,6 @@ } }, "responses": { - "CollectionsResponse": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconBooleanResponse.json" - }, - { - "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCountResponse.json" - }, - { - "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCollectionsResponse.json" - } - ] - } - } - }, - "description": "Successful collection list operation." - }, "ResultsOKResponse": { "content": { "application/json": { @@ -82,7 +62,7 @@ "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCountResponse.json" }, { - "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconResultsetsResponse.json" + "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCollectionsResponse.json" } ] } @@ -126,7 +106,7 @@ ], "responses": { "200": { - "$ref": "#/components/responses/CollectionsResponse" + "$ref": "#/components/responses/ResultsOKResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json" @@ -151,7 +131,7 @@ }, "responses": { "200": { - "$ref": "#/components/responses/CollectionsResponse" + "$ref": "#/components/responses/ResultsOKResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", diff --git a/models/src/beacon-v2-default-model/cohorts/endpoints.yaml b/models/src/beacon-v2-default-model/cohorts/endpoints.yaml index 9fd0e999a..56fe318a5 100644 --- a/models/src/beacon-v2-default-model/cohorts/endpoints.yaml +++ b/models/src/beacon-v2-default-model/cohorts/endpoints.yaml @@ -28,7 +28,7 @@ paths: - GET Endpoints responses: '200': - $ref: '#/components/responses/CollectionsResponse' + $ref: '#/components/responses/ResultsOKResponse' default: $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json post: @@ -44,7 +44,7 @@ paths: required: true responses: '200': - $ref: '#/components/responses/CollectionsResponse' + $ref: '#/components/responses/ResultsOKResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -166,15 +166,6 @@ components: responses: ResultsOKResponse: description: Successful operation. - content: - application/json: - schema: - oneOf: - - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconBooleanResponse.json - - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCountResponse.json - - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconResultsetsResponse.json - CollectionsResponse: - description: Successful collection list operation. content: application/json: schema: @@ -185,8 +176,9 @@ components: parameters: requestedSchema: name: requestedSchema - description: Schema to be used to format the `result` field in the response. - The response will use Beacon format. + description: >- + Schema to be used to format the `result` field in the response. + The response will use the Beacon format. in: query required: false schema: @@ -216,4 +208,5 @@ components: items: type: string examples: - - - OMIABIS:0001017 + - + - OMIABIS:0001017 From 2553223b2cc352e254c4386dd8cad32604f823d5 Mon Sep 17 00:00:00 2001 From: Michael Baudis Date: Thu, 21 Mar 2024 19:22:21 +0100 Subject: [PATCH 2/6] beaconCollectionsResponse --- .../datasets/endpoints.json | 26 +++---------------- .../datasets/endpoints.yaml | 13 ++-------- 2 files changed, 5 insertions(+), 34 deletions(-) diff --git a/models/json/beacon-v2-default-model/datasets/endpoints.json b/models/json/beacon-v2-default-model/datasets/endpoints.json index 3fdc832a4..4a6688ad2 100644 --- a/models/json/beacon-v2-default-model/datasets/endpoints.json +++ b/models/json/beacon-v2-default-model/datasets/endpoints.json @@ -48,26 +48,6 @@ } }, "responses": { - "CollectionsResponse": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconBooleanResponse.json" - }, - { - "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCountResponse.json" - }, - { - "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCollectionsResponse.json" - } - ] - } - } - }, - "description": "Successful collection list operation." - }, "ResultsOKResponse": { "content": { "application/json": { @@ -80,7 +60,7 @@ "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCountResponse.json" }, { - "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconResultsetsResponse.json" + "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCollectionsResponse.json" } ] } @@ -124,7 +104,7 @@ ], "responses": { "200": { - "$ref": "#/components/responses/CollectionsResponse" + "$ref": "#/components/responses/ResultsOKResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json" @@ -149,7 +129,7 @@ }, "responses": { "200": { - "$ref": "#/components/responses/CollectionsResponse" + "$ref": "#/components/responses/ResultsOKResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", diff --git a/models/src/beacon-v2-default-model/datasets/endpoints.yaml b/models/src/beacon-v2-default-model/datasets/endpoints.yaml index dc2c34d31..e3c86da0a 100644 --- a/models/src/beacon-v2-default-model/datasets/endpoints.yaml +++ b/models/src/beacon-v2-default-model/datasets/endpoints.yaml @@ -28,7 +28,7 @@ paths: - GET Endpoints responses: '200': - $ref: '#/components/responses/CollectionsResponse' + $ref: '#/components/responses/ResultsOKResponse' default: $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json post: @@ -44,7 +44,7 @@ paths: required: true responses: '200': - $ref: '#/components/responses/CollectionsResponse' + $ref: '#/components/responses/ResultsOKResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -240,15 +240,6 @@ components: responses: ResultsOKResponse: description: Successful operation. - content: - application/json: - schema: - oneOf: - - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconBooleanResponse.json - - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCountResponse.json - - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconResultsetsResponse.json - CollectionsResponse: - description: Successful collection list operation. content: application/json: schema: From ea4324b420bc3995be2d07dad980f124092492e4 Mon Sep 17 00:00:00 2001 From: Michael Baudis <675030+mbaudis@users.noreply.github.com> Date: Fri, 22 Mar 2024 10:05:17 +0100 Subject: [PATCH 3/6] ResultsetsResponse for cohorts/{id}/individuals --- .../cohorts/endpoints.json | 38 ++++++++++++++----- .../cohorts/endpoints.yaml | 17 +++++++-- 2 files changed, 42 insertions(+), 13 deletions(-) diff --git a/models/json/beacon-v2-default-model/cohorts/endpoints.json b/models/json/beacon-v2-default-model/cohorts/endpoints.json index 417c26028..699f97e98 100644 --- a/models/json/beacon-v2-default-model/cohorts/endpoints.json +++ b/models/json/beacon-v2-default-model/cohorts/endpoints.json @@ -50,7 +50,7 @@ } }, "responses": { - "ResultsOKResponse": { + "CollectionsResponse": { "content": { "application/json": { "schema": { @@ -68,8 +68,28 @@ } } }, - "description": "Successful operation." - } + "description": "Successful operation for a collections request." + }, + "ResultsetsResponse": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconBooleanResponse.json" + }, + { + "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCountResponse.json" + }, + { + "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconResultsetsResponse.json" + } + ] + } + } + }, + "description": "Successful operation for an individuals request." + } } }, "info": { @@ -106,7 +126,7 @@ ], "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/CollectionsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json" @@ -131,7 +151,7 @@ }, "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/CollectionsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", @@ -154,7 +174,7 @@ ], "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/CollectionsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", @@ -185,7 +205,7 @@ }, "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/CollectionsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", @@ -285,7 +305,7 @@ ], "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/ResultsetsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", @@ -316,7 +336,7 @@ }, "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/ResultsetsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", diff --git a/models/src/beacon-v2-default-model/cohorts/endpoints.yaml b/models/src/beacon-v2-default-model/cohorts/endpoints.yaml index 56fe318a5..4e6c9ad53 100644 --- a/models/src/beacon-v2-default-model/cohorts/endpoints.yaml +++ b/models/src/beacon-v2-default-model/cohorts/endpoints.yaml @@ -96,7 +96,7 @@ paths: - GET Endpoints responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/ResultsetsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -114,7 +114,7 @@ paths: required: true responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/ResultsetsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -164,8 +164,8 @@ paths: $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json components: responses: - ResultsOKResponse: - description: Successful operation. + CollectionsResponse: + description: Successful operation for a collections request. content: application/json: schema: @@ -173,6 +173,15 @@ components: - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconBooleanResponse.json - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCountResponse.json - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCollectionsResponse.json + ResultsetsResponse: + description: Successful operation for an individuals request. + content: + application/json: + schema: + oneOf: + - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconBooleanResponse.json + - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCountResponse.json + - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconResultsetsResponse.json parameters: requestedSchema: name: requestedSchema From 1012bd9ccce5080a96fabd120250a3c90482b9cd Mon Sep 17 00:00:00 2001 From: Michael Baudis Date: Mon, 25 Mar 2024 11:37:40 +0100 Subject: [PATCH 4/6] fix remnants of resultsOKresponse => CollectionsResponse collections response new prototypes cleanup This fixes the wrong response for some of teh collections endpoints and changes the (definitely now) ambiguous ResultsOKResponse to the correct instances of * CollectionsResponse * ResultsetsResponse --- .../datasets/endpoints.json | 46 +++++++++++++------ .../cohorts/endpoints.yaml | 8 ++-- .../datasets/endpoints.yaml | 35 ++++++++------ 3 files changed, 59 insertions(+), 30 deletions(-) diff --git a/models/json/beacon-v2-default-model/datasets/endpoints.json b/models/json/beacon-v2-default-model/datasets/endpoints.json index 4a6688ad2..e0851f597 100644 --- a/models/json/beacon-v2-default-model/datasets/endpoints.json +++ b/models/json/beacon-v2-default-model/datasets/endpoints.json @@ -48,7 +48,7 @@ } }, "responses": { - "ResultsOKResponse": { + "CollectionsResponse": { "content": { "application/json": { "schema": { @@ -66,7 +66,27 @@ } } }, - "description": "Successful operation." + "description": "Successful collection operation." + }, + "ResultsetsResponse": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconBooleanResponse.json" + }, + { + "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCountResponse.json" + }, + { + "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconResultsetsResponse.json" + } + ] + } + } + }, + "description": "Successful resultsets operation." } } }, @@ -104,7 +124,7 @@ ], "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/CollectionsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json" @@ -129,7 +149,7 @@ }, "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/CollectionsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", @@ -152,7 +172,7 @@ ], "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/CollectionsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", @@ -183,7 +203,7 @@ }, "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/CollectionsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", @@ -212,7 +232,7 @@ ], "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/ResultsetsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", @@ -243,7 +263,7 @@ }, "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/ResultsetsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", @@ -343,7 +363,7 @@ ], "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/ResultsetsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", @@ -374,7 +394,7 @@ }, "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/ResultsetsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", @@ -403,7 +423,7 @@ ], "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/ResultsetsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", @@ -434,7 +454,7 @@ }, "responses": { "200": { - "$ref": "#/components/responses/ResultsOKResponse" + "$ref": "#/components/responses/ResultsetsResponse" }, "default": { "$ref": "https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json", @@ -458,4 +478,4 @@ "name": "POST Endpoints" } ] -} \ No newline at end of file +} diff --git a/models/src/beacon-v2-default-model/cohorts/endpoints.yaml b/models/src/beacon-v2-default-model/cohorts/endpoints.yaml index 4e6c9ad53..22aa94592 100644 --- a/models/src/beacon-v2-default-model/cohorts/endpoints.yaml +++ b/models/src/beacon-v2-default-model/cohorts/endpoints.yaml @@ -28,7 +28,7 @@ paths: - GET Endpoints responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/CollectionsResponse' default: $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json post: @@ -44,7 +44,7 @@ paths: required: true responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/CollectionsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -60,7 +60,7 @@ paths: - GET Endpoints responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/CollectionsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -77,7 +77,7 @@ paths: required: true responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/CollectionsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json diff --git a/models/src/beacon-v2-default-model/datasets/endpoints.yaml b/models/src/beacon-v2-default-model/datasets/endpoints.yaml index e3c86da0a..91d631262 100644 --- a/models/src/beacon-v2-default-model/datasets/endpoints.yaml +++ b/models/src/beacon-v2-default-model/datasets/endpoints.yaml @@ -28,7 +28,7 @@ paths: - GET Endpoints responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/CollectionsResponse' default: $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json post: @@ -44,7 +44,7 @@ paths: required: true responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/CollectionsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -60,7 +60,7 @@ paths: - GET Endpoints responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/CollectionsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -77,7 +77,7 @@ paths: required: true responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/CollectionsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -96,7 +96,7 @@ paths: - GET Endpoints responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/ResultsetsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -114,7 +114,7 @@ paths: required: true responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/ResultsetsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -133,7 +133,7 @@ paths: - GET Endpoints responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/ResultsetsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -151,7 +151,7 @@ paths: required: true responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/ResultsetsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -170,7 +170,7 @@ paths: - GET Endpoints responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/ResultsetsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -188,7 +188,7 @@ paths: required: true responses: '200': - $ref: '#/components/responses/ResultsOKResponse' + $ref: '#/components/responses/ResultsetsResponse' default: description: An unsuccessful operation $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json @@ -238,15 +238,24 @@ paths: $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconErrorResponse.json components: responses: - ResultsOKResponse: - description: Successful operation. + CollectionsResponse: + description: Successful collection operation. content: application/json: schema: oneOf: - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconBooleanResponse.json - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCountResponse.json - - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCollectionsResponse.json + - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCollectionsResponse.json + ResultsetsResponse: + description: Successful resultset operation. + content: + application/json: + schema: + oneOf: + - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconBooleanResponse.json + - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconCountResponse.json + - $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconResultsetsResponse.json parameters: requestedSchema: name: requestedSchema From 063cb8af37cd9aa6d753a6ed6df2c8361075dd38 Mon Sep 17 00:00:00 2001 From: Michael Baudis <675030+mbaudis@users.noreply.github.com> Date: Mon, 25 Mar 2024 15:12:46 +0100 Subject: [PATCH 5/6] file case bug fix This is just a temporary removal of files colliding w/ case insensitive file systems. We'll have to address the doc file re-generation at some point ... --- docs/schemas-md/obj/AgeRange.md | 2 +- docs/schemas-md/obj/Value.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/schemas-md/obj/AgeRange.md b/docs/schemas-md/obj/AgeRange.md index 3c339728a..daf2d0020 100644 --- a/docs/schemas-md/obj/AgeRange.md +++ b/docs/schemas-md/obj/AgeRange.md @@ -1,3 +1,3 @@ |Term | Description | Type | Properties | Example | Enum| | ---| ---| ---| ---| ---| --- | -| AgeRange | Age range definition. Provenance: GA4GH Phenopackets v2 `AgeRange` | object | [end](./end.md), [start](./start.md) | NA | NA| +| ageRange | Individual age range in cohort inclusion criteria | object | [end](./end.md), [start](./start.md) | NA | NA| diff --git a/docs/schemas-md/obj/Value.md b/docs/schemas-md/obj/Value.md index e4923d337..9f7ec9ebd 100644 --- a/docs/schemas-md/obj/Value.md +++ b/docs/schemas-md/obj/Value.md @@ -1,3 +1,3 @@ |Term | Description | Type | Properties | Example | Enum| | ---| ---| ---| ---| ---| --- | -| Value | NA | oneOf | [Quantity](https://phenopacket-schema.readthedocs.io/en/latest/building-blocks.html), [ontologyTerm](https://github.com/ga4gh-beacon/beacon-v2/blob/main/framework/src/common/ontologyTerm.yaml) | NA | NA| +| value | The value of the quantity in the units | number | NA | NA | NA| From b854dc477bff198068446b596c1d28e1444601c2 Mon Sep 17 00:00:00 2001 From: Michael Baudis <675030+mbaudis@users.noreply.github.com> Date: Mon, 25 Mar 2024 15:12:46 +0100 Subject: [PATCH 6/6] file case bug fix This is just a temporary removal of files colliding w/ case insensitive file systems. We'll have to address the doc file re-generation at some point ... --- docs/schemas-md/obj/AgeRange.md | 3 --- docs/schemas-md/obj/Value.md | 3 --- docs/schemas-md/obj/ageRange.md | 3 --- docs/schemas-md/obj/value.md | 3 --- 4 files changed, 12 deletions(-) delete mode 100644 docs/schemas-md/obj/AgeRange.md delete mode 100644 docs/schemas-md/obj/Value.md delete mode 100644 docs/schemas-md/obj/ageRange.md delete mode 100644 docs/schemas-md/obj/value.md diff --git a/docs/schemas-md/obj/AgeRange.md b/docs/schemas-md/obj/AgeRange.md deleted file mode 100644 index daf2d0020..000000000 --- a/docs/schemas-md/obj/AgeRange.md +++ /dev/null @@ -1,3 +0,0 @@ -|Term | Description | Type | Properties | Example | Enum| -| ---| ---| ---| ---| ---| --- | -| ageRange | Individual age range in cohort inclusion criteria | object | [end](./end.md), [start](./start.md) | NA | NA| diff --git a/docs/schemas-md/obj/Value.md b/docs/schemas-md/obj/Value.md deleted file mode 100644 index 9f7ec9ebd..000000000 --- a/docs/schemas-md/obj/Value.md +++ /dev/null @@ -1,3 +0,0 @@ -|Term | Description | Type | Properties | Example | Enum| -| ---| ---| ---| ---| ---| --- | -| value | The value of the quantity in the units | number | NA | NA | NA| diff --git a/docs/schemas-md/obj/ageRange.md b/docs/schemas-md/obj/ageRange.md deleted file mode 100644 index daf2d0020..000000000 --- a/docs/schemas-md/obj/ageRange.md +++ /dev/null @@ -1,3 +0,0 @@ -|Term | Description | Type | Properties | Example | Enum| -| ---| ---| ---| ---| ---| --- | -| ageRange | Individual age range in cohort inclusion criteria | object | [end](./end.md), [start](./start.md) | NA | NA| diff --git a/docs/schemas-md/obj/value.md b/docs/schemas-md/obj/value.md deleted file mode 100644 index 9f7ec9ebd..000000000 --- a/docs/schemas-md/obj/value.md +++ /dev/null @@ -1,3 +0,0 @@ -|Term | Description | Type | Properties | Example | Enum| -| ---| ---| ---| ---| ---| --- | -| value | The value of the quantity in the units | number | NA | NA | NA|