Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Rule Suggestion: Swagger Capitalized Summery/Description #179

Open
shanike opened this issue May 28, 2024 · 1 comment
Open

New Rule Suggestion: Swagger Capitalized Summery/Description #179

shanike opened this issue May 28, 2024 · 1 comment

Comments

@shanike
Copy link

shanike commented May 28, 2024

Hi! In my project, I expect ApiProperty#Summary and ApiProperty#Description to start with an upper-cased letter.

Example:

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) {
  // ...
  }
@darraghoriordan
Copy link
Owner

darraghoriordan commented Jun 13, 2024

this could be a good first rule for someone! isUpper() or regex is a pretty easy check

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

No branches or pull requests

2 participants