Repository navigation
[W1 — do not merge] API contract v1 - #1
Merged
Merged
Conversation
Trivy flags body-parser < 2.4.0 / 1.20.9 (CVE-2026-111181) and multer < 2.5.0 (CVE-2026-113872). @nestjs/platform-express pins multer exact, so it needs a pnpm override until Nest bumps it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- GET /tags/:tagId/events: was raw eventTag rows ({eventId, tagId, event});
now PageParams + paginate() → {data, meta} of EventWithCountResponseDto,
via EventService.getEventsByClient with tagId (same as GET /events?tagId=).
- Webhook deliveries (/admin/webhooks/deliveries,
/admin/clients/:id/webhook-deliveries): was take: 100; now
WebhookDeliveriesQueryDto (PageParams + validated status enum) + paginate().
- Drop TaggedEventDto / TagEventResponseDto.
- Commit generated openapi.json for @heyatom/client.
BREAKING CHANGE: both lists now answer {data, meta}; W1 of plan 02, merge
only at the W4 cutover.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Gatherly part of wave W1, plan
docs/platform/plans/02-api-contract-cutover.md. Do not merge — merged only at the W4 cutover together with fileharbor, articuno and@heyatom/client1.0.0.Changes
GET /tags/:tagId/events: raweventTagrows[{ eventId, tagId, event: {…, translations} }]→ paginated{ data: EventWithCountResponseDto[], meta }(page/limit), same DTO and ordering asGET /events?tagId=(reusesEventService.getEventsByClient).GET /admin/webhooks/deliveriesandGET /admin/clients/:id/webhook-deliveries:{ data: WebhookDelivery[] }capped at 100 →{ data, meta }withpage/limit;statusnow validated against the enum (invalid → 400 instead of a Prisma error).TaggedEventDto/TagEventResponseDtoremoved.@heyatom/nest-common0.4.0 (a7a2659 on develop), no localapi-data.tsleft.openapi.jsongenerated withpnpm openapi:dumpand committed (first time).OpenAPI diff vs develop
Only those three paths change:
page/limitquery params,meta: PageMetaDtoin the response. The admin deliveriesstatusquery param goes from (wrongly) required to optional with its enum. SchemasTagEventResponseDtoandTaggedEventDtoremoved. Nothing else.Checks
pnpm build,pnpm lint, unit specs (clients/admin/events),pnpm test:e2epass.🤖 Generated with Claude Code