Document cursor pagination and capped totals - #293
Open
javorosas wants to merge 4 commits into
Open
Conversation
- Add pagination guide (ES/EN) covering pagination=page|cursor, after/before navigation, totals capped at 3,000 and totals_are_capped. - Add shared SearchPagination/SearchAfter/SearchBefore parameters to search endpoints in both OpenAPI specs. - Extend SearchResult schema with previous_cursor, next_cursor and totals_are_capped. - Add CHANGELOG entry for the opt-in cursor pagination.
…ability Both pagination modes cap the total count at 3,000, so cursor is not faster because it avoids exact counts. Reframe the recommendation around reach (page caps at 3,000 results / 30 pages) and stable position-based pages.
Align the guide and OpenAPI SearchResult with perf #2206: a cursor search only includes total_results/totals_are_capped on the first page (no after/before); later pages return data and cursors only.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Contexto
Prepara la documentación para anunciar el soporte opt-in de
pagination=cursor(ya mergeado en la API) y el capping de totales a 3,000 (
totals_are_capped),incluyendo la política de paginación por páginas (máximo 30 páginas). La doc se
escribe como si la política completa ya estuviera vigente; el correo de anuncio
definirá la fecha de aplicación.
Cambios
docs/guides/pagination.mdx, ES + EN):pagination=pagevspagination=cursor(cursor recomendado para listas grandes).pagination,limit,page,after,beforey sus combinaciones válidas.previous_cursor,next_cursor,total_results,totals_are_capped).openapi_v2.yamlyopenapi_v2.en.yaml):SearchPagination,SearchAfter,SearchBeforeencomponents.parameters.$refa esos parámetros en los 19 endpoints de búsqueda (catálogos, customers, invoices, organizations, products, receipts, retentions).previous_cursor,next_cursorytotals_are_cappeden el schema compartidoSearchResult.Validación
$refnuevos quedan dentro de listasparameters(0 fugas ensecurity).git diff --checksin errores.