JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Feature Request: built in support for non where/in filtering

Offen
#125 1 Kommentar 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Type: Enhancement
Vorherrschende Sprache
Ruby
Sterne
2.3k
Forks
546
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Out of the box, JR takes this:

GET /users?filter[first_name]=Yehuda

and turns it into the equivalent of this:

User.where(:first_name => ["Yehuda"])

Although JSON API spec is agnostic about filter implementation, I propose introducing some naming patterns for "starts with", "ends with", "contains", and "not in" type attribute filters.

Examples

Get all users with a first_name that starts with "ye":

GET /users?filter[first_name^]=ye

Get all users with a first_name that ends with "huda":

GET /users?filter[first_name$]=huda

Get all users with a first_name that contains "hud":

GET /users?filter[first_name~]=hud

Get all users with a first_name that is NOT "Yehuda":

GET /users?filter[first_name!]=Yehuda

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Verfolge die bestehende Verarbeitung von GET /users?filter[first_name] bis zur Umwandlung in User.where. Überprüfe, wie Filternamen und -werte geparst werden, und ermittle anschließend das erwartete Verhalten für Starts-with-, Ends-with-, Contains- und Not-equal-Filter. Erledigt ist die Aufgabe, wenn die vier vorgeschlagenen Abfrageformen mit entsprechender Abdeckung unterstützt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
rails, ruby
Bereich
api, backend
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.