Open shanike opened 5 months ago
Hi! In my project, I expect ApiProperty#Summary and ApiProperty#Description to start with an upper-cased letter.
ApiProperty#Summary
ApiProperty#Description
PASSES:
@ApiOperation({ summary: "Clears the access-token cookie", // <<<<<<------------------------- c (upper case) }) @Post("logout") postLogout(@Res() res: Response) { // ... }
FAILES:
@ApiOperation({ summary: "clears the access-token cookie", // <<<<<<------------------------- C (lower case) }) @Post("logout") postLogout(@Res() res: Response) { // ... }
this could be a good first rule for someone! isUpper() or regex is a pretty easy check
Hi! In my project, I expect
ApiProperty#Summary
andApiProperty#Description
to start with an upper-cased letter.Example:
PASSES:
FAILES: