Skip to content

[P3] Add Swagger decorators to DonationsController #1164

Description

@cyber-punk112

Description

src/donations/donations.controller.ts has no @ApiTags, @ApiOperation, @ApiOkResponse or @ApiQuery decorators at all, unlike PoolsController and AuthController which are fully documented. main.ts's Swagger DocumentBuilder also doesn't addTag('donations', ...), so both of DonationsController's endpoints (GET /pools/:id/donations, GET /users/me/donations) show up undocumented (or under a default group) in /api-docs.

Deliverables

  • Add @ApiTags('donations') to DonationsController and .addTag('donations', ...) in main.ts's DocumentBuilder
  • Add @ApiOperation/@ApiOkResponse/@ApiQuery decorators to findByPool and findMyDonations
  • npm run build passes

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    MediumbackendNestJS server workdocumentationImprovements or additions to documentationgood first issueGood for newcomersphase-2Phase 2 beginner-friendly backlog: cleanup, tests, docs, polish

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions