openapi-generator: [BUG] PHP sends boolean params as "1" or "" instead of "true" or "false"

Bug Report Checklist

  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • What’s the version of OpenAPI Generator used?
  • Have you search for related issues/PRs?
  • What’s the actual output vs expected output?
  • [Optional] Bounty to sponsor the fix (example)
Description

When params are of type “boolean”, they should be sent as “true” or “false”, but the PHP generator sends them as “1” or “”. But it correctly documents the parameters as @param bool. So if you send boolean parameters, it ends up doing something like (string) true, which evaluates to 1.

openapi-generator version

4.0.0-SNAPSHOT

OpenAPI declaration file content or url

https://gist.github.com/jacobweber/e83874fbf1c0ee6ede79100a7507e11f

Command line used for generation

java -jar openapi-generator.jar generate -i <url> -g php -o /path/to/output

Steps to reproduce
  1. Build the above spec.
  2. Run composer install from the output dir.
  3. Run the “Getting Started” example code in README.md:
$admin = True; // bool | Include admin users?
try {
    $result = $apiInstance->usersGet($admin);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->usersGet: ', $e->getMessage(), PHP_EOL;
}
  1. It calls GET http://localhost/api/users?admin=1 instead of GET http://localhost/api/users?admin=true.
Related issues/PRs

N/A

Suggest a fix

Detect booleans and convert to “true” or “false”.

About this issue

  • Original URL
  • State: closed
  • Created 5 years ago
  • Comments: 17 (10 by maintainers)

Most upvoted comments

I ended up replacing boolean values to string.

@wing328 The fix introduced by #2257 has been removed by #3984.

ObjectSerializer::toQueryValue() has been removed, I guess to improve collection serialization, but the boolean case is still broken.

@jacobweber @ackintosh you both have valid points.

To move this forward, I suggest we go with https://github.com/OpenAPITools/openapi-generator/pull/2257 and if there are demands to send boolean values as 1/0 in the query string or other parameters, then we can make an option to cater both cases.

(I did work on 1 or 2 issues before in which the users are expecting the client to send true/false in the query string)