Check the relationship-condition examples against the paired core fixture

Aberta
#781 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 4 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
25/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
javascript

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
MDX
Estrelas
9
Forks
9
Merge médio
5d 5h
PRs com merge (30d)
48

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de HarperFast/documentation

Todas as issues de HarperFast/documentation

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.