Skip to navigation

Optional boolean parameter's `example` matches `default`

No API user would ever want to specify an optional query parameter that’s the default value, so throw a warning recommending to reverse it.

Query parameters

booleanQueryParamOptionalExplicitbooleanOptionalDefaults to true

This boolean param is explicitly required: false. Throw a param-default-bool-matches-example error because the default matches the example value.

booleanQueryParamOptionalImplicitbooleanOptionalDefaults to true

This boolean param is implicitly optional. Throw a param-default-bool-matches-example error because the default matches the example value.

booleanQueryParamMissingDefaultbooleanOptional

Confirm a missing default value throws a warning for an optional boolean.

Response

Empty response.