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

Document REST API filtering with Ransack #4128

Merged
merged 7 commits into from Jul 7, 2021
Merged

Document REST API filtering with Ransack #4128

merged 7 commits into from Jul 7, 2021

Commits on Jul 6, 2021

  1. Add specs for filtering payments using a parameter

    @kennyadsl
    kennyadsl committed Jul 6, 2021
    Copy the full SHA
    ad9e642 View commit details
    Browse the repository at this point in the history

  2. Refactor credit cards api request specs for clarity 

    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.
    @kennyadsl
    kennyadsl committed Jul 6, 2021
    Copy the full SHA
    6e5a044 View commit details
    Browse the repository at this point in the history

  3. Add specs for filtering credit cards using a parameter

    @kennyadsl
    kennyadsl committed Jul 6, 2021
    Copy the full SHA
    b0a6184 View commit details
    Browse the repository at this point in the history

  4. Add documentation for filtering record via API calls params 

    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.
    @kennyadsl
    kennyadsl committed Jul 6, 2021
    Copy the full SHA
    33fe5dc View commit details
    Browse the repository at this point in the history

  5. Add specs for filtering in taxons/products endpoint 

    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.
    @kennyadsl
    kennyadsl committed Jul 6, 2021
    Copy the full SHA
    31607ca View commit details
    Browse the repository at this point in the history

  6. Document simple query param for taxons/products

    @kennyadsl
    kennyadsl committed Jul 6, 2021
    Copy the full SHA
    a383a6b View commit details
    Browse the repository at this point in the history

  7. Add a paragraph that describes how to filter products via API 

    Into the top level "wiki-style" REST API documentation section.
    @kennyadsl
    kennyadsl committed Jul 6, 2021
    Copy the full SHA
    0472760 View commit details
    Browse the repository at this point in the history