Declare the X-Shipkeep-Truncated header of the audit export in OpenAPI
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 85/100
- Tipo de issue
- Funcionalidade
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Stack de tecnologia
- openapi, typescript
- Domínio
- api
Direção de pesquisa
Comece em apps/api/src/modules/audit/interface/audit.controller.ts, em exportAuditEvents, e adicione o cabeçalho de resposta documentado a @ApiOkResponse. Em seguida, execute pnpm gen:openapi && pnpm gen:api-client; confirme que o cabeçalho aparece em apps/api/openapi.json e que os arquivos do cliente gerados foram atualizados. O trabalho estará concluído quando pnpm lint e os testes da API passarem.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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.
- Linguagem predominante
- TypeScript
- Estrelas
- 2
- Forks
- 1
- Merge médio
- 7h 17min
- PRs com merge (30d)
- 197
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de shipkeepdev/shipkeep
-
good first issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
shipkeepdev/shipkeep#295 ·
Mantenedores costumam responder em até 1 dia
-
good first issue priority:P2 track:control-plane
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
shipkeepdev/shipkeep#212 ·
Mantenedores costumam responder em até 1 dia
-
enhancement good first issue priority:P3 track:web
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
shipkeepdev/shipkeep#144 ·
Mantenedores costumam responder em até 1 dia
-
documentation good first issue priority:P3 track:control-plane
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
shipkeepdev/shipkeep#143 ·
Mantenedores costumam responder em até 1 dia
-
enhancement good first issue priority:P3 track:control-plane
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
shipkeepdev/shipkeep#142 ·
Mantenedores costumam responder em até 1 dia
Todas as issues de shipkeepdev/shipkeep
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
vercel-labs/ui#540 ·
Mantenedores costumam responder em até 1 dia
-
accepted ai-dev ai-implementing
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
livesport/homer#218 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
normalizePropName strips `#` characters from Figma property names instead of only the `#id` suffixAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
figma/code-connect#419 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
-
Negative values skip k/M abbreviation and medium decimal format on line, stacked-area, and tooltipAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
britecharts/britecharts#1255 ·
Mantenedores costumam responder em até 1 dia