Verify and document archived v4 REST limit endpoint semantics

Abierto Apto para principiantes
#770 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 4 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
Medio día
Aptitud para principiantes
68/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo

Línea de trabajo

Comienza por la sección archivada en reference_versioned_docs/version-v4/rest/querying.md alrededor de las líneas 158-165, luego localiza la fuente v4 publicada y soportada en una etiqueta o commit exactos. Verifica si limit(10,30) devuelve un extremo exclusivo o un recuento de resultados, usando una comprobación de ejecución específica solo si la fuente no es concluyente. Terminado cuando la referencia archivada aclare explícitamente tanto limit(end) como limit(start,end) con un rango devuelto indicado y un número máximo de resultados.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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)

Lenguaje dominante
MDX
Estrellas
9
Forks
9
Merge medio
5 d 5 h
PR fusionados (30 d)
48

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de HarperFast/documentation

Todos los issues de HarperFast/documentation

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.