Header property is not applicable to the header's type
Issue ID: warning-header-property-improper
Description
A property defined for a header is not applicable to the type of the header.
For more details, see the OpenAPI Specification.
Example
The following is an example of how this issue could look in your API definition. The rate limiting header can include parameters of the type integer
, but the parameters also have the property maxLength
defined which is a property of string parameters, not integers:
{
"headers": {
"X-Rate-Limit-Limit": {
"description": "The number of requests allowed in the current period",
"type": "integer",
"maxLength": 8
}
// ...
}
}
Remediation
Make sure that all properties defined for headers match the header type.
{
"headers": {
"X-Rate-Limit-Limit": {
"description": "The number of requests allowed in the current period",
"type": "integer",
"maximum": 8
}
// ...
}
}