Skip to content
New issue

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

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

Already on GitHub? # to your account

Added HTTP method+path to JavaDocs in kotlin clients #20618

Merged
merged 5 commits into from
Feb 9, 2025

Conversation

ranger-ross
Copy link
Contributor

This PR is a QoL improvement that adds the HTTP method and path to the Javadoc for each operation in Kotlin clients.
The motivation it to make it more obvious which methods map to the HTTP endpoint.

The changes are fairly trival and I broke out each client into a separate commit to making reviewing easier.

Also I recently open a similar PR for the Rust clients for reference: #20591

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (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.

cc: @dr4ke616 @karismann @Zomzog @andrewemery @4brunu @yutaka0m @stefankoppier @e5l

@wing328 wing328 added this to the 7.12.0 milestone Feb 9, 2025
@wing328 wing328 merged commit e1130c3 into OpenAPITools:master Feb 9, 2025
63 checks passed
@maksim-kosolapov
Copy link
Contributor

maksim-kosolapov commented Feb 28, 2025

@ranger-ross There is an issue with these PR changes. When the path ends with /* it appears like a nested commend in KDoc and the generated API file is broken. It would be great to get this fixed ASAP.

cc: @wing328

@ranger-ross ranger-ross deleted the kotlin-docs branch February 28, 2025 16:28
@ranger-ross
Copy link
Contributor Author

Oh sorry. I didn't know the Kotlin parser interpreters /* as a comment when already instead of a JavaDoc. 😅

@ranger-ross
Copy link
Contributor Author

I think I have a bug fix. I'll open a PR soon

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants