Verify and document archived v4 REST limit endpoint semantics

Aperta Adatta ai principianti
#770 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 4 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
Mezza giornata
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Ambito
documentation

Direzione di ricerca

Inizia dalla sezione archiviata in reference_versioned_docs/version-v4/rest/querying.md intorno alle righe 158-165, poi individua la fonte v4 pubblicata e supportata a un tag o commit esatti. Verifica se limit(10,30) restituisce un endpoint esclusivo o un conteggio dei risultati, usando un controllo di runtime mirato solo se la fonte non è conclusiva. Fatto quando il riferimento archiviato chiarisce esplicitamente sia limit(end) sia limit(start,end) con un intervallo restituito dichiarato e un numero massimo di risultati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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)

Lingua principale
MDX
Stelle
9
Fork
9
Merge medio
5g 5h
PR unite (30g)
48

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di HarperFast/documentation

Tutte le issue di HarperFast/documentation

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.