danielgtaylor / danielgtaylor/openapi-cli-generator

Handle Pagination

Abierto
#9 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

feature help-wanted need-info
Lenguaje dominante
Go
Estrellas
218
Forks
54
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

For APIs with paginated responses, the cli package should include utilities for handling the response and fetching subsequent pages automatically up to some limit.

For example, the GitHub API v3 uses Link headers with hypermedia relations to provide pagination.

In general there seem to be three models in use:

  1. Passing a page size and page number to get items. Maybe also some way to get a total page count.
  2. Passing an iterator value to get the next set of items. When no iterator is (or no items are) returned you are done.
  3. Using link relations to provide full URLs to fetch more items.

There should be a new OpenAPI extension to hint to the CLI which of these cases it is, how to handle it (e.g. parameter names), and whether to fetch all or expose limits via parameters in the CLI.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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.

Línea de trabajo

No se nombran archivos, pruebas ni puntos de entrada. Empieza por localizar el manejo de respuestas de la API y el flujo de comandos generados del paquete cli; después, compara los tres modelos de paginación y determina la extensión de OpenAPI y los límites necesarios. Se considera terminado cuando la paginación se gestiona de forma coherente según el modelo declarado y está cubierta por pruebas adecuadas.

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

Evaluación

Stack tecnológico
go, openapi
Área
api, cli
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.