Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Aliased Attribute Names Are Not Used In Error Responses

Ouverte
  • Quelque chose ne va pas ?
#1,447 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
38/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
rails, ruby
Domaine
api, backend

Piste de recherche

Aucun fichier d’implémentation ni test n’est nommé. Reproduisez le cas délégué attribute :active, delegate: :status_is_active et suivez la manière dont les erreurs de validation sont sérialisées ; le travail est terminé lorsque le détail de l’erreur et le pointeur source de JSON:API utilisent tous deux active au lieu de status_is_active.

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

Description

This issue is a (choose one):

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

Checklist before submitting:

  • [ X] 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.
  • [ X] The feature I'm asking for is compliant with the JSON:API spec.

Description

I have a model with an attribute named status_is_active. In the API we want this to render as active so do the following in the resource:

attribute :active, delegate: :status_is_active

If there is an API error related to this attribute, the error reports the name from the model rather than the name from the resource. For example:

{
  "errors": [
    {
      "title": "is not included in the list",
      "detail": "status_is_active - is not included in the list",
      "code": "100",
      "source": {
          "pointer": "/data/attributes/status_is_active"
      },
      "status": "422"
    }
  ]
}

Expected: the error uses the name of the attribute in the resource rather than the name used in the model. For example:

{
  "errors": [
    {
      "title": "is not included in the list",
      "detail": "active - is not included in the list",
      "code": "100",
      "source": {
          "pointer": "/data/attributes/active"
      },
      "status": "422"
    }
  ]
}

Rationale: users of the API only know about what's in the API - returning a value from the model that is aliased in the API is confusing/wrong.

Thanks!

Langage dominant
Ruby
Étoiles
2.3k
Forks
547
Aucune PR mergée en 30 j

Préparer son environnement

  • Aucun Dockerfile ni fichier Docker Compose
  • Propose un modèle de pull request
  • Aucun guide de contribution

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.

Autres issues de JSONAPI-Resources/jsonapi-resources

Toutes les issues de JSONAPI-Resources/jsonapi-resources

Issues similaires

Plus d'issues Ruby

Recevez les nouvelles issues par e-mail

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