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
-
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
-
bug
难度 2/5 1-3 小时 新手友好度 70/100
jeanibarz/knowledge-base-mcp-server#1268 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 78/100
Koenkk/zigbee-herdsman-converters#13820 ·
维护者通常 2 天内回复
-
A live recovery copy treats a large whole number and text with the same digits as the same value未关闭bug sharing & sync
难度 2/5 1-3 小时 新手友好度 64/100
维护者通常 1 天内回复