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] Introduce support for Kotlin Explicit API Mode for Kotlin-Client generator (resolve #16506) #19999

Merged
merged 3 commits into from
Oct 30, 2024

Conversation

xsveda
Copy link
Contributor

@xsveda xsveda commented Oct 30, 2024

Resolves #16506

Kotlin Explicit API Mode requires all public APIs to be explicitly marked as public and have explicit return type declared.

This PR adds an explicitApi option to Kotlin-Client codegen to cover this requirement.

A kotlin-explicit sample has been added as a test case but the same behaviour has been tested also for Kotlin Multiplatform & Kotlin Retrofit.

@dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06) @e5l (2024/10)

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.x.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.

@4brunu
Copy link
Contributor

4brunu commented Oct 30, 2024

Thanks, this is a great contribution, looks good to me 👍

@4brunu 4brunu merged commit acb1641 into OpenAPITools:master Oct 30, 2024
62 checks passed
@xsveda xsveda deleted the feature/kotlin-explicit-api branch October 31, 2024 06:37
@martintimko-kosik
Copy link

Hi @xsveda, did you consider adding the same, for kotlin-spring generator too? would be great 🙏

@wing328 wing328 added this to the 7.10.0 milestone Nov 20, 2024
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.

[REQ] [Kotlin] Specifying visibility modifiers
4 participants