RESTWS-980: Initial implementation of OpenAPI Generator Maven Plugin with JavaParser integration #657
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of what I changed
Introduced a new OpenAPI Generator Maven Plugin that integrates JavaParser to extract Javadoc from OpenMRS REST resource classes. This initial implementation serves as a proof-of-concept for enhancing OpenAPI documentation with descriptive information from source code.
Key Implementation Details:
PatientResource1_8
classunpack-dependencies
goal fromgenerate-resources
toprepare-package
phaseThis implementation provides the foundation for programmatically enhancing API documentation by leveraging the existing Javadoc in the codebase.
PS: I also pushed the code for the schema introspector alongside so the work can be combined in future commits.
Issue I worked on
https://openmrs.atlassian.net/browse/RESTWS-980
Checklist: I completed these to help reviewers :)
[
x
] My IDE is configured to follow the code style of this project.No? Unsure? -> configure your IDE, format the code and add the changes with
git add . && git commit --amend
[] I have added tests to cover my changes. (If you refactored
existing code that was well tested you do not have to add tests)
No? -> write tests and add them to this commit
git add . && git commit --amend
[
x
] I ranmvn clean package
right before creating this pull request andadded all formatting changes to my commit.
No? -> execute above command
[
x
] All new and existing tests passed.No? -> figure out why and add the fix to your commit. It is your responsibility to make sure your code works.
[
x
] My pull request is based on the latest changes of the master branch.No? Unsure? -> execute command
git pull --rebase upstream master