Rules Hub
Coding Rules Library
← Back to all rules
Rule priority, scope & exceptions
Use this to align rules with the senior-level structure (P0/P1/P2, scope, exceptions/tradeoffs).
backend ruleP2stack specificStack: NestJS / Swagger
api-docsswaggerconsistencyvalidation
Mark optional query params as optional in API docs
When a request parameter is optional in validation, reflect that in the OpenAPI/Swagger schema (e.g. ApiPropertyOptional) so generated docs match actual behavior.
PR: hegnar-shareholders-ws · org-mining-hist-2026-06Created: Jun 18, 2026
Bad example
Old codetypescript
| 1 | @ApiProperty({ description: 'The page number', example: 1 }) |
| 2 | @IsOptional() |
| 3 | page?: number; |
Explanation (EN)
Objašnjenje (HR)
Good example
New codetypescript
| 1 | @ApiPropertyOptional({ description: 'The page number', example: 1 }) |
| 2 | @IsOptional() |
| 3 | page?: number; |
Explanation (EN)
Objašnjenje (HR)