From 187365aceafb4519d8ea0a011a707d731747463c Mon Sep 17 00:00:00 2001 From: x-m-el <126079676+x-m-el@users.noreply.github.com> Date: Tue, 5 Mar 2024 12:53:57 +0100 Subject: [PATCH] fix doc erros for :or: filter and add warning to not use with :uri: see issue #36 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0acc0ed..1b06176 100644 --- a/README.md +++ b/README.md @@ -880,7 +880,7 @@ This filter can be combined with the other filters to provide very extensive sea Aside from regular text searches, a set of custom filters have been added. These filters are the last component of a search, and are easy to identify as they start with a colon (:). Following is a brief list of filters which exist. This list may be extended over time. -- *:uri:* Search for the URL of a relationship. +- *:uri:* Search for the URL of a relationship. This does not work correctly inside an `:or:` filter! GET /people?filter[accounts][:uri:]=http://my-application.com/people/42 @@ -902,9 +902,9 @@ Aside from regular text searches, a set of custom filters have been added. Thes - *:has:* The inverse of `:has-no:` forces the relationship to exist. Syntax may be subject to change. -- *:or:* Filters are normally combined using AND, this allows a set of filters to be defined as OR instead. +- *:or:* Filters are normally combined using AND, this allows one set of filters (those used with `:or:`) to be defined as OR instead. - GET /people?filter[:or:][name]=John&[:or:][owner][name]=Jack + GET /people?filter[:or:][name]=John&filter[:or:][owner][name]=Jack #### Including results