Declare the X-Shipkeep-Truncated header of the audit export in OpenAPI

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

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
85/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
openapi, typescript
Área
api

Línea de trabajo

Empieza en apps/api/src/modules/audit/interface/audit.controller.ts, en exportAuditEvents, y añade el encabezado de respuesta documentado a @ApiOkResponse. Luego ejecuta pnpm gen:openapi && pnpm gen:api-client; confirma que el encabezado aparece en apps/api/openapi.json y que los archivos del cliente generados se han actualizado. El trabajo estará terminado cuando pnpm lint y las pruebas de API pasen.

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

Descripción

documentation good first issue priority:P3 track:control-plane

GET /organizations/{o}/audit-events/export sets X-Shipkeep-Truncated: true|false, but apps/api/openapi.json does not declare it.

Task

  • Add the response header to the @ApiOkResponse of exportAuditEvents in apps/api/src/modules/audit/interface/audit.controller.ts.
  • Run pnpm gen:openapi && pnpm gen:api-client and commit the regenerated files.

Acceptance

pnpm lint and the API tests pass, and the header appears in openapi.json.

Lenguaje dominante
TypeScript
Estrellas
2
Forks
1
Merge medio
7 h 17 min
PR fusionados (30 d)
197

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 shipkeepdev/shipkeep

Todos los issues de shipkeepdev/shipkeep

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.