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

chore: publish IdentityHub API to SwaggerHub #207

Conversation

paullatzelsperger
Copy link
Member

@paullatzelsperger paullatzelsperger commented Dec 27, 2023

What this PR changes/adds

Adds a GH Actions workflow that publishes the (generated) OpenAPI spec to SwaggerHub.

Why it does that

Documentation

Further notes

I also converted all DELETE /... endpoints to POST /.../delete endpoints, because SwaggerHub complained that "DELETE calls cannot contain request bodies". The spec isn't super specific on the topic and doesn't explicitly forbid it, but upon further investigation, I read that some load balancers and API gateways may discard or even reject DELETE requests with a 400 that contain a body.

Linked Issue(s)

Closes #206

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

@paullatzelsperger paullatzelsperger added documentation Improvements or additions to documentation dcp api breaking-change Will require manual intervention for version update labels Dec 27, 2023
@paullatzelsperger paullatzelsperger merged commit 4d83ad8 into eclipse-edc:main Dec 27, 2023
14 checks passed
@paullatzelsperger paullatzelsperger deleted the chore/publish_to_swaggerhub branch December 27, 2023 14:12
paullatzelsperger added a commit to paullatzelsperger/IdentityHub that referenced this pull request Dec 28, 2023
* chore: publish IH API to SwaggerHub

* fix api

* DEPENDENCIES
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api breaking-change Will require manual intervention for version update dcp documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Publish IdentityHub APIs to SwaggerHub
2 participants