Skip to content

Commit

Permalink
Update search documentation (#218)
Browse files Browse the repository at this point in the history
* Update response_formats.rst

fix typo on kvp

* Update endpoints.rst

Change wildcarding rules

resolves #210
  • Loading branch information
al-niessner authored Sep 28, 2022
1 parent ace9623 commit a7e4898
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/source/guides/search/endpoints.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,13 +128,15 @@ The query syntax follows the rules:
* **{field}** follows the `Fields Dot Notation`_ . The available fields can be found in responses `summary` object, `properties` attribute.
* **{comparison operator}** are eq, ne, gt, lt, ge, le
* **{literal value}** is either a string between ``"`` (double quotes) or a numerical value (float or integer). Wildcards (\*, ?) are supported in strings.
* **{literal value}** is either a string between ``"`` (double quotes) or a numerical value (float or integer).
* Wildcard searching is available with the **like** operator. The wildcarding syntax of the **{literal value}** follows the [OpenSearch Simple Query String](https://opensearch.org/docs/latest/opensearch/query-dsl/full-text/#simple-query-string) convention.

======================= =========================== ============
**Operator** **Description** **Example**
======================= =========================== ============
*Comparison Operators*
eq Equal target\_name **eq** "Mars"
like Similar to target\_name **like** "mars"
ne Not equal target\_name **ne** "Saturn"
gt Greater than pds:Time\_Coordinates.pds:start\_date\_time **gt** 2001-05-10T00:00:00Z
ge Greater than or equal pds:Time\_Coordinates.pds:start\_date\_time **ge** 2001-05-10T00:00:00Z
Expand Down
3 changes: 2 additions & 1 deletion docs/source/guides/search/response_formats.rst
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,8 @@ The tag `pds_api:pds4` contains the XML PDS4 label.

In addition a `meta` object contains fields related to the managed of the record in the `PDS Registry <https://nasa-pds.github.io/registry/>`_, see :ref:`ops Namespace` for details.

application/kvp+xml
application/kvp+json

~~~~~~~~~~~~~~~~~~~~~

This format is useful when one only need a few fields from the metadata.
Expand Down

0 comments on commit a7e4898

Please sign in to comment.