valid-boolean-parameter-name

Overview

This rule belongs to the openapi-v3-apimatic-syntax-linting ruleset and states that:

Name fields of parameters with type boolean should have a is, has or can prefix. You can specify different prefixes.

Property	Value
Enabled	No
Maximum Severity	Warning
Message	No prefix found for boolean parameter name.
Code	OPENAPI3APIMATICSYNTAX_L332
Type	Linting
Rule System	Syntax
Broad Category	OpenAPI Parameters
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi syntax linting apimatic boolean parameter name prefix can has is

Suggested Fixes

• Ensure that boolean parameter name have prefix is, has or can.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameter-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/