Skip to content

Add Maven CLI usage example to Java generator documentation #21577

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Naveenkumarsuk
Copy link

This PR improves the documentation for the Java generator by adding an example that shows how to check the plugin version using the Maven CLI. This addition helps users quickly verify which version of the OpenAPI Generator is configured in their project.

Let me know if any changes are needed — happy to update.

TY

To check which version of the OpenAPI Generator Maven plugin is configured in your project, use:

```bash
mvn openapi-generator:version
Copy link
Member

@wing328 wing328 Jul 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this doc (auto-generated) is for the java client generator

for maven plugin doc, please refer to https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-maven-plugin/README.md

feel free to file a PR to update this readme to improve the maven plugin doc

@Naveenkumarsuk
Copy link
Author

Thanks for the guidance earlier. I’ve updated the PR to improve the Maven plugin documentation instead of the auto-generated Java generator doc.

I've added a usage example in modules/openapi-generator-maven-plugin/README.md showing how to generate a Java client using the Maven plugin.

Let me know if there’s anything I should refine further — happy to adjust

TY

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants