Provide Swagger UI on Github Pages #772
Description
As a external contributor ,
I want a Swagger UI on GitHub Pages,
so that I have a detailed overview of provided APIs and are able to download the OpenApi specification.
Hints / Details
- It is not possible to publish our API on SwaggerHub because there are already three APIs published (Provide API on swaggerhub.com #652). This is the maximum amount in the free tier. Tractus-X is not planning to upgrade it. Therefore, we have to find an alternative to SwaggerHub. A proposed alternative are the GitHub Pages for each project. (https://eclipse-tractusx.github.io/traceability-foss/docs/)
- An example on how to achieve that, can be found in the EDC repository: https://github.com/eclipse-edc/.github/blob/main/.github/workflows/publish-openapi-ui.yml
Acceptance Criteria
- Swagger UI is available in the Trace-X GitHub Pages: https://eclipse-tractusx.github.io/traceability-foss/docs/
- KIT documentation must be updated
Out of Scope
- ...