Verify and document archived v4 REST limit endpoint semantics

Offen Anfängerfreundlich
#770 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 4 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
Ein halber Tag
Anfängerfreundlichkeit
68/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Bereich
documentation

Rechercherichtung

Beginne mit dem archivierten Abschnitt in reference_versioned_docs/version-v4/rest/querying.md um die Zeilen 158-165 und lokalisiere dann die unterstützte veröffentlichte v4-Quelle an einem exakten Tag oder Commit. Prüfe, ob limit(10,30) einen exklusiven Endpunkt oder eine Ergebnisanzahl zurückgibt, und nutze eine gezielte Laufzeitprüfung nur, wenn die Quelle nicht eindeutig ist. Erledigt, wenn die archivierte Referenz sowohl limit(end) als auch limit(start,end) ausdrücklich mit einem angegebenen zurückgegebenen Bereich und einer maximalen Ergebnisanzahl klärt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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)

Vorherrschende Sprache
MDX
Sterne
9
Forks
9
Ø Merge
5 T. 5 Std.
Gemergte PRs (30 T.)
48

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus HarperFast/documentation

Alle Issues in HarperFast/documentation

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.