chore(api): name MessageDto as a component in the OpenAPI spec #365

New issue

Closed

opened 2026-06-29 13:19:27 +00:00 by james · 0 comments

james commented

2026-06-29 13:19:27 +00:00

Owner

MessageDto is used by ConversationDetailDto.messages[] and TurnResponseDto.messages[] but is inlined in the generated OpenAPI types rather than registered as a named components.schemas.MessageDto (its zod schema never gets .openapi("MessageDto")).

Consequence: downstream consumers can't reference components["schemas"]["MessageDto"] directly and instead derive it from TurnResponseDto["messages"][number] — see packages/api-client/src/agent-stream.ts (#344) and the activity/chat code.

Scope

Register zMessageDto as a named component (.openapi("MessageDto")) in apps/api/lib/api/openapi-routes.ts so it appears under components.schemas.
Regenerate openapi.json + the @carol/api-client types (both drift gates).
Optionally simplify the TurnResponseDto["messages"][number] derivations to the now-named MessageDto.

Small, low-risk cleanup. Part of epic #47.

`MessageDto` is used by `ConversationDetailDto.messages[]` and `TurnResponseDto.messages[]` but is **inlined** in the generated OpenAPI types rather than registered as a named `components.schemas.MessageDto` (its zod schema never gets `.openapi("MessageDto")`). Consequence: downstream consumers can't reference `components["schemas"]["MessageDto"]` directly and instead derive it from `TurnResponseDto["messages"][number]` — see `packages/api-client/src/agent-stream.ts` (#344) and the activity/chat code. ## Scope - Register `zMessageDto` as a named component (`.openapi("MessageDto")`) in `apps/api/lib/api/openapi-routes.ts` so it appears under `components.schemas`. - Regenerate `openapi.json` + the `@carol/api-client` types (both drift gates). - Optionally simplify the `TurnResponseDto["messages"][number]` derivations to the now-named `MessageDto`. Small, low-risk cleanup. Part of epic #47.

james referenced this issue from a commit

2026-06-29 13:41:40 +00:00

chore(api): register MessageDto as a named OpenAPI component (#365)

james referenced this issue from a pull request that will close it,

2026-06-29 13:41:54 +00:00

chore(api): register MessageDto as a named OpenAPI component (#365) #368

james closed this issue

2026-06-29 13:53:24 +00:00

james referenced this issue from a commit

2026-06-29 13:53:24 +00:00

Merge pull request 'chore(api): register MessageDto as a named OpenAPI component (#365)' (#368) from 365-name-messagedto-component into main