Skip to content
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

[Proposal] Unify restApi specifications #1796

Open
3 tasks done
lvshaokang opened this issue Oct 10, 2022 · 1 comment
Open
3 tasks done

[Proposal] Unify restApi specifications #1796

lvshaokang opened this issue Oct 10, 2022 · 1 comment

Comments

@lvshaokang
Copy link
Contributor

lvshaokang commented Oct 10, 2022

Code of Conduct

Search before asking

  • I had searched in the issues 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. [Feature] Perfect the swagger interface description #1801
  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?

  • Yes I am willing to submit a PR!
@1996fanrui
Copy link
Member

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

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

No branches or pull requests

2 participants