You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@streampark.apache.org by GitBox <gi...@apache.org> on 2022/10/10 10:06:22 UTC

[GitHub] [incubator-streampark] lvshaokang opened a new issue, #1796: [Proposal] Unify restApi specifications

lvshaokang opened a new issue, #1796:
URL: https://github.com/apache/incubator-streampark/issues/1796

   ### Code of Conduct
   
   - [X] I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
   
   
   ### Search before asking
   
   - [X] I had searched in the [issues](https://github.com/streamxhub/streampark/issues?q=is%3Aissue+label%3A%22bug%22) and found no similar issues.
   
   
   ### Describe the proposal
   
   Background:
   
   The streampark project interface definition has the following problems:
   1. Api specification not following the RESTful API regulation.
   https://github.com/apache/incubator-streampark/blob/dev/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/controller/AlertController.java#L85
   2. Lack of the api interface description
   https://github.com/apache/incubator-streampark/blob/dev/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/controller/ApplicationController.java#L72
   3. Some interfaces have redundant parameters
   https://github.com/apache/incubator-streampark/blob/dev/streampark-console/streampark-console-service/src/main/java/org/apache/streampark/console/core/controller/AlertController.java#L86
   4. Poor readability
   
   Proposal:
   
   To perfect the swagger interface description and unify api specifications, improve readability and performance.
   
   ### Task list
   
   1. Perfect the swagger interface description.
   2. Define the interface specification, sorting the api interface that needs to be adjusted, before and after.
   3. Unified the api interface specifications and reduce redundant parameters.
   
   ### Are you willing to submit PR?
   
   - [X] Yes I am willing to submit a PR!


-- 
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: issues-unsubscribe@streampark.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [incubator-streampark] 1996fanrui commented on issue #1796: [Proposal] Unify restApi specifications

Posted by GitBox <gi...@apache.org>.
1996fanrui commented on issue #1796:
URL: https://github.com/apache/incubator-streampark/issues/1796#issuecomment-1276284508

   Great proposal, the specification is very important for StreamPark. thanks @lvshaokang 


-- 
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: issues-unsubscribe@streampark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org