-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Render html from openapi spec generated by typespec #707
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: munishchouhan <[email protected]>
Signed-off-by: munishchouhan <[email protected]>
Not sure we should include this stuff within wave backend |
so we want to host them separately? |
Think would make more sense, either in the main docs or a mini dedicated app. Tagging @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 |
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? |
That's fine. Then we need to create a mini nginx service to render the docs. |
Signed-off-by: munishchouhan <[email protected]>
Signed-off-by: munishchouhan <[email protected]>
Signed-off-by: munishchouhan <[email protected]>
Signed-off-by: munishchouhan <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, then we need to including this container build in the same process for the wave app container.
ok sure |
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 |
This PR will do the followings: