Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[C][Client] Always send integer or boolean query parameters to the API server #14019

Merged
merged 2 commits into from Nov 29, 2022

Conversation

ityuhui
Copy link
Contributor

@ityuhui ityuhui commented Nov 15, 2022

@wing328 @zhemant @michelealbano

When the query parameter in a API request is type of "integer" or "boolean", if its value is 0 or false, the current code does not send the query parameter to the API server.

e.g.

    if (gracePeriodSeconds)    <--- if gracePeriodSeconds == 0, the below code will be ignored.
    {
        keyQuery_gracePeriodSeconds = strdup("gracePeriodSeconds");
        valueQuery_gracePeriodSeconds = calloc(1,MAX_NUMBER_LENGTH);
        snprintf(valueQuery_gracePeriodSeconds, MAX_NUMBER_LENGTH, "%d", gracePeriodSeconds);
        keyPairQuery_gracePeriodSeconds = keyValuePair_create(keyQuery_gracePeriodSeconds, valueQuery_gracePeriodSeconds);
        list_addElement(localVarQueryParameters,keyPairQuery_gracePeriodSeconds);
    }

This PR changes the code to:

    if (1) // Always send integer parameters to the API server 
    {
        keyQuery_gracePeriodSeconds = strdup("gracePeriodSeconds");
        valueQuery_gracePeriodSeconds = calloc(1,MAX_NUMBER_LENGTH);
        snprintf(valueQuery_gracePeriodSeconds, MAX_NUMBER_LENGTH, "%d", gracePeriodSeconds);
        keyPairQuery_gracePeriodSeconds = keyValuePair_create(keyQuery_gracePeriodSeconds, valueQuery_gracePeriodSeconds);
        list_addElement(localVarQueryParameters,keyPairQuery_gracePeriodSeconds);
    }

This issue comes from kubernetes-client/c#158

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328
Copy link
Member

wing328 commented Nov 16, 2022

@ityuhui thanks for the PR.

What about creating another spec (e.g. modules/openapi-generator/src/test/resources/2_0/c/petstore.yaml) and add some fake endpoints with integer, boolean query parameters to ensure the output compiles without issue?

@wing328 wing328 added this to the 6.3.0 milestone Nov 16, 2022
@ityuhui
Copy link
Contributor Author

ityuhui commented Nov 17, 2022

Sure. I'll do it.

@ityuhui
Copy link
Contributor Author

ityuhui commented Nov 28, 2022

Added a new fake endpoint with integer and boolean parameters and
built the new sample successfully.

~/openapi-generator/samples/client/petstore/c/build# make
Scanning dependencies of target openapi_petstore
[  6%] Building C object CMakeFiles/openapi_petstore.dir/src/list.c.o
[ 13%] Building C object CMakeFiles/openapi_petstore.dir/src/apiKey.c.o
[ 20%] Building C object CMakeFiles/openapi_petstore.dir/src/apiClient.c.o
[ 26%] Building C object CMakeFiles/openapi_petstore.dir/external/cJSON.c.o
[ 33%] Building C object CMakeFiles/openapi_petstore.dir/model/object.c.o
[ 40%] Building C object CMakeFiles/openapi_petstore.dir/model/api_response.c.o
[ 46%] Building C object CMakeFiles/openapi_petstore.dir/model/category.c.o
[ 53%] Building C object CMakeFiles/openapi_petstore.dir/model/order.c.o
[ 60%] Building C object CMakeFiles/openapi_petstore.dir/model/pet.c.o
[ 66%] Building C object CMakeFiles/openapi_petstore.dir/model/tag.c.o
[ 73%] Building C object CMakeFiles/openapi_petstore.dir/model/user.c.o
[ 80%] Building C object CMakeFiles/openapi_petstore.dir/api/PetAPI.c.o
[ 86%] Building C object CMakeFiles/openapi_petstore.dir/api/StoreAPI.c.o
[ 93%] Building C object CMakeFiles/openapi_petstore.dir/api/UserAPI.c.o
[100%] Linking C shared library libopenapi_petstore.so
[100%] Built target openapi_petstore

@wing328
Copy link
Member

wing328 commented Nov 29, 2022

LGTM.

CircleCI failure not related to this change.

@wing328 wing328 merged commit 12a6ea7 into OpenAPITools:master Nov 29, 2022
@ityuhui ityuhui deleted the yh-int-bool-para-1115 branch November 29, 2022 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants