Provide auto. Versioning of API and publish API to SwaggerHub

[mkanal]

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

Link

• relates to Provide Swagger UI on Github Pages #500

Hints / Details

• https://app.swaggerhub.com/search?owner=eclipse-tractusx-bot
• Recommendation by DevSecOps Team

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 (eclipse-tractusx-bot)
• https://eclipse-tractusx.github.io/docs-kits/kits/Data%20Chain%20Kit/Software%20Development%20View/Specification has been updated to new swaggerhub documentation
• Provide versioning of IRS api (API version is automatically in sync with the irs release version )

[ds-ext-kmassalski]

PR:
catenax-ng#814

[ds-ext-kmassalski]

Blocked by:
eclipse-tractusx/sig-infra#455

[ds-jhartmann]

If the Swagger Hub Issue is resolved, re-run the publishing step in https://github.com/eclipse-tractusx/item-relationship-service/actions/runs/8339631309

[mkanal]

@jzbmw AC is not achievable create FU story to resolve this within GitHub pages #500 Ready for PO review