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: add required field documentation on management api #3554

Merged
merged 2 commits into from Oct 20, 2023

Conversation

ndr-brt
Copy link
Member

@ndr-brt ndr-brt commented Oct 20, 2023

What this PR changes/adds

Add required attribute where needed on the input schema objects for management api

Why it does that

documentation

Further notes

  • 2 update methods were marked with a 200 status code but they are actually returning 204
  • added @context objects as well, marked as required.
  • remove flooding debug log

Linked Issue(s)

Closes #3552

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 api Feature related to the (REST) api labels Oct 20, 2023
@ndr-brt ndr-brt requested a review from wolf4ood October 20, 2023 06:55
@ndr-brt ndr-brt force-pushed the 3552-api-required-properties branch from ff27175 to 35ec88a Compare October 20, 2023 07:20
@codecov-commenter
Copy link

Codecov Report

Attention: 7 lines in your changes are missing coverage. Please review.

Comparison is base (6a85970) 72.46% compared to head (ff27175) 17.86%.
Report is 1 commits behind head on main.

❗ Current head ff27175 differs from pull request most recent head 35ec88a. Consider uploading reports for the commit 35ec88a 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    #3554       +/-   ##
===========================================
- Coverage   72.46%   17.86%   -54.61%     
===========================================
  Files         871      871               
  Lines       17424    17423        -1     
  Branches      993      993               
===========================================
- Hits        12627     3113     -9514     
- Misses       4381    14223     +9842     
+ Partials      416       87      -329     
Files Coverage Δ
.../java/org/eclipse/edc/api/model/ApiCoreSchema.java 0.00% <ø> (ø)
...dc/connector/api/management/asset/v3/AssetApi.java 0.00% <ø> (ø)
...c/connector/api/management/catalog/CatalogApi.java 0.00% <ø> (ø)
...ment/contractdefinition/ContractDefinitionApi.java 0.00% <ø> (ø)
...nt/contractnegotiation/ContractNegotiationApi.java 0.00% <ø> (ø)
...tor/api/management/policy/PolicyDefinitionApi.java 0.00% <ø> (ø)
...management/transferprocess/TransferProcessApi.java 0.00% <ø> (ø)
...lector/api/v2/schemas/DataPlaneInstanceSchema.java 0.00% <0.00%> (ø)
...edc/vault/hashicorp/HashicorpVaultHealthCheck.java 0.00% <0.00%> (-86.85%) ⬇️

... and 568 files with indirect coverage changes

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

@ndr-brt ndr-brt merged commit 2ea0ecc into eclipse-edc:main Oct 20, 2023
17 checks passed
@ndr-brt ndr-brt deleted the 3552-api-required-properties branch October 20, 2023 07:49
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.

api docs: add "requires" attribute on request bodies
5 participants