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 catalog endpoints schema examples #3306

Merged

Conversation

ndr-brt
Copy link
Member

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

What this PR changes/adds

Openapi spec examples for catalog api

Why it does that

documentation

Further notes

  • add also missing Policy example
  • removed the no-more-useful openapi.yaml

Linked Issue(s)

Closes #3115
Closes #3146
Part of #3267

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 enhancement New feature or request api Feature related to the (REST) api labels Jul 17, 2023
@ndr-brt ndr-brt force-pushed the 3146-catalog-api-spec-examples branch from 897d26b to 037e397 Compare July 17, 2023 08:03
@codecov-commenter
Copy link

codecov-commenter commented Jul 17, 2023

Codecov Report

Patch coverage: 66.66% and project coverage change: -0.08 ⚠️

Comparison is base (112ade7) 71.63% compared to head (9d42d65) 71.55%.

❗ 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    #3306      +/-   ##
==========================================
- Coverage   71.63%   71.55%   -0.08%     
==========================================
  Files         831      830       -1     
  Lines       16681    16659      -22     
  Branches      953      953              
==========================================
- Hits        11949    11920      -29     
- Misses       4336     4341       +5     
- Partials      396      398       +2     
Impacted Files Coverage Δ
.../eclipse/edc/validator/jsonobject/JsonWalkers.java 76.92% <0.00%> (-7.70%) ⬇️
.../java/org/eclipse/edc/api/model/ApiCoreSchema.java 0.00% <ø> (ø)
.../management/configuration/ManagementApiSchema.java 0.00% <0.00%> (ø)
...c/connector/api/management/catalog/CatalogApi.java 0.00% <0.00%> (ø)
...nt/contractnegotiation/ContractNegotiationApi.java 0.00% <ø> (ø)
...tor/api/management/policy/PolicyDefinitionApi.java 0.00% <ø> (ø)
...ansform/JsonObjectToCatalogRequestTransformer.java 77.77% <77.77%> (ø)
...r/api/management/catalog/CatalogApiController.java 89.47% <100.00%> (-0.53%) ⬇️
...or/api/management/catalog/CatalogApiExtension.java 83.33% <100.00%> (-2.39%) ⬇️
...nt/catalog/validation/CatalogRequestValidator.java 83.33% <100.00%> (ø)

... and 1 file 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 merged commit 84c76af into eclipse-edc:main Jul 18, 2023
20 checks passed
@ndr-brt ndr-brt deleted the 3146-catalog-api-spec-examples branch July 18, 2023 08:11
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
api Feature related to the (REST) api documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Example JSON-LD documents in new Management API OpenAPI: adding examples to the OpenAPI specs
4 participants