JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Allow value with comma to be parsed as single value

Open
#1,153 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
2.3k
Forks
546
PR merge metrics
No merged PRs in 30d

Description

This issue is a (choose one):

  • Problem/bug report.
  • Feature request.
  • Request for support. Note: Please try to avoid submitting issues for support requests. Use Gitter instead.

Checklist before submitting:

  • I've searched for an existing issue.
  • I've asked my question on Gitter and have not received a satisfactory answer.
  • I've included a complete bug report template. This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project.
  • The feature I'm asking for is compliant with the JSON:API spec.

Description

Create a setting that can be set per resource to disable to automatic parsing of a string with commas into a split array.

Features:

Sometimes, it is a requirement in an API to search by a longer form text field that includes a comma. Currently, when that happens the filter values are translated into an ARRAY whose count is greater then 1 .

Using that array in ActiveRecord causes a WHERE field IN () query to be generated instead of a WHERE field = '' query.

This feature would allow you to override that behavior on a per resource basis

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the filter-value parsing entry point and the per-resource configuration mechanism, then reproduce the comma-containing filter against ActiveRecord. Done means a resource can preserve a comma-containing value as one value when configured, while the existing splitting behavior remains unchanged by default.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.