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

Aperta Adatta ai principianti
#141 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
85/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
openapi, typescript
Ambito
api

Direzione di ricerca

Inizia da apps/api/src/modules/audit/interface/audit.controller.ts, in corrispondenza di exportAuditEvents, e aggiungi l’header di risposta documentato a @ApiOkResponse. Poi esegui pnpm gen:openapi && pnpm gen:api-client; verifica che l’header compaia in apps/api/openapi.json e che i file del client generati siano aggiornati. Il lavoro è terminato quando pnpm lint e i test dell’API passano.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
2
Fork
1
Merge medio
7h 17m
PR unite (30g)
197

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di shipkeepdev/shipkeep

Tutte le issue di shipkeepdev/shipkeep

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.