This endpoint has a "bestRateOnly" parameter. Here is the schema for it:
{
"default": true,
"description": "Used to return only the cheapest offer per hotel or all available offers.",
"in": "query",
"name": "bestRateOnly",
"required": false,
"type": "boolean"
}
Notice that its default value is set to true. While this is correctly displayed in the request query parameters here:
It does not say "defaults to: true" in the parameters section:
However, it does say "defaults to: 1" e.g. for the "adults" parameter.
My question is: Is this behavior intentional? If not, is there a way to still show "defaults to: ..." in the Parameters section?
Is this behavior intentional? If not, is there a way to still show "defaults to: ..." in the Parameters section?
This is not intentional and would be a nice enhancement. Feel free to submit a PR if desired.
Current Behavior
Default boolean schema parameters don't say "default to: ..." in the parameters section.
Expected Behavior
Default boolean schema parameters should say "default to: ..." in the parameters section.
Steps to Reproduce
I have created a reproducable example using a random API I found:
This is how it looks:
This endpoint has a "bestRateOnly" parameter. Here is the schema for it:
Notice that its default value is set to true. While this is correctly displayed in the request query parameters here:
It does not say "defaults to: true" in the parameters section:
However, it does say "defaults to: 1" e.g. for the "adults" parameter.
My question is: Is this behavior intentional? If not, is there a way to still show "defaults to: ..." in the Parameters section?