Boolean body parameters are not sent when false

[advance512]

Description

When a body parameter is of type boolean and is false, then parameter does not get sent to the server.

Swagger-codegen version

2.2.2

Swagger declaration file content or url

Example parameter:

      parameters:
        - name: approved
          in: body
          required: true
          description: Whether to approve or disapprove the entity.
          schema:
            type: boolean

If approved is set as true, then the call works perfectly. Otherwise, it fails, since the code (in ApiClient.js in the function callApi) contains the following:

    } else if (bodyParam) {
      request.send(bodyParam);
    }

Of course, bodyParam is false, so it is not sent.

Command line used for generation

java -jar swagger-codegen-cli.jar generate -i ../swagger.yaml -l javascript --additional-properties usePromises=true

Steps to reproduce

Use this Swagger definition:

  /approve:

    post:
      parameters:
        - name: approved
          in: body
          required: true
          schema:
            type: boolean

and see the generated call. Try to use it with both approved as true and as false.

Related issues

Could not find.

Suggest a Fix

If there is a body parameter defined in the swagger definition, always send it. Except, perhaps, if it is undefined.

[wing328]

@advance512 What does the HTTP request payload look like? I wonder if your definition using body parameters with just a boolean type is correct. Do you mean to use form parameter instead?

Ref: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameter-object

[advance512]

Hey @wing328,

Thanks for the reply. What do you mean by "correct definition"? Is the definition not a valid definition of Swagger?

The body is empty, so there is nothing to show.

[wing328]

If the HTTP request body is empty, why do you need to define a body parameter in your OpenAPI spec?

[ePaul]

@wing328 As I understand, @advance512 wants to have a body of either true or false. But the generated JS client sents either true or an empty body.

[wing328]

@advance512 Without the HTTP request, it would be not easy to understand the problem. Please provide an example so that we can help you out.

[advance512]

@wing328, @ePaul got it.

There are two types of HTTP requests made:

If the parameter is false, then the body parameter is not sent, the header 'Content-Length' is set to 0, and there is no body.

If the parameter is true, then the body parameter is sent, the header Content-Length is set to 4, and the body is: true.

You'd expect case 1 to have 'Content-Length' set to 5, and the body to be: false, no?

[advance512]

@wing328
Any update?

[advance512]

@wing328
is there anything I can do to help this?

[advance512]

FYI, this was fixed in:
OpenAPITools/openapi-generator#1432