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.

Sign up for GitHub

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

Jump to bottom

Switch api spec publication from swaggerhub to github pages #1409

Closed
ndr-brt opened this issue Jul 9, 2024 · 0 comments · Fixed by #1425
Closed

Switch api spec publication from swaggerhub to github pages #1409

ndr-brt opened this issue Jul 9, 2024 · 0 comments · Fixed by #1425
Assignees
@ndr-brt
Labels
documentation Improvements or additions to documentation enhancement New feature or request triage all new issues awaiting classification

Comments

@ndr-brt
Copy link
Contributor

ndr-brt commented Jul 9, 2024 •
edited
Loading

WHAT

Publish openapi ui to github pages instead of swaggerhub

WHY

Currently we're publishing openapi specs to swaggerhub but this brings in some downsides:

  • 3 specs limit (currently we got one, but likely we'd like to split control-plane and data-plane and who knows about the future?)
  • stable versions cannot be overridden (so we can't correct eventual errors in the spec generation)

Github pages instead are more flexible, and we could follow the approach already adopted upstream.

HOW

FURTHER NOTES

we will split data-plane and control-plane api as well

Please be sure to take a look at
our contribution guidelines and
our PR etiquette.
@ndr-brt ndr-brt added documentation Improvements or additions to documentation enhancement New feature or request triage all new issues awaiting classification labels Jul 9, 2024
@github-project-automation github-project-automation bot moved this to Open in EDC Board Jul 9, 2024
@ndr-brt ndr-brt self-assigned this Jul 16, 2024
@ndr-brt ndr-brt mentioned this issue Jul 16, 2024
Merged
@github-project-automation github-project-automation bot moved this from Open to Done in EDC Board Jul 17, 2024
@ndr-brt ndr-brt mentioned this issue Jul 18, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ndr-brt ndr-brt

Labels
documentation Improvements or additions to documentation enhancement New feature or request triage all new issues awaiting classification
Projects
EDC Board
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: publish openapi-ui to github pages Think-iT-Labs/tractusx-edc
1 participant
@ndr-brt