API filtering

[RedTn]

Currently for restaurants, the API needs to be able to support server-side filtering query parameters.

My proposal for the params:

• ?page[offset] => the page offset
• ?page[limit] => the limit of items returned per page
• ?sort => what column to sort on
• ?desc => sort descending, if this param isnt specified then sort asc

Sample query:

http://asktoni.com/restaurants?page[offset]=1&page[limit]=20&sort=name&desc

[jrhender]

Thanks for creating the issue Redmond, I think this should be a top priority.
Why the page[offset] and page[limit] syntax? Is meant to imply some kind of indexing inside of a page data struc? Or is it equivalent to pageOffset and pageLimit?

[RedTn]

http://jsonapi.org/format/#fetching-pagination
Suggestion from JSON API format. It's equivalent to what you mentioned.

[jrhender]

Ok, sounds good, thanks. I propose that go with:
?pageOffset => the page offset
?pageLimit => the limit of items returned per page
to avoid any possible encoding issues https://stackoverflow.com/questions/40568/are-square-brackets-permitted-in-urls, though it's probably not a big deal

[jrhender]

@wfengk , it looks like you started an "api_filtering" branch already to work on this. Do you want any help with this? Is there somewhere logical for me to hop in and contribute on this filtering stuff?