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

refactor: bump all management API endpoints to v3 #4211

Conversation

paullatzelsperger
Copy link
Member

@paullatzelsperger paullatzelsperger commented May 23, 2024

What this PR changes/adds

This PR bumps the latest version of all Management API endpoints to /v3, and it deprecates the old endpoints/controllers. It also adds unique operationId entries to avoid clashes.

each API version (interface + controller) is in its own Java package, with common base classes wherever feasible, to avoid duplicated code as much as possible.

Why it does that

one consistent management API version.

Further notes

Linked Issue(s)

Closes #4208

Please be sure to take a look at the contributing guidelines and our etiquette for pull requests.

@paullatzelsperger paullatzelsperger added this to the Milestone 16 milestone May 23, 2024
@paullatzelsperger paullatzelsperger added enhancement New feature or request refactoring Cleaning up code and dependencies api Feature related to the (REST) api breaking-change Will require manual intervention for version update labels May 23, 2024
@paullatzelsperger paullatzelsperger force-pushed the refactor/bump_management-api_to_v3 branch from 9a97f3f to 6044cb0 Compare May 23, 2024 13:54
@paullatzelsperger paullatzelsperger self-assigned this May 23, 2024
@codecov-commenter
Copy link

codecov-commenter commented May 23, 2024

Codecov Report

Attention: Patch coverage is 85.29412% with 20 lines in your changes are missing coverage. Please review.

Project coverage is 75.32%. Comparing base (7f20ba5) to head (4977a3f).
Report is 273 commits behind head on main.

Files Patch % Lines
...ement/transferprocess/v2/TransferProcessApiV2.java 0.00% 5 Missing ⚠️
...lplane/api/management/catalog/v2/CatalogApiV2.java 0.00% 4 Missing ⚠️
...ntractnegotiation/v2/ContractNegotiationApiV2.java 0.00% 3 Missing ⚠️
...contractdefinition/v2/ContractDefinitionApiV2.java 0.00% 2 Missing ⚠️
...pi/management/policy/v2/PolicyDefinitionApiV2.java 0.00% 2 Missing ⚠️
...nnector/api/management/secret/v1/SecretsApiV1.java 0.00% 2 Missing ⚠️
...src/main/java/org/eclipse/edc/api/ApiWarnings.java 0.00% 1 Missing ⚠️
...trolplane/api/management/edr/v1/EdrCacheApiV1.java 0.00% 1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4211      +/-   ##
==========================================
+ Coverage   71.74%   75.32%   +3.58%     
==========================================
  Files         919     1039     +120     
  Lines       18457    20668    +2211     
  Branches     1037     1151     +114     
==========================================
+ Hits        13242    15569    +2327     
+ Misses       4756     4587     -169     
- Partials      459      512      +53     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@paullatzelsperger paullatzelsperger marked this pull request as draft May 23, 2024 15:06
@paullatzelsperger paullatzelsperger marked this pull request as ready for review May 23, 2024 18:46
@paullatzelsperger paullatzelsperger force-pushed the refactor/bump_management-api_to_v3 branch from 2d26d9e to 4977a3f Compare May 24, 2024 05:16
@paullatzelsperger paullatzelsperger merged commit 9b840c2 into eclipse-edc:main May 24, 2024
16 checks passed
@paullatzelsperger paullatzelsperger deleted the refactor/bump_management-api_to_v3 branch May 24, 2024 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Feature related to the (REST) api breaking-change Will require manual intervention for version update enhancement New feature or request refactoring Cleaning up code and dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bump all Management API endpoints to /v3
5 participants