docs: add example to trg 1.08

[ClosedSourcerer]

Description

This PR is supposed to enhance Tractus Release Guideline 1.08 by adding a concrete example for how to add API documentation to the KITs.

This has been discussed during the community hours on November 29th 2024:

https://github.com/orgs/eclipse-tractusx/projects/61/views/1?pane=issue&itemId=89121776

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

• DEPENDENCIES are up-to-date. Dash license tool. Committers can open IP issues for restricted libs.
  • No code has been added therefore dependencies should be unaffected by this PR
• Copyright and license header are present on all affected files
  • There is neither a copyright nor license header for any of the TRGs.
    • I assume this is intended and have therefore not added copyright or license header.
• Docusaurus builds
  • All pages that are touched by this PR load properly

[ClosedSourcerer]

Dash runner failed because of http 429 "too many requests"
I am not allowed to trigger a re-run and would appreciate it if someone did re-run the dash job.

[main] INFO Querying ClearlyDefined for license data for 500 items.
[main] ERROR Error response from ClearlyDefined HTTP 429
Run changed=$(git diff DEPENDENCIES)

[evegufy]

LGTM 👍

[evegufy]

In the future one could also think of creating tags in the website repo at every release to version the api specs (as far as I understood, currently only the kits documentation is "versioned" via a folder structure).

Suggested change

	- "https://raw.githubusercontent.com/eclipse-tractusx/eclipse-tractusx.github.io/main/openApi/dt/kit_digital-twin-kit-submodel-api_openAPI.yaml"
	- "https://raw.githubusercontent.com/eclipse-tractusx/eclipse-tractusx.github.io/refs/tags/R25.03/openApi/dt/kit_digital-twin-kit-submodel-api_openAPI.yaml"
	- "https://raw.githubusercontent.com/eclipse-tractusx/eclipse-tractusx.github.io/refs/tags/R24.12/openApi/dt/kit_digital-twin-kit-submodel-api_openAPI.yaml"

[ClosedSourcerer]

Thank you for the review.
I agree that versioning the API references is a sensible and the only precise approach.

Afaik, currently all KITs do get "promoted" into the new release, even if there are 0 changes.
With the tagged approach updating the tags for the APIs would become a regular maintanance task that has to be performed every release.

As for the suggested changes:
Since tagging is currently not in place, integrating them would move the example away from the current reality and I want the example to reflect the current reality and not a, for now, unrealised utopia :)

[evegufy]

I used the suggested changed function just to make the possible future enhancement proposal more understandable and I didn't expect them to be implemented as part of this PR.

[stephanbcbauer]

LGTM.

Since we already have a planned feature for upgrading docusaurus and removing open-api plug-in and using the api-hub i just want to mention the reference to this TRG/PR eclipse-tractusx/sig-release#985