Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix doc erros for :or: filter + add warning to not use with :uri: #37

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix doc erros for :or: filter + add warning to not use with :uri: #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down