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 negotiation endpoint api spec examples #3283

Merged

Conversation

ndr-brt
Copy link
Member

@ndr-brt ndr-brt commented Jul 7, 2023

What this PR changes/adds

Add negotiation endpoint api spec examples

Why it does that

documentation

Further notes

  • remove unneeded Dtos and simplified the object hierarchy without changing the api
  • deprecated 2 api fields as they are not used anymore
  • had to introduce a ManagementApiTypeRegistry that's like a wrapper around the TypeTransferRegistry, the first will use the transformers registered on itself and, if not found will rely on the latter (called fallback). This was to permit the co-existance of two ContractNegotiation to JsonObject transformers.
  • created transfer-core extension that superseded dsp-transform (as described in extract a transform-core module #2883)
  • type transformation has been tied to the ApiConfiguration, because the transformation is something related to the api, needed to map from the serialized data to the domain model one, and every api context could have its own transformation. With this PR we'll have the dsp context use the standard TypeTransformerRegistry and the management using the mentioned ManagementApiTypeRegistry, because every context could have a different way of serializing/deserializing domain objects. I guess in the future this could evolve in having also a dsp transformer registry.

Linked Issue(s)

Closes #3146
Closes #2883

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

@ndr-brt ndr-brt added documentation Improvements or additions to documentation refactoring Cleaning up code and dependencies labels Jul 7, 2023
@ndr-brt ndr-brt force-pushed the 3146-negotiation-api-examples branch 3 times, most recently from 2544822 to 7418858 Compare July 10, 2023 11:34
@codecov-commenter
Copy link

codecov-commenter commented Jul 10, 2023

Codecov Report

Patch coverage: 70.22% and project coverage change: +6.29 🎉

Comparison is base (c3b245f) 65.90% compared to head (434735e) 72.20%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3283      +/-   ##
==========================================
+ Coverage   65.90%   72.20%   +6.29%     
==========================================
  Files         836      837       +1     
  Lines       16849    16867      +18     
  Branches      934      951      +17     
==========================================
+ Hits        11105    12178    +1073     
+ Misses       5379     4296    -1083     
- Partials      365      393      +28     
Impacted Files Coverage Δ
...ipse/edc/connector/core/CoreServicesExtension.java 94.44% <ø> (ø)
...pse/edc/junit/assertions/AbstractResultAssert.java 63.63% <0.00%> (ø)
...pse/edc/core/transform/TransformerContextImpl.java 86.66% <ø> (ø)
...dc/core/transform/TypeTransformerRegistryImpl.java 100.00% <ø> (ø)
...transform/transformer/OdrlTransformersFactory.java 0.00% <ø> (ø)
...ansformer/from/JsonObjectFromAssetTransformer.java 94.11% <ø> (ø)
...sformer/from/JsonObjectFromCatalogTransformer.java 100.00% <ø> (ø)
...ormer/from/JsonObjectFromCriterionTransformer.java 90.90% <ø> (ø)
...mer/from/JsonObjectFromDataServiceTransformer.java 81.81% <ø> (ø)
...sformer/from/JsonObjectFromDatasetTransformer.java 100.00% <ø> (ø)
... and 45 more

... and 59 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@ndr-brt ndr-brt force-pushed the 3146-negotiation-api-examples branch from 7418858 to 434735e Compare July 10, 2023 12:08
@ndr-brt ndr-brt marked this pull request as ready for review July 10, 2023 12:24
@ndr-brt ndr-brt force-pushed the 3146-negotiation-api-examples branch from 434735e to 2e66a49 Compare July 10, 2023 12:26
@ndr-brt ndr-brt requested a review from wolf4ood July 11, 2023 09:06
@ndr-brt ndr-brt force-pushed the 3146-negotiation-api-examples branch from dc19189 to 05ce287 Compare July 12, 2023 06:43
Copy link
Member

@paullatzelsperger paullatzelsperger left a comment

Choose a reason for hiding this comment

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

approving based on PR description

@ndr-brt ndr-brt force-pushed the 3146-negotiation-api-examples branch from 05ce287 to 3e0bf57 Compare July 13, 2023 10:16
@ndr-brt ndr-brt merged commit 034258e into eclipse-edc:main Jul 13, 2023
21 checks passed
@ndr-brt ndr-brt deleted the 3146-negotiation-api-examples branch July 13, 2023 11:42
bjungs pushed a commit to imec-int/edc that referenced this pull request Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation refactoring Cleaning up code and dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Example JSON-LD documents in new Management API extract a transform-core module
4 participants