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

feat: add v3.1.0-alpha of the Managemenet API #4343

Conversation

paullatzelsperger
Copy link
Member

@paullatzelsperger paullatzelsperger commented Jul 9, 2024

What this PR changes/adds

Adds an entry in the version JSON file, plus improves the parsing mechanism to parse a List<VersionRecord>.

Why it does that

Preparation for #3961 and #4322

Further notes

  • fixed a bug where all version.json files overwrote one another, b/c they're all on the same classpath. I gave them each individual names
  • added a test assertion to verify the correct response of the Version API

Linked Issue(s)

Closes #4334

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

@paullatzelsperger paullatzelsperger added bug Something isn't working enhancement New feature or request api Feature related to the (REST) api labels Jul 9, 2024
@paullatzelsperger
Copy link
Member Author

FYI @saschaisele-zf

@codecov-commenter
Copy link

codecov-commenter commented Jul 9, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 76.19048% with 5 lines in your changes missing coverage. Please review.

Project coverage is 75.30%. Comparing base (7f20ba5) to head (aae7e9e).
Report is 395 commits behind head on main.

Files Patch % Lines
...or/api/management/version/VersionApiExtension.java 0.00% 4 Missing ⚠️
...lipse/edc/spi/system/apiversion/VersionRecord.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    #4343      +/-   ##
==========================================
+ Coverage   71.74%   75.30%   +3.56%     
==========================================
  Files         919     1053     +134     
  Lines       18457    21169    +2712     
  Branches     1037     1182     +145     
==========================================
+ Hits        13242    15942    +2700     
+ Misses       4756     4709      -47     
- Partials      459      518      +59     

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

Copy link
Member

@ndr-brt ndr-brt left a comment

Choose a reason for hiding this comment

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

also the resources/openapi/*.version files need to be adapted, and likely also the job that publish the openapi on github pages and the one that verifies the consistency to force a change in the version json file.

var content = typeManager.getMapper().readValue(versionContent, VersionRecord.class);
apiVersionService.addRecord(OBSERVABILITY_CONTEXT, content);
Stream.of(typeManager.getMapper()
.enable(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY)
Copy link
Member

Choose a reason for hiding this comment

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

this is not needed anymore (it doesn't hurt either :) )

@paullatzelsperger paullatzelsperger merged commit e3fa3c6 into eclipse-edc:main Jul 9, 2024
22 checks passed
@paullatzelsperger paullatzelsperger deleted the feat/4334_add_v3.1alpha_mgmtapi branch July 9, 2024 12:18
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 bug Something isn't working enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

open management api v3.1-alpha
4 participants