feat(version): generate OpenAPI doc version on fly #2829
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Use git-commit-id-maven-plugin plugin to read git properties and generate version for OpenAPI doc on the fly. The version uses major and minor version from git and number of commits between HEAD and last tag as the patch version. Signed-off-by: Gaurav Mishra <mishra.gaurav@siemens.com>
GMishx
added
needs code review
needs special test
GMishx
requested review from
heliocastro,
KoukiHama,
arunazhakesan and
ag4ums
as code owners
|
@GMishx Something special to test ? I want to add the new API page address as the one for footer in the frontend. What you think i should add ? |
@heliocastro just need to test if the version is updated even if the repository does not contain the tag information (how the github checkout action works).
It can be the link to the Swagger UI. The user/developer can fetch the OpenAPI docs from the same page. However, this link can be changed in backend with The default is http://localhost:8080/resource/swagger-ui/index.html |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Use
git-commit-id-maven-pluginplugin to read git properties and generate version for OpenAPI doc on the fly.The version uses major and minor version from git and number of commits between HEAD and last tag as the patch version.
This helps in providing a reliable way of identifying updates in REST API until we have stable REST API to use custom API version.
Suggest Reviewer
@heliocastro @hoangnt2 @smrutis1
How To Test?
Open the OpenAPI docs and check the API version.