Render html from openapi spec generated by typespec

[munishchouhan]

This PR will do the followings:

1. Move typespec to resources
2. create gradle task to install and compile typespec to generate openapi.yaml
3. create html to render openapi using swagger ui

[pditommaso]

Not sure we should include this stuff within wave backend

[munishchouhan]

Not sure we should include this stuff within wave backend

so we want to host them separately?

[pditommaso]

Think would make more sense, either in the main docs or a mini dedicated app. Tagging @ewels

[ewels]

Yup, I'd expect to keep just the typespec in the repo and have everything else compiled and hosted separately. Where that happens I don't have a strong opinion on - either the Wave service itself? Or the docs website? (NB: Not the docs repo).

Tagging @llewellyn-sl @andrew-dawson-seqera

[ewels]

Looks like the Platform API docs are hosted at https://cloud.seqera.io/openapi/index.html

So Wave docs could live at https://wave.seqera.io/openapi/index.html for example?

[pditommaso]

That's fine. Then we need to create a mini nginx service to render the docs.

[munishchouhan]

[pditommaso]

Nice, then we need to including this container build in the same process for the wave app container.

[munishchouhan]

Nice, then we need to including this container build in the same process for the wave app container.

ok sure

[ewels]

Not sure what the web UI is there - any chance that we can use Swagger so that it has the same look + feel as https://cloud.seqera.io/openapi/index.html please?

[munishchouhan]

Not sure what the web UI is there - any chance that we can use Swagger so that it has the same look + feel as https://cloud.seqera.io/openapi/index.html please?

ok I will look into it

[munishchouhan]

now using swagger ui

[pditommaso]

Nice

[pditommaso]

typespec/tag-and-push-openapi.sh

[munishchouhan]

it is to build and push openapi container

[pditommaso]

should this be updated manually?

[munishchouhan]

yes for now, typespec.yml only runs when there is a change in typespec folder and to make a doc release, we need a change there in the commit to make typespec ci run

[pditommaso]

Would not be simpler just using a placeholder value e.g. 0.0.0 and use sed command or something similar to update it using the version in VERSION ?

[munishchouhan]

yes, that can be an option, i will move doc release to build.yml too
to not rely on typespec chnages

[munishchouhan]

ok better adding VERSION path in typespec.yml, so that it runs when we change VERSION

[munishchouhan]

done

[munishchouhan]

Tested successfully in dev

[pditommaso]

tag-and-push-openapi.sh

[munishchouhan]

done

[pditommaso]

They provide an un unprivileged image that does not require this https://hub.docker.com/r/nginxinc/nginx-unprivileged

[munishchouhan]

done

[munishchouhan]

tested in dev: