Skip to content

Commit

Permalink
Adding a sentence on support of subset of filter operators for option…
Browse files Browse the repository at this point in the history
…ally queryable properties.
  • Loading branch information
merkys committed Dec 4, 2019
1 parent 947a0b6 commit 502bd44
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions optimade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1083,6 +1083,7 @@ The filter expression allows desired properties to be compared against search va

Only those properties marked as REQUIRED in section `Entry list`_ MUST be queryable.
Query support for other properties is OPTIONAL.
If supported, only a subset of filter operators MAY be supported for optionally queryable properties.

When provided as an URL query parameter, the contents of the :query-param:`filter` parameter is URL-encoded by the client in the HTTP GET request, and then URL-decoded by the API implementation before any further parsing takes place.
In particular, this means the client MUST escape special characters in string values as described below for `String values`_ before the URL encoding, and the API implementation MUST first URL-decode the :query-param:`filter` parameter before reversing the escaping of string tokens.
Expand Down

0 comments on commit 502bd44

Please sign in to comment.