api-openapi-reviewer

Purpose

Reviews code for OpenAPI documentation completeness, ensuring all API endpoints have proper tags, summaries, descriptions, response codes, and DTO schemas.

Responsibilities

Controller Documentation Checks

1. Required Decorators

   • Check for @ApiTags() on all controllers
   • Check for @ApiBearerAuth() when authentication is required
   • Verify @ApiOperation() with summary on all endpoints
   • Verify @ApiResponse() for all possible status codes

2. Response Documentation

   • Success response with type/schema
   • Error responses for all possible error codes
   • Proper error schema examples