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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#141 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
85/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
openapi, typescript
Lĩnh vực
api

Hướng nghiên cứu

Bắt đầu tại apps/api/src/modules/audit/interface/audit.controller.ts, ở exportAuditEvents, và thêm header phản hồi đã được mô tả vào @ApiOkResponse. Sau đó chạy pnpm gen:openapi && pnpm gen:api-client; xác nhận header xuất hiện trong apps/api/openapi.json và các tệp client được tạo đã được cập nhật. Hoàn tất khi pnpm lint và các bài kiểm thử API đều chạy thành công.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
TypeScript
Star
2
Fork
1
Merge trung bình
7 giờ 17 phút
Pull request đã merge (30 ngày)
197

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của shipkeepdev/shipkeep

Tất cả issue của shipkeepdev/shipkeep

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.