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

Encourage use of de-facto standards for query string values #4

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

Encourage use of de-facto standards for query string values #4

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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ $ curl http://api.example.com/v1/reviews/269

## Query, Sorting and Pagination

- Query parameters with the same name but multiple values should be logically OR and be comma-separated under the same key in order to keep the URL compact.
e.g. _show only reviews from German or Spanish wines_: `http://api.example.com/v1/reviews?countries=germany,spain`
- Query parameters with the same name but multiple values should be logically OR and be sent as multiple query values ([as-per the widely-supported, de-facto standard](https://stackoverflow.com/a/24728298)) so clients don't have to build strings and servers don't have to write code to parse them
e.g. _show only reviews from German or Spanish wines_: `http://api.example.com/v1/reviews?countries=germany&countries=spain`.
- Free text search should be accomplished by passing a `q` parameter containing the url encoded string to be searched.
e.g. _show only reviews that mention "acidity"_ `http://api.example.com/v1/reviews?q=acidity`
- Prefer the use of cursoring over pagination, unless there is a valid reason to do so
Expand Down