Document REST API filtering with Ransack #4128
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It was very hard to follow what was happening before this change. Now the same nomenclature has been used to match cards and users' roles.
In almost all our GET / endpoints (index action), we have the built-in capability of filtering records using Ransack appending the `?q[attribute_eq]=value` string. This change documents that possibility for all the enpoints where this is available.
It also adds basic specs to this endpoint since it was also having a spec related to caching, probably a regression of some problem from the past.
Into the top level "wiki-style" REST API documentation section.
kennyadsl
force-pushed
the
kennyadsl/document-rest-api-q-param
branch
from
a139faf to
0472760
Compare
jarednorman
approved these changes
Jul 6, 2021
spaghetticode
approved these changes
Jul 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Most endpoints of our REST API that return a collection (Eg.
GET /products) also have the ability to filter data using query params.How does it work?
This works taking advantage of the search filters provided by Ransack.
For example, if we want to retrieve only products that contain the word "Watch" in their title we can make the following request:
The
name_contmatcher will generate a query usingLIKEto retrieve all the products that contain the value specified. For an extensive list of search matchers supported, please refer to the Ransack documentation.This PR:
Checklist: