JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Filtering included resources

Aperta
#314 4 commenti 9 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Ruby
Stelle
2.3k
Fork
546
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

We have a use-case where it would be useful to apply filters to the included resources.

Dummy example:

class UserResource < JSONAPI::Resource
  has_many :socks
  has_many :shoes
end
class SockResource < JSONAPI::Resource
  has_one :user
  filter :in_use
end
class ShoeResource < JSONAPI::Resource
  has_one :user
  filter :in_use
end

Individually, one can filter the shoes and socks
/shoes?filter[in_use]=true
/socks?filter[in_use]=true

I was wondering if it would be possible to filter the shoes and socks when included with the User?

e.g. To get the user, and the shoes and socks he currently has in use, something like:

/users/1?include=shoes,socks&filter[shoes][in_use]=true&filter[socks][in_use]=true

Is this in the scope of jsonapi-resources? or would it be best to find a custom approach?

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con gli esempi di UserResource, SockResource e ShoeResource e verifica come vengono attualmente interpretati i parametri di query include e filter mostrati. Determina se il filtraggio delle risorse incluse è supportato; il lavoro è completato quando è disponibile un comportamento supportato e documentato con coverage, oppure quando è stata raggiunta la conclusione chiara che è necessario un approccio personalizzato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
rails, ruby
Ambito
api, backend
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.