{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"boolean-parameter-prefixes","__idx":0},"children":["boolean-parameter-prefixes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enforces specific and consistent naming for request parameters with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}," type."," ","When this rule is enabled, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," fields of all ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}," parameters in your API must contain one of the configured prefixes."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"OAS"},"children":["OAS"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Compatibility"},"children":["Compatibility"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3.0"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3.1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3.2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["✅"]}]}]}]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n\nRoot ==> Paths --> PathItem --> Operation --> Parameter --enforces names for boolean types--> Schema\nPathItem --> Parameter\nNamedParameters --> Parameter\n\nRoot ==> components\n\nsubgraph components\nNamedParameters\nend\n\nstyle Parameter fill:#codaf9,stroke:#0044d4,stroke-width:5px\nstyle Schema fill:#codaf9,stroke:#0044d4,stroke-width:5px\n","diagramHtml":"

components

enforces names for boolean types

Root

Paths

PathItem

Operation

Parameter

Schema

NamedParameters

","diagramHtmlDark":"

components

enforces names for boolean types

Root

Paths

PathItem

Operation

Parameter

Schema

NamedParameters

"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-design-principles","__idx":1},"children":["API design principles"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Consistency in API design makes APIs easier to use."," ","Being able to identity boolean types from their names is possible when they use consistent prefixes, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["has"]},"."," ","If you saw an API with these parameters, you could identify the boolean parameters by their names:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["orderNumber"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["amount"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["hasPaid"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["shippingService"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["isFulfilled"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["customerReference"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The nuance of being able to identify the boolean parameters helps developers produce and consume APIs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configuration","__idx":2},"children":["Configuration"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["severity"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Possible values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["off"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warn"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]},". Default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["off"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["prefixes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of allowed boolean parameter prefixes. Default values are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["has"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An example configuration:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"rules:\n boolean-parameter-prefixes: error\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example configures prefixes:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"rules:\n boolean-parameter-prefixes:\n severity: error\n prefixes: [can, is, has]\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":3},"children":["Examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Given the configuration with the prefixes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["can"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["has"]},", the following example shows an error."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["incorrect"]}," boolean parameter prefixes:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"schema:\n type: object\n properties:\n belongsToUser:\n type: boolean\n default: false\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["correct"]}," boolean parameter prefixes:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"schema:\n type: object\n properties:\n isUser:\n type: boolean\n default: false\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-rules","__idx":4},"children":["Related rules"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/rules/configurable-rules"},"children":["configurable rules"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/rules/oas/no-invalid-parameter-examples"},"children":["no-invalid-parameter-examples"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/rules/oas/parameter-description"},"children":["parameter-description"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/rules/oas/operation-parameters-unique"},"children":["operation-parameters-unique"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":5},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/rules/oas2/boolean-parameter-prefixes.ts"},"children":["Rule source for OAS 2.0"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/rules/oas3/boolean-parameter-prefixes.ts"},"children":["Rule source for OAS 3.0, 3.1, and 3.2"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/openapi-visual-reference/parameter/"},"children":["OpenAPI Parameter"]}," docs"]}]}]},"frontmatter":{"slug":"/docs/cli/rules/oas/boolean-parameter-prefixes"},"tagList":[],"title":"boolean-parameter-prefixes","lastModified":"2026-05-18T14:03:00.000Z"}