You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@helix.apache.org by "desaikomal (via GitHub)" <gi...@apache.org> on 2023/03/06 19:03:48 UTC
[GitHub] [helix] desaikomal opened a new pull request, #2396: Helix-REST - Add support for auto-generated API documentation
desaikomal opened a new pull request, #2396:
URL: https://github.com/apache/helix/pull/2396
### Issues
- [ ] My PR addresses the following Helix issues and references them in the PR description:
### Description
Today Helix-REST API documentation is manually documented. This is super useful to our consumers. Source of truth is code and to make sure our code is in-sync with documentation, use Swagger to generate the auto-generate the documentation.
This is the first step in producing the auto-generated documentation.
Swagger-UI integration will allow APIs to be visible through swagger-ui.
<img width="1344" alt="Screenshot 2023-03-06 at 10 39 51 AM" src="https://user-images.githubusercontent.com/98000016/223204112-0507ac4b-ae22-424f-b583-20acf0a91e21.png">
- [ ] Here are some details about my PR, including screenshots of any UI changes:
### Tests
- [ ] The following tests are written for this issue:
(List the names of added unit/integration tests)
- The following is the result of the "mvn test" command on the appropriate module:
[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 209, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO]
[INFO] --- jacoco-maven-plugin:0.8.6:report (generate-code-coverage-report) @ helix-rest ---
[INFO] Loading execution data file /Users/kdesai/apache/helix/helix-rest/target/jacoco.exec
[INFO] Analyzed bundle 'Apache Helix :: Restful Interface' with 92 classes
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 07:55 min
[INFO] Finished at: 2023-03-06T11:02:48-08:00
[INFO] ------------------------------------------------------------------------
All tests within helix-rest are passing.
(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)
### Changes that Break Backward Compatibility (Optional)
- My PR contains changes that break backward compatibility or previous assumptions for certain methods or API. They include:
(Consider including all behavior changes for public methods or API. Also include these changes in merge description so that other developers are aware of these changes. This allows them to make relevant code changes in feature branches accounting for the new method/API behavior.)
### Documentation (Optional)
- In case of new functionality, my PR adds documentation in the following wiki page:
(Link the GitHub wiki you added)
### Commits
- My commits all reference appropriate Apache Helix GitHub issues in their subject lines. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Code Quality
- My diff has been formatted using helix-style.xml
(helix-style-intellij.xml if IntelliJ IDE is used)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] desaikomal commented on pull request #2396: Helix-REST - Add support for auto-generated API documentation
Posted by "desaikomal (via GitHub)" <gi...@apache.org>.
desaikomal commented on PR #2396:
URL: https://github.com/apache/helix/pull/2396#issuecomment-1457222135
Commit Message: The change has been reviewed and approved by @xyuanlu and ready to be checked-in.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] xyuanlu merged pull request #2396: Helix-REST - Add support for auto-generated API documentation
Posted by "xyuanlu (via GitHub)" <gi...@apache.org>.
xyuanlu merged PR #2396:
URL: https://github.com/apache/helix/pull/2396
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org