Dear Tractus-X Community,
we will discontinue the use of the openAPI plugin in the KITs with Release 24.05 at the latest.
This decision aims to reduce complexity and ensure the updateability of Docusaurus. Please find the following guidance:
APIs without reference implementation:
After evaluation, a "semi-automated" or "manual" solution is not considered effective.
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:
If you have any questions, please use our “Tractus-X
Office Hour” and prepare accordingly before merging.
Many thanks to Arno, Malte and Sebastian for your support!
Best,
Max & Daniel
--------------------------------------------------------------------
Bayerische Motoren Werke Aktiengesellschaft
Vorstand/Board of Management: Oliver Zipse (Vorsitzender/Chairman),
Ilka Horstmeier, Milan Nedeljković, Pieter Nota,
Nicolas Peter, Frank Weber, Andreas Wendt.
Vorsitzender des Aufsichtsrats/Chairman of the Supervisory Board: Norbert Reithofer
Sitz und Registergericht/Domicile and Court of Registry: München HRB 42243
--------------------------------------------------------------------
