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

[kotlin-spring] Fix cookie parameter code generation in API #17959

Merged

Conversation

oscarr-reyes
Copy link
Contributor

@oscarr-reyes oscarr-reyes commented Feb 25, 2024

Fixes #7406

When generating API interfaces or class controllers from a 3.0 spec file that contains cookie parameter in the request, the output code doesn't contain the endpoint parameter for resolving the cookie value that is in the spec, the template files don't contain the section for cookie and since it's part of allParams section an empty space is generated with a comma, making the generated code to be erroneous.

This PR adds the required template code for generating cookie parameter values from the spec file.

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/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.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.

* Added cookie parameter mustache template for generating cookie related code
* Adapted kotlin-spring api templates to include cookie parameters
* Added tests for evaluating cookie parameter code generation
* Added configuration sample for the new cookie use case
@oscarr-reyes
Copy link
Contributor Author

* Removed fake cases from openapi spec that were not related to cookie usage
* Cleaned sample files
@wing328
Copy link
Member

wing328 commented Mar 9, 2024

lgtm. thanks for the PR

@wing328 wing328 merged commit 7d9f9d7 into OpenAPITools:master Mar 9, 2024
22 of 27 checks passed
@wing328
Copy link
Member

wing328 commented Mar 9, 2024

FYI. samples updated via 8dae702

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.

[BUG] [Kotlin | Spring] Cookie in parameter is not correctly generated
2 participants