Area: Developer Experience
Priority: P2 — Medium
Description
The current Swagger schema shows types but lacks realistic examples. Developers consuming the API need working examples to understand request shapes. Add @ApiProperty({ example }) decorators with realistic values.
Acceptance Criteria
Technical Notes
- Use OpenAPI
example field for primitives
- Use
examples (object) for multiple scenarios per field
- Keep examples aligned with seeded test data
Description
The current Swagger schema shows types but lacks realistic examples. Developers consuming the API need working examples to understand request shapes. Add
@ApiProperty({ example })decorators with realistic values.Acceptance Criteria
GABC123..., amount: 25.5, valid dates)@ApiOkResponsewith example payload@ApiBadRequestResponse,@ApiUnauthorizedResponse,@ApiNotFoundResponse,@ApiTooManyRequestsResponsewith example payloads/api/docsdocs/SWAGGER.mdTechnical Notes
examplefield for primitivesexamples(object) for multiple scenarios per field