Problem
Some API endpoints lack detailed OpenAPI/Swagger descriptions, making the API harder to understand for developers.
Solution
Add @ApiOperation, @ApiResponse, and @ApiParam decorators to group-related endpoints.
Files to modify
src/group/group.controller.ts
src/group-member/group-member.controller.ts
Example
@Get(':slug')
@ApiOperation({
summary: 'Get group by slug',
description: 'Retrieves a group by its URL slug. Returns group details including member count and upcoming events.'
})
@ApiParam({ name: 'slug', description: 'URL-friendly group identifier' })
@ApiResponse({ status: 200, description: 'Group found' })
@ApiResponse({ status: 404, description: 'Group not found' })
async findBySlug(@Param('slug') slug: string) {
// ...
}
How to verify
Visit /api/docs after making changes to see updated Swagger documentation.
Acceptance Criteria
Difficulty: Easy - great for learning NestJS patterns
Problem
Some API endpoints lack detailed OpenAPI/Swagger descriptions, making the API harder to understand for developers.
Solution
Add
@ApiOperation,@ApiResponse, and@ApiParamdecorators to group-related endpoints.Files to modify
src/group/group.controller.tssrc/group-member/group-member.controller.tsExample
How to verify
Visit
/api/docsafter making changes to see updated Swagger documentation.Acceptance Criteria
@ApiOperationwith summary and description@ApiParamdecoratorsDifficulty: Easy - great for learning NestJS patterns