Skip to content
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

Open
wants to merge 12 commits into
base: master
Choose a base branch
from

Conversation

munishchouhan
Copy link
Member

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 rapiddoc

Signed-off-by: munishchouhan <[email protected]>
@munishchouhan munishchouhan linked an issue Oct 21, 2024 that may be closed by this pull request
Signed-off-by: munishchouhan <[email protected]>
@munishchouhan munishchouhan self-assigned this Oct 21, 2024
@pditommaso
Copy link
Collaborator

Not sure we should include this stuff within wave backend

@munishchouhan
Copy link
Member Author

Not sure we should include this stuff within wave backend

so we want to host them separately?

@pditommaso
Copy link
Collaborator

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

@ewels
Copy link
Member

ewels commented Oct 21, 2024

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
Copy link
Member

ewels commented Oct 21, 2024

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
Copy link
Collaborator

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

@munishchouhan
Copy link
Member Author

Screenshot 2024-10-23 at 13 07 15

Copy link
Collaborator

@pditommaso pditommaso left a 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.

@munishchouhan
Copy link
Member Author

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

ok sure

@ewels
Copy link
Member

ewels commented Nov 18, 2024

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
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Render API docs from TypeSpec model
3 participants