Declare the X-Shipkeep-Truncated header of the audit export in OpenAPI
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 新手友好度
- 85/100
- Issue 類型
- 功能
- 描述清晰度
- 描述清楚
- 活躍度
- 活躍
- 技術堆疊
- openapi, typescript
- 領域
- api
研究方向
從 apps/api/src/modules/audit/interface/audit.controller.ts 中的 exportAuditEvents 開始，將文件中說明的回應標頭新增至 @ApiOkResponse。接著執行 pnpm gen:openapi && pnpm gen:api-client；確認標頭出現在 apps/api/openapi.json 中，且產生的用戶端檔案已更新。pnpm lint 和 API 測試通過即表示完成。
由索引模型根據 Issue 內容生成。
描述
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.
- 主要語言
- TypeScript
- 星號
- 2
- 分支
- 1
- 平均合併
- 7 小時 17 分鐘
- 30 天內合併 PR
- 197
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
shipkeepdev/shipkeep 的其他 Issue
-
good first issue
難度 2/5 1-3 小時 新手友好度 84/100
shipkeepdev/shipkeep#295 ·
維護者通常 1 天內回覆
-
good first issue priority:P2 track:control-plane
難度 2/5 1-3 小時 新手友好度 78/100
shipkeepdev/shipkeep#212 ·
維護者通常 1 天內回覆
-
enhancement good first issue priority:P3 track:web
難度 2/5 1-3 小時 新手友好度 85/100
shipkeepdev/shipkeep#144 ·
維護者通常 1 天內回覆
-
documentation good first issue priority:P3 track:control-plane
難度 2/5 1-3 小時 新手友好度 78/100
shipkeepdev/shipkeep#143 ·
維護者通常 1 天內回覆
-
enhancement good first issue priority:P3 track:control-plane
難度 2/5 1-3 小時 新手友好度 85/100
shipkeepdev/shipkeep#142 ·
維護者通常 1 天內回覆
查看 shipkeepdev/shipkeep 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 78/100
vercel-labs/ui#540 ·
維護者通常 1 天內回覆
-
accepted ai-dev ai-implementing
難度 2/5 1-3 小時 新手友好度 74/100
維護者通常 1 天內回覆
-
normalizePropName strips `#` characters from Figma property names instead of only the `#id` suffix未關閉
難度 2/5 1-3 小時 新手友好度 72/100
figma/code-connect#419 ·
-
難度 2/5 1-3 小時 新手友好度 78/100
-
Negative values skip k/M abbreviation and medium decimal format on line, stacked-area, and tooltip未關閉
難度 2/5 1-3 小時 新手友好度 84/100
britecharts/britecharts#1255 ·
維護者通常 1 天內回覆