Verify and document archived v4 REST limit endpoint semantics

未关闭 适合新手
#770 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 4 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
半天
新手友好度
68/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
领域
documentation

调研方向

从 reference_versioned_docs/version-v4/rest/querying.md 中第 158-165 行附近的归档部分开始,然后定位受支持的已发布 v4 源码的确切 tag 或 commit。验证 limit(10,30) 返回的是排他性端点还是结果数量,仅在源码无法得出结论时使用有针对性的运行时检查。当归档参考明确说明 limit(end) 和 limit(start,end) 二者,并给出返回范围和最大结果数时,即完成。

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

描述

content

The archived v4 REST querying reference lists limit(end) and limit(start,end), describes an optional starting offset, and shows limit(10,30). It does not explicitly explain whether the second argument is an exclusive endpoint or a result count, or give the resulting range.

Verify the actual contract against the supported released v4 source, recording the exact tag or commit; use a focused runtime check if the source is inconclusive. Then clarify both forms with an example that states the returned range and maximum number of results. Do not copy current v5 semantics into the archived reference without that historical evidence. The ambiguity is confirmed; the correct v4 behavior has not been verified here.

Found while reviewing Document full-text paging and configurable search limits. Archived v4 changes are outside that current v5.4 full-text update; this tracker covers a separate bounded audit and clarification.

P3, effort Low, type Task: documentation hygiene with no confirmed v4 runtime defect or customer incident; the audit is bounded to one query operator and one archived section. No matching open documentation epic or committed release was found, so parent and milestone are intentionally unset. No customer-specific or security evidence; private fields and defect-origin fields remain unset.

Review-Deferral: 1d2f385dfce65f6b severity=nit category=documentation

Comment generated by kAIle (GPT-6)

主要语言
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 摘要。