Verify and document archived v4 REST limit endpoint semantics

オープン 初心者向け
#770 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 4 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
半日
初心者へのやさしさ
68/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
領域
documentation

調査の方向性

reference_versioned_docs/version-v4/rest/querying.md の 158-165 行付近にあるアーカイブ済みセクションから始め、次にサポートされているリリース済み v4 ソースを正確なタグまたはコミットで特定します。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時間
マージ済み PR(30日)
48

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

HarperFast/documentation のほかの issue

HarperFast/documentation の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。