ResultsetsResponse for cohorts/{id}/individuals

ga4gh-beacon · Mar 22, 2024 · ea4324b · ea4324b
1 parent 2553223
commit ea4324b
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 13 deletions.
diff --git 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
@@ -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,15 +164,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 operation for a collections 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/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