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

Open Beginner friendly
  • Is something wrong?
#141 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
85/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
openapi, typescript
Domain
api

Research direction

Start in apps/api/src/modules/audit/interface/audit.controller.ts at exportAuditEvents and add the documented response header to its @ApiOkResponse. Then run pnpm gen:openapi && pnpm gen:api-client; confirm the header appears in apps/api/openapi.json and the generated client files are updated. Done means pnpm lint and the API tests pass.

Written by the indexing model from the issue text.

Description

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.

Dominant language
TypeScript
Stars
2
Forks
1
Avg merge
7h 17m
Merged PRs (30d)
197

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from shipkeepdev/shipkeep

All issues in shipkeepdev/shipkeep

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.