Provide API on swaggerhub.com

[mkanal]

As team,
I want to publish api on swaggerhub
so that the api documentation is available for external contributors

Hints / Details

https://app.swaggerhub.com/search?owner=eclipse-tractusx-bot

For APIs with reference implementation:

Please use (or adapt existing) automated workflows to publish on SwaggerHub. Maintain your openAPI.yaml and the publishing workflow in the repository of the reference implementation. Remove everything related to that from the website repo and only link to SwaggerHub in your KIT from now on.
We utilize a user provided by the Eclipse Foundation to publish on SwaggerHub.
Credentials for this user can be used through the eclipse-tractusx GitHub org secrets and can be utilized in automated workflows.
Pay special attention to the "swaggerHub" CLI commands.
The location where the openAPI file is maintained may vary. The BPDM example showcases how the application is initiated to download and publish the current file from that location.

  SWAGGERHUB_API_KEY: ${{ secrets.SWAGGERHUB_API_KEY }}
  SWAGGERHUB_USER: ${{ secrets.SWAGGERHUB_USER }}

Examples:
BPDM Certificate Management: https://github.com/eclipse-tractusx/bpdm-certificate-management/blob/main/.github/workflows/publish-swagger-hub.yaml
Digital Product Pass: https://github.com/eclipse-tractusx/digital-product-pass/blob/main/.github/workflows/publish-swagger-hub.yaml
Tractus-X EDC: https://github.com/eclipse-tractusx/tractusx-edc/blob/main/.github/workflows/publish-swaggerhub.yaml
If you have any questions, please use our “Tractus-X Office Hour” and prepare accordingly before merging.

Outcome / Acceptance Criteria

Outcome

Acceptance Criteria

• API is available on swaggerhub.com (owner:eclipse-tractusx-bot)
• Documentation has been updated

[mkanal]

@ds-lcapellino I am not able to see the api right now. Please add link to swaggerhub once this is published. Please add a link where to find documentation adjustments. Thank you very much.

[ds-lcapellino]

• API is available on swaggerhub.com (owner:eclipse-tractusx-bot)
  This is currently not possible, because the maximum amount of APIs is already reached (3)
  

• Documentation has been updated

[ds-lcapellino]

Created issue at sig-infra Team: eclipse-tractusx/sig-infra#455

[ds-lcapellino]

Currently, it is not possible to publish more than three APIs on SwaggerHub. It is proposed to publish the OpenApi sepcification of each project on their own GitHub Page. I've created #772 as a followup story to tackle this.

For more information, why it is not possible to upload more than three APIs, please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues/4197

[ds-lcapellino]

Followup: #772

[mkanal]

PO acceptance during daily.