Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Collections response fix endpoints #121

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions docs/schemas-md/obj/AgeRange.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/schemas-md/obj/Value.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/schemas-md/obj/ageRange.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/schemas-md/obj/value.md

This file was deleted.

16 changes: 8 additions & 8 deletions models/json/beacon-v2-default-model/cohorts/endpoints.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@
}
}
},
"description": "Successful collection list operation."
"description": "Successful operation for a collections request."
},
"ResultsOKResponse": {
"ResultsetsResponse": {
"content": {
"application/json": {
"schema": {
Expand All @@ -88,8 +88,8 @@
}
}
},
"description": "Successful operation."
}
"description": "Successful operation for an individuals request."
}
}
},
"info": {
Expand Down Expand Up @@ -174,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",
Expand Down Expand Up @@ -205,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",
Expand Down Expand Up @@ -305,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",
Expand Down Expand Up @@ -336,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",
Expand Down
24 changes: 12 additions & 12 deletions models/json/beacon-v2-default-model/datasets/endpoints.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@
}
}
},
"description": "Successful collection list operation."
"description": "Successful collection operation."
},
"ResultsOKResponse": {
"ResultsetsResponse": {
"content": {
"application/json": {
"schema": {
Expand All @@ -86,7 +86,7 @@
}
}
},
"description": "Successful operation."
"description": "Successful resultsets operation."
}
}
},
Expand Down Expand Up @@ -172,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",
Expand Down Expand Up @@ -203,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",
Expand Down Expand Up @@ -232,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",
Expand Down Expand Up @@ -263,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",
Expand Down Expand Up @@ -363,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",
Expand Down Expand Up @@ -394,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",
Expand Down Expand Up @@ -423,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",
Expand Down Expand Up @@ -454,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",
Expand All @@ -478,4 +478,4 @@
"name": "POST Endpoints"
}
]
}
}
28 changes: 15 additions & 13 deletions models/src/beacon-v2-default-model/cohorts/endpoints.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -164,29 +164,30 @@ 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/beaconResultsetsResponse.json
CollectionsResponse:
description: Successful collection list operation.
- $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/beaconCollectionsResponse.json
- $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconResultsetsResponse.json
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:
Expand Down Expand Up @@ -216,4 +217,5 @@ components:
items:
type: string
examples:
- - OMIABIS:0001017
-
- OMIABIS:0001017
28 changes: 14 additions & 14 deletions models/src/beacon-v2-default-model/datasets/endpoints.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -238,24 +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/beaconResultsetsResponse.json
CollectionsResponse:
description: Successful collection list operation.
- $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/beaconCollectionsResponse.json
- $ref: https://raw.githubusercontent.com/ga4gh-beacon/beacon-v2/main/framework/json/responses/beaconResultsetsResponse.json
parameters:
requestedSchema:
name: requestedSchema
Expand Down
Loading