Default value for the header is not consistent with the header's type

Issue ID: semantic-header-default-invalid

Description

The default value you have defined for a header is not consistent with 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 header parameter accepts integer values but the default value is a string.

{
    "responses": {
        "200": {
            "description": "OK",
            "headers": {
                "x-internal-id": {
                    "type": "integer",
                    "default": "0"
                    // ...
                }
            }
        }
    }
}

Remediation

Make sure that all default values for headers match the header type.

{
    "responses": {
        "200": {
            "description": "OK",
            "headers": {
                "x-internal-id": {
                    "type": "integer",
                    "default": 0
                    // ...
                }
            }
        }
    }
}