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

[SP-1102] - GET/v2/info/versions update and removement of deprecated endpoints #1192

Merged
merged 4 commits into from
Feb 17, 2023

Conversation

deexidee
Copy link
Contributor

@deexidee deexidee commented Jan 31, 2023

Purpose

Swagger doc description for endpoint "/v2/info/versions" at rest/impl/Version.class and removal of endpoints marked @deprecated(since = "0.71.0", forRemoval = true).

Breaking changes

Removal of deprecated API endpoints:

  • /v2/pipelines/own
  • /v2/pipelines/system
  • /v2/streams/own
  • /v2/streams/own/<element_id>

Remarks

PR introduces (a) breaking change(s): yes

PR introduces (a) deprecation(s): no

…in rest/impl/Version.class and removal of endpoints marked @deprecated(since = "0.71.0", forRemoval = true).
Copy link
Contributor

@tenthe tenthe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thank you very much!

@deexidee
Copy link
Contributor Author

is it ok that couple of checks have failed?

@tenthe
Copy link
Contributor

tenthe commented Jan 31, 2023

They failed due to some checkstyle problems, see: https://github.com/apache/streampipes/actions/runs/4053261489/jobs/6981510149

Here is described how you can set this up checkstyle locally: https://cwiki.apache.org/confluence/display/STREAMPIPES/Code+Style+-+Java

There is also an issue on this topic, see #880. This might be a good next topic for you if you are interested. When we add the validation as a git pre-commit hook, we will avoid such situations in the future.

@bossenti
Copy link
Contributor

bossenti commented Feb 1, 2023

Thanks a lot for your contribution @deexidee 🎉

@bossenti bossenti added java Pull requests that update Java code refactoring Indicates when a pull request or issue contains larger refactoring aspects. backend Everything that is related to the StreamPipes backend breaking change Indicates that a PR or issue yields to a breaking change labels Feb 1, 2023
@bossenti bossenti added this to the 1.0.0 milestone Feb 1, 2023
@bossenti
Copy link
Contributor

bossenti commented Feb 9, 2023

Okay, so to sum the discussion up:
The applied changes are fine. We realized that there is another similar endpoint called setup: https://github.com/apache/streampipes/blob/e8565e3f07729b0dc0e798ae541bc71a2c2662bf/streampipes-rest/src/main/java/org/apache/streampipes/rest/impl/Setup.java
This one misses as well some swagger documentation.
If you want to provide it, this would be great @deexidee :)

Apart from that, we can merge the PR once the checkstyle issues are resolved

@bossenti bossenti linked an issue Feb 17, 2023 that may be closed by this pull request
Copy link
Contributor

@bossenti bossenti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for your contribution @deexidee 🙏🏼
We would be glad if you are interested in further contributions :)

@bossenti bossenti merged commit 46bca37 into apache:dev Feb 17, 2023
flomickl pushed a commit that referenced this pull request Feb 18, 2023
…endpoints (#1192)

* [SP-1102] - Swagger doc description for endpoint "/v2/info/versions" in rest/impl/Version.class and removal of endpoints marked @deprecated(since = "0.71.0", forRemoval = true).

* checkstyle violation fix

* GET /v2/setup/configured Swagger doc is provided

---------

Co-authored-by: Василенко Денис Владимирович (4045091) <dvvasilenko@dev.vtb>
@bossenti bossenti removed this from the 1.0.0 milestone Feb 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Everything that is related to the StreamPipes backend breaking change Indicates that a PR or issue yields to a breaking change java Pull requests that update Java code refactoring Indicates when a pull request or issue contains larger refactoring aspects.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend StreamPipes API by a health-check endpoint
4 participants