loopbackio / loopbackio/loopback-next

Polymorphic Relation - Wrong Doc

Ouverte
#8,667 4 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

bug Docs
Langage dominant
TypeScript
Étoiles
5.1k
Forks
1.1k
Merge moyen
2 j 21 h
PR mergées (30 j)
27

Description

Describe the bug

Hi there!

Let's suppose a base Delivery model with 3 fields: id, deliverableType, and deliverableId.
If you follow the docs, you'll get this error when requesting some deliverable relations:

Request GET /deliveries?filter=whatever failed with status code 500. Error: ER_BAD_FIELD_ERROR: Unknown column 'deliverable' in 'field list'

This is caused by this part of code, as you're asking it to search on the corresponding datasource for the field "deliverable" which doesn't exist:

class Delivery extends Entity {
@hasOne(() => Deliverable, {polymorphic: true})
  deliverable: Deliverable;

deliverableType: string;
}

Instead, it should be like this (search deliverableId on deliverableType's model):

class Delivery extends Entity {
@hasOne(() => Deliverable, {polymorphic: true})
  deliverableId: string;

deliverableType: string;
id: string;
}

With that change, polymorphic relation is working as expected (assuming repositories are correctly configured)

Logs

No response

Additional information

No response

Reproduction

Not needed

Guide de contribution

Ouvrir le 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.

Piste de recherche

Commencez par la documentation de Polymorphic relation à l’adresse https://loopback.io/doc/en/lb4/Polymorphic-relation.html et comparez son exemple Delivery avec les champs signalés dans l’issue. Mettez à jour l’exemple afin que la relation utilise deliverableId et deliverableType, puis vérifiez que l’exemple documenté ne demande plus le champ inexistant deliverable.

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

Évaluation

Stack technique
typescript
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

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