OpenAPI Schema Properties Boolean Naming (Edit)

Boolean properties should not use an "is" prefix in their names. The property type already indicates it is a boolean, and the "is" prefix adds unnecessary verbosity.

OpenAPISchemaPropertiesNamingBoolean

Rule Definition

openapi-schema-properties-boolean-naming-warn.yaml
{"openapi-schema-properties-boolean-naming-warn":{"description":"Boolean properties should not use an \"is\" prefix in their names. The property type already indicates it is a boolean, and the \"is\" prefix adds unnecessary verbosity.","message":"Boolean properties SHOULD NOT use an \"is\" prefix.","given":"$..[?(@.type==\"boolean\")]~","severity":"warn","then":{"function":"pattern","functionOptions":{"notMatch":"^is[A-Z]"}}}}

Back to All of the Rules