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

received filters in summary to object #107

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"properties": {
"id": {
"description": "Field identfier to be queried.",
"example": "age",
"example": "ageOfOnset",
"type": "string"
},
"operator": {
Expand All @@ -21,17 +21,17 @@
">=",
"<="
],
"example": ">",
"examples": [ ">" ],
"type": "string"
},
"scope": {
"description": "The entry type to which the filter applies",
"example": "biosamples",
"example": "individuals",
"type": "string"
},
"value": {
"description": "Alphanumeric search term to be used within the query which can contain wildcard characters (%) to denote any number of unknown characters. Values can be assocatied with units if applicable.",
"example": "P70Y",
"examples": [ "P70Y" ],
"type": "string"
}
},
Expand All @@ -52,7 +52,7 @@
},
"scope": {
"description": "The entry type to which the filter applies",
"example": "biosamples",
"example": "individuals",
"type": "string"
}
},
Expand Down Expand Up @@ -89,7 +89,7 @@
},
"scope": {
"description": "The entry type to which the filter applies",
"example": "biosamples",
"examples": [ "biosamples" ],
"type": "string"
},
"similarity": {
Expand All @@ -114,6 +114,6 @@
"items": {
"$ref": "#/definitions/FilteringTerm"
},
"title": "Filtering Term Element",
"title": "Filtering Terms Array",
"type": "array"
}
2 changes: 1 addition & 1 deletion framework/json/requests/beaconRequestBody.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"description": "Parameters to limit the list of returned results.",
"properties": {
"filters": {
"$ref": "./filteringTerms.json",
"$ref": "../common/filteringTerms.json",
"description": "Ontology based filters. Using CURIE syntax is encouraged."
},
"includeResultsetResponses": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@
}
},
"required": [
"type",
"id"
"id",
"type"
],
"type": "object"
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"description": "API version expected by the client to be supported by the server and used in the response format."
},
"filters": {
"$ref": "../../common/beaconCommonComponents.json#/definitions/Filters",
"$ref": "../../common/filteringTerms.json",
"description": "Filters as submitted in the request."
},
"includeResultsetResponses": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ definitions:
id:
type: string
description: Term ID to be queried, using CURIE syntax where possible.
example: HP:0002664
examples:
- HP:0002664
includeDescendantTerms:
type: boolean
default: true
Expand All @@ -46,7 +47,8 @@ definitions:
scope:
type: string
description: The entry type to which the filter applies
example: biosamples
examples:
- biosamples
AlphanumericFilter:
description: Filter results based on operators and values applied to alphanumeric
fields.
Expand All @@ -59,7 +61,8 @@ definitions:
id:
type: string
description: Field identfier to be queried.
example: age
examples:
- ageOfOnset
operator:
type: string
enum:
Expand All @@ -71,17 +74,20 @@ definitions:
- <=
description: Defines how the value relates to the field `id`.
default: '='
example: '>'
examples:
- '>'
value:
type: string
description: Alphanumeric search term to be used within the query which can
description: >-
Alphanumeric search term to be used within the query which can
contain wildcard characters (%) to denote any number of unknown characters. Values
can be assocatied with units if applicable.
example: P70Y
scope:
type: string
description: The entry type to which the filter applies
example: biosamples
examples:
- individuals
CustomFilter:
type: object
description: Filter results to include records that contain a custom term defined
Expand All @@ -96,5 +102,6 @@ definitions:
scope:
type: string
description: The entry type to which the filter applies
example: biosamples
examples:
- individuals
additionalProperties: true
2 changes: 1 addition & 1 deletion framework/src/requests/beaconRequestBody.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ definitions:
filters:
description: >-
Ontology based filters. Using CURIE syntax is encouraged.
$ref: ./filteringTerms.yaml
$ref: ../common/filteringTerms.yaml
includeResultsetResponses:
$ref: ../common/beaconCommonComponents.yaml#/definitions/IncludeResultsetResponses
pagination:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ definitions:
description: >-
Entities can be filtered using this term.
required:
- type
- id
- type
properties:
type:
type: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ properties:
filters:
description: >-
Filters as submitted in the request.
$ref: ../../common/beaconCommonComponents.yaml#/definitions/Filters
$ref: ../../common/filteringTerms.yaml
requestParameters:
description: >-
Dictionary of request parameters received in the `RequestBody` or as part
Expand Down