Skip to content

Document analytics API endpoints (OpenAPI/Swagger) #565

Description

@phertyameen

Description

Add @nestjs/swagger decorators (@ApiOperation, @ApiResponse, @ApiQuery) to every route in analytics.controller.ts so the module shows up correctly in the app's Swagger docs.

Why this matters

Frontend and integration consumers of the analytics API need discoverable, accurate API documentation instead of reading controller source directly.

Files to touch

  • backend/src/analytics/analytics.controller.ts

Acceptance Criteria

  • Every analytics route has a Swagger operation summary and response schema
  • Query DTOs have @ApiProperty decorators with example values

Notes

This issue is part of the new analytics module effort (tracking, aggregation,
and reporting on player/game activity). Please keep new code inside
backend/src/analytics/ following the same module/controller/service/provider
layout used by existing modules (e.g. progress, streak, quests).

Metadata

Metadata

Assignees

No one assigned

    Labels

    GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26analyticsdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions