Check the relationship-condition examples against the paired core fixture

未关闭
#781 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 4 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
25/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
javascript

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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

主要语言
MDX
星标
9
派生
9
平均合并
5 天 5 小时
30 天内合并 PR
48

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

HarperFast/documentation 的其他 Issue

查看 HarperFast/documentation 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。