Property 'allowReserved' is only allowed for query parameters
Issue ID: v3-semantic-parameter-allowreserved
Description
You have defined the property allowReserved
for a parameter where it is not allowed. The property is only allowed for query parameters.
For more details, see the OpenAPI Specification.
Example
The following is an example of how this issue could look in your API definition. The parameter has allowReserved
set to true
, but in
is set to path
:
{
"myAPIparameter":{
"name": "string",
"in": "path",
"required": true,
"allowReserved" : true,
"schema":{
"$ref":"#/components/schemas/string"
}
}
}
Remediation
Make sure you only define allowReserved
for query parameters.
{
"myAPIparameter":{
"name": "string",
"in": "query",
"required": true,
"allowReserved" : true,
"schema":{
"$ref":"#/components/schemas/string"
}
}
}