Check the relationship-condition examples against the paired core fixture

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

Les mainteneurs répondent en général sous 4 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
25/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Active
Stack technique
javascript

Piste de recherche

Start with scripts/nested-relationship-examples.test.mjs and the two sections it already checks in reference/rest/querying.md and reference/resources/resource-api.md, then find the relationship-condition examples in Conditions on a To-Many Relationship and Conditions on a to-many relationship. The fix spans two repos: add cases to integrationTests/resources/nested-relationship-docs/examples.json in harper, then widen the harness slices here. Done means the new http and javascript blocks run against the fixture and the offline fixture copy is updated.

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

Description

content

What

scripts/nested-relationship-examples.test.mjs checks only the six REST examples in Filtering and Paging Each Relationship (reference/rest/querying.md) and the two programmatic examples in Constraining related records (reference/resources/resource-api.md) against the paired fixture in integrationTests/resources/nested-relationship-docs/ in harper.

The relationship-condition examples for Make each relationship condition existential, and add relationship[...] for conditions one related record must meet sit outside those sections. They are documented in Conditions on a To-Many Relationship (REST) and Conditions on a to-many relationship (Resource API). So CI stays green if they drift from core. The same is true of the OR example in the Resource API's Join behavior text.

Why it matters

The previous revision of these docs described a rule that never shipped. Its replacement was verified by hand against a harper build. Nothing re-checks it.

Shape of the fix

  1. In harper: add the cases to integrationTests/resources/nested-relationship-docs/examples.json, along with any schema or resources.js additions the examples need. The nesting examples use a synthetic Company/Department/Employee schema. Make the core HTTP suite execute them. #3927's nested-relationship-docs.test.ts already runs most of the Brand/Product cases inline.
  2. Here: widen the harness slices, or add a second slice, so the new http/javascript blocks are compared with the fixture. Then update the offline fixture copy.

Review-Deferral: dd4ed967d291421c severity=nit category=test-coverage

Langage dominant
MDX
Étoiles
9
Forks
9
Merge moyen
5 j 5 h
PR mergées (30 j)
48

Préparer son environnement

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 HarperFast/documentation

Toutes les issues de HarperFast/documentation

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

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