From 4c5527e34cdd58705b174d5bbbfea35f979cbd77 Mon Sep 17 00:00:00 2001 From: Michael Baudis <675030+mbaudis@users.noreply.github.com> Date: Mon, 3 Jul 2023 12:19:00 +0200 Subject: [PATCH] doc comma-contatenation * repetition of comma-concatenation for list values documentation --- docs/filters.md | 6 ++++++ docs/variant-queries.md | 12 ++++++------ 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/filters.md b/docs/filters.md index db8de74b7..3e985c585 100644 --- a/docs/filters.md +++ b/docs/filters.md @@ -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" diff --git a/docs/variant-queries.md b/docs/variant-queries.md index b8827aa68..656215cba 100644 --- a/docs/variant-queries.md +++ b/docs/variant-queries.md @@ -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 @@ -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"