diff --git a/docs/schemas-md/obj/AgeRange.md b/docs/schemas-md/obj/AgeRange.md deleted file mode 100644 index 3c339728a..000000000 --- a/docs/schemas-md/obj/AgeRange.md +++ /dev/null @@ -1,3 +0,0 @@ -|Term | Description | Type | Properties | Example | Enum| -| ---| ---| ---| ---| ---| --- | -| AgeRange | Age range definition. Provenance: GA4GH Phenopackets v2 `AgeRange` | 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 e4923d337..000000000 --- a/docs/schemas-md/obj/Value.md +++ /dev/null @@ -1,3 +0,0 @@ -|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| 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/models/json/beacon-v2-default-model/cohorts/endpoints.json b/models/json/beacon-v2-default-model/cohorts/endpoints.json index 1e36b7462..699f97e98 100644 --- a/models/json/beacon-v2-default-model/cohorts/endpoints.json +++ b/models/json/beacon-v2-default-model/cohorts/endpoints.json @@ -68,9 +68,9 @@ } } }, - "description": "Successful collection list operation." + "description": "Successful operation for a collections request." }, - "ResultsOKResponse": { + "ResultsetsResponse": { "content": { "application/json": { "schema": { @@ -88,8 +88,8 @@ } } }, - "description": "Successful operation." - } + "description": "Successful operation for an individuals request." + } } }, "info": { @@ -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", @@ -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", @@ -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", @@ -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", diff --git a/models/json/beacon-v2-default-model/datasets/endpoints.json b/models/json/beacon-v2-default-model/datasets/endpoints.json index 3fdc832a4..e0851f597 100644 --- a/models/json/beacon-v2-default-model/datasets/endpoints.json +++ b/models/json/beacon-v2-default-model/datasets/endpoints.json @@ -66,9 +66,9 @@ } } }, - "description": "Successful collection list operation." + "description": "Successful collection operation." }, - "ResultsOKResponse": { + "ResultsetsResponse": { "content": { "application/json": { "schema": { @@ -86,7 +86,7 @@ } } }, - "description": "Successful operation." + "description": "Successful resultsets operation." } } }, @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -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", @@ -478,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 9fd0e999a..22aa94592 100644 --- a/models/src/beacon-v2-default-model/cohorts/endpoints.yaml +++ b/models/src/beacon-v2-default-model/cohorts/endpoints.yaml @@ -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 @@ -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: @@ -216,4 +217,5 @@ components: items: type: string examples: - - - OMIABIS:0001017 + - + - OMIABIS:0001017 diff --git a/models/src/beacon-v2-default-model/datasets/endpoints.yaml b/models/src/beacon-v2-default-model/datasets/endpoints.yaml index dc2c34d31..91d631262 100644 --- a/models/src/beacon-v2-default-model/datasets/endpoints.yaml +++ b/models/src/beacon-v2-default-model/datasets/endpoints.yaml @@ -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,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