[DOCU]: Deploy v2 API documentation to github pages

[CubicrootXYZ]

Describe your improvement

Deploy the currently uploaded artifact as github pages

What part does your request relates to?

API documentation

Where do you expect this information to be?

Unsure

Checklist

• [X] I was not able to finde the proposed information in the README, API docu and Wiki
• [X] I confirmed that there is no other issue requesting the same improvements

[kanz-1805]

Hi @CubicrootXYZ I was looking into your API documentation requirement. If it is REST API, I'd love to help you with the documentation. Thanks!

[CubicrootXYZ]

Hi @CubicrootXYZ I was looking into your API documentation requirement. If it is REST API, I'd love to help you with the documentation. Thanks!

Thanks for offering your assistance, I really do appreciate it. The service offers a HTTP Restful API, it is already documented in the code itself. There is a CI job that builds an OpenAPI specification file from it and renders it into a nice looking HTML page.

The task for this issue is to get the deployment of this HTML file working. I already added another CI job for this but it does not work. If you want to tackle this I recommend looking into the error message this job produced.