Add note on Elasticsearch usage with a warning about the slash in ful…

…l DOIs. Resolves #34.
zenodo · May 24, 2024 · a6c49b5 · a6c49b5
1 parent 8f1cd12
commit a6c49b5
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/source/includes/resources/deposit/_list.md b/source/includes/resources/deposit/_list.md
@@ -20,9 +20,9 @@ curl -i /api/deposit/depositions/?access_token=ACCESS_TOKEN
 
 #### Query arguments
 
-| Parameter | Required | Description|
-|:----------|:---------|:-----------|
-| `q`</br>_string_  | optional | Search query (using Elasticsearch query string syntax). |
+| Parameter | Required | Description |
+|:----------|:---------|:------------|
+| `q`</br>_string_  | optional | Search query (using [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) query string syntax - note that some characters have special meaning here, including ``/``, which is also present in full DOIs). |
 | `status`</br>_string_ | optional | Filter result based on deposit status (either ``draft`` or ``published``) |
 | `sort`</br>_string_ | optional | Sort order (``bestmatch`` or ``mostrecent``). Prefix with minus to change form ascending to descending (e.g. ``-mostrecent``). |
 | `page`</br>_integer_ | optional | Page number for pagination. |

diff --git a/source/includes/resources/licenses/_list.md b/source/includes/resources/licenses/_list.md
@@ -20,7 +20,7 @@ curl /api/licenses/
 
 | Parameter            | Required | Description                                             |
 | :------------------- | :------- | :------------------------------------------------------ |
-| `q`</br>_string_     | optional | Search query (using Elasticsearch query string syntax). |
+| `q`</br>_string_     | optional | Search query (using [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) query string syntax - note that some characters have special meaning here, including ``/``, which is also present in full DOIs). |
 | `page`</br>_integer_ | optional | Page number for pagination.                             |
 | `size`</br>_integer_ | optional | Number of results to return per page.                   |
 

diff --git a/source/includes/resources/records/_list.md b/source/includes/resources/records/_list.md
@@ -22,17 +22,17 @@ curl -i /api/records/?access_token=ACCESS_TOKEN
 
 | Parameter                   | Required | Description                                                                                                                    |
 |:----------------------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------|
-| `q`</br>_string_            | optional | Search query (using Elasticsearch query string syntax).                                                                        |
-| `status`</br>_string_       | optional | Filter result based on the deposit status (either ``draft`` or ``published``)                                                      |
+| `q`</br>_string_            | optional | Search query (using [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html) query string syntax - note that some characters have special meaning here, including ``/``, which is also present in full DOIs). |
+| `status`</br>_string_       | optional | Filter result based on the deposit status (either ``draft`` or ``published``)                                                  |
 | `sort`</br>_string_         | optional | Sort order (``bestmatch`` or ``mostrecent``). Prefix with minus to change form ascending to descending (e.g. ``-mostrecent``). |
 | `page`</br>_integer_        | optional | Page number for pagination.                                                                                                    |
 | `size`</br>_integer_        | optional | Number of results to return per page.                                                                                          |
 | `all_versions`</br>_integer/string_ | optional | Show (`true` or `1`) or hide (`false` or `0`) all versions of records. |
-| `communities`</br> _string_ | optional | Return records that are part of the specified communities. (Use of `community identifier`)                                              |
-| `type`</br> _string_        | optional | Return records of the specified type. (`Publication`, `Poster`, `Presentation`...)                                        |
-| `subtype`</br> _string_     | optional | Return records of the specified subtype. (`Journal article`, `Preprint`, `Proposal`...)                                   |
-| `bounds`</br> _string_      | optional | Return records filtered by a geolocation bounding box. (Format `bounds=143.37158,-38.99357,146.90918,-37.35269`)                               |
-| `custom`</br> _string_      | optional | Return records containing the specified custom keywords. (Format `custom=[field_name]:field_value`)                               |
+| `communities`</br> _string_ | optional | Return records that are part of the specified communities. (Use of `community identifier`)                                     |
+| `type`</br> _string_        | optional | Return records of the specified type. (`Publication`, `Poster`, `Presentation`...)                                             |
+| `subtype`</br> _string_     | optional | Return records of the specified subtype. (`Journal article`, `Preprint`, `Proposal`...)                                        |
+| `bounds`</br> _string_      | optional | Return records filtered by a geolocation bounding box. (Format `bounds=143.37158,-38.99357,146.90918,-37.35269`)               |
+| `custom`</br> _string_      | optional | Return records containing the specified custom keywords. (Format `custom=[field_name]:field_value`)                            |
 
 #### Header