Skip to content

Commit

Permalink
doc comma-contatenation
Browse files Browse the repository at this point in the history
* repetition of comma-concatenation for list values documentation
  • Loading branch information
mbaudis committed Jul 3, 2023
1 parent 09417cb commit 4c5527e
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
6 changes: 6 additions & 0 deletions docs/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,12 @@ For all query types, the logical `AND` is implied between Filters. The Filter `i
In this case general filter defaults apply (e.g. `{ "includeDescendantTerms": true }`). Generally,
use of filters other than CURIE values for filter ids is discouraged.

!!! Attention "List Parameters in GET Requests"

Since the direct interpretation of list parameters in queries is not supported by
some server environments (e.g. PHP, GO…), list parameters such as `start` and `end`
should be provided as **comma-concatenated** strings when using them in GET requests.

### CURIE based filters query (type "OntologyFilters")

!!! note "Hierarchical term expansion"
Expand Down
12 changes: 6 additions & 6 deletions docs/variant-queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,12 @@ differing in their exact base extents.
Bracket queries require the use of **two** `start` and `end` parameters, in contrast
to _Range Queries_.

!!! Attention "List Parameters in GET Requests"

Since the direct interpretation of list parameters in queries is not supported by
some server environments (e.g. PHP, GO…), list parameters such as `start` and `end`
should be provided as **comma-concatenated** strings when using them in GET requests.


#### Example: CNV Query - _TP53_ Deletion Query by Coordinates

Expand All @@ -230,12 +236,6 @@ larger than approx. 5Mb (operational definitions of focality vary between 1 and
* `datasetIds=__some-dataset-ids__`
* `filters` ...

!!! Attention "List Parameters in GET Requests"

Since the direct interpretation of list parameters in queries is not supported by
some server environments (e.g. PHP, GO…), list parameters such as `start` and `end`
should be provided as **comma-concatenated** strings when using them in GET requests.


=== "Beacon v2 POST"

Expand Down

0 comments on commit 4c5527e

Please sign in to comment.