JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Issue with `fields` request params

Ouverte
#282 7 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

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

Description

As I'm playing with the Sparse Fieldsets, I encountered some issues.

With the following resources:

class UserResource < JSONAPI::Resource
  has_one :status, class_name: 'UserStatus'
  attributes :name, :email
end
class UserStatusResource < JSONAPI::Resource
  has_one :user
  attributes :foo, :bar
end

Relationships are removed from then response when using fields, so we can't link a user to his status.

/users?include=status&fields[users]=name

Association with custom class_name failed with fields.

/users?include=status&fields[users]=name&fields[user-statuses]=foo

returns:

{:errors=>
  [{:title=>"Invalid resource",
    :detail=>"user-statuses is not a valid resource.",
    :id=>nil,
    :href=>nil,
    :code=>101,
    :path=>nil,
    :links=>nil,
    :status=>"bad_request"},
   {:title=>"Invalid resource",
    :detail=>"user-statuses is not a valid resource.",
    :id=>nil,
    :href=>nil,
    :code=>101,
    :path=>nil,
    :links=>nil,
    :status=>"bad_request"}]}

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 et UserStatusResource et reproduisez les deux requêtes en utilisant include=status et les paramètres fields. Suivez la gestion des sparse fieldsets pour les relations et de la clé de ressource personnalisée class_name. C'est terminé lorsque la relation reste pouvant être liée et que user-statuses est accepté sans les erreurs de ressource invalide signalées.

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

Évaluation

Stack technique
ruby
Domaine
api
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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