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

docs: decision record about API versioning #3595

Conversation

paullatzelsperger
Copy link
Member

What this PR changes/adds

Adds a decision record about API versioning.

Why it does that

Transparent decision traces.

Further notes

List other areas of code that have changed but are not necessarily linked to the main feature. This could be method
signature changes, package declarations, bugs that were encountered and were fixed inline, etc.

Linked Issue(s)

Closes # <-- insert Issue number if one exists

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

@paullatzelsperger paullatzelsperger added this to the Backlog milestone Nov 9, 2023
@paullatzelsperger paullatzelsperger added documentation Improvements or additions to documentation api Feature related to the (REST) api labels Nov 9, 2023
@paullatzelsperger paullatzelsperger force-pushed the docs/decision_record_api_versioning branch from acb830d to 2afe0eb Compare November 9, 2023 07:58
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2dce1f0) 72.00% compared to head (acb830d) 72.00%.

❗ Current head acb830d differs from pull request most recent head 2afe0eb. Consider uploading reports for the commit 2afe0eb to get more accurate results

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3595   +/-   ##
=======================================
  Coverage   72.00%   72.00%           
=======================================
  Files         893      893           
  Lines       17855    17855           
  Branches     1015     1015           
=======================================
  Hits        12856    12856           
  Misses       4562     4562           
  Partials      437      437           
Files Coverage Δ
...or/api/management/asset/v3/AssetApiController.java 100.00% <ø> (ø)

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

Copy link
Contributor

@alexandrudanciu alexandrudanciu left a comment

Choose a reason for hiding this comment

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

Proposed some minor improvements.

paullatzelsperger and others added 2 commits November 9, 2023 13:13
Co-authored-by: alexandrudanciu <[email protected]>
Co-authored-by: Jim Marino <[email protected]>
@paullatzelsperger paullatzelsperger merged commit fdf099a into eclipse-edc:main Nov 9, 2023
16 checks passed
@paullatzelsperger paullatzelsperger deleted the docs/decision_record_api_versioning branch November 10, 2023 06:59
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 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants