Declare the X-Shipkeep-Truncated header of the audit export in OpenAPI
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Anfängerfreundlichkeit
- 85/100
- Issue-Typ
- Feature
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- openapi, typescript
- Bereich
- api
Rechercherichtung
Beginne in apps/api/src/modules/audit/interface/audit.controller.ts bei exportAuditEvents und füge den dokumentierten Response-Header zu @ApiOkResponse hinzu. Führe dann pnpm gen:openapi && pnpm gen:api-client aus; bestätige, dass der Header in apps/api/openapi.json erscheint und die generierten Client-Dateien aktualisiert wurden. Fertig ist die Arbeit, wenn pnpm lint und die API-Tests erfolgreich sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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
@ApiOkResponseofexportAuditEventsinapps/api/src/modules/audit/interface/audit.controller.ts. - Run
pnpm gen:openapi && pnpm gen:api-clientand commit the regenerated files.
Acceptance
pnpm lint and the API tests pass, and the header appears in openapi.json.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 2
- Forks
- 1
- Ø Merge
- 7 Std. 17 Min.
- Gemergte PRs (30 T.)
- 197
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus shipkeepdev/shipkeep
-
good first issue
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
shipkeepdev/shipkeep#295 ·
Maintainer antworten meist innerhalb von 1 Tag
-
good first issue priority:P2 track:control-plane
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
shipkeepdev/shipkeep#212 ·
Maintainer antworten meist innerhalb von 1 Tag
-
enhancement good first issue priority:P3 track:web
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
shipkeepdev/shipkeep#144 ·
Maintainer antworten meist innerhalb von 1 Tag
-
documentation good first issue priority:P3 track:control-plane
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
shipkeepdev/shipkeep#143 ·
Maintainer antworten meist innerhalb von 1 Tag
-
enhancement good first issue priority:P3 track:control-plane
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
shipkeepdev/shipkeep#142 ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in shipkeepdev/shipkeep
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
vercel-labs/ui#540 ·
Maintainer antworten meist innerhalb von 1 Tag
-
accepted ai-dev ai-implementing
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 74/100
livesport/homer#218 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
normalizePropName strips `#` characters from Figma property names instead of only the `#id` suffixOffen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
figma/code-connect#419 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
-
Negative values skip k/M abbreviation and medium decimal format on line, stacked-area, and tooltipOffen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
britecharts/britecharts#1255 ·
Maintainer antworten meist innerhalb von 1 Tag