JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Filtering included resources

Ouverte
#314 4 commentaires 9 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Ruby
Étoiles
2.3k
Forks
546
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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?

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par les exemples de UserResource, SockResource et ShoeResource et vérifiez comment les paramètres de requête include et filter présentés sont actuellement interprétés. Déterminez si le filtrage des ressources incluses est pris en charge ; le travail est considéré comme terminé lorsqu’un comportement pris en charge et documenté avec une couverture est disponible, ou lorsqu’il est clairement établi qu’une approche personnalisée est nécessaire.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
rails, ruby
Domaine
api, backend
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.