danielgtaylor / danielgtaylor/openapi-cli-generator

Links Support

Abierto
#4 0 comentarios 0 reacciones 0 asignados Ver en GitHub
feature help-wanted
Lenguaje dominante
Go
Estrellas
218
Forks
54
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Add the ability to follow [OpenAPI 3 links](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#linkObject) to fetch additional data and add it to the response for a given operation. For example, you might get an item overview with a link to get item details. A new CLI option like `--link=details` could then be used to trigger the additional request and put a `details` field into the response with the response data from the details call. All of this would happen before response filtering/projection so you can select just the fields you care about.

Bonus: support an extension like `x-collection` so this works for calls that return a list of items, so that you can get the link for each item in the list by treating index 0 as a wildcard in the body pointer.

Guía de contribución

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

Línea de trabajo

Comienza leyendo la especificación de OpenAPI 3 Link Object enlazada en la issue y, a continuación, sigue los puntos de entrada del manejo de opciones de CLI, del flujo de solicitudes adicionales y del filtrado o la proyección de respuestas. Se considera terminado cuando un enlace con nombre como `details` puede activar una solicitud de seguimiento y añadir su respuesta antes de la proyección; el comportamiento opcional de `x-collection` debería manejar los elementos de una lista mediante el comodín index-0 propuesto.

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
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.