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

Make /static/ directory available on Kubernetes for Swagger docs #1236

Open
psschwei opened this issue Feb 27, 2024 · 5 comments
Open

Make /static/ directory available on Kubernetes for Swagger docs #1236

psschwei opened this issue Feb 27, 2024 · 5 comments
Assignees
Labels
bug Something isn't working

Comments

@psschwei
Copy link
Collaborator

We added Swagger documentation in #1205 .

The pages display fine locally (using docker compose or gunicorn directly), but when running in Kubernetes the page does not render properly as the swagger javascript files are not found (see #1205 (comment) and surround discussion for more details).

I think this is mainly an issue with how Django serves static files... short version is in Kubernetes the static/ directory isn't being served, which means none of the javascript loads, which means no swagger UI.

An appropriate solution would use one of the "production" methods in the above link to serve the /static/ directory for our Django service.

@psschwei psschwei added the bug Something isn't working label Feb 27, 2024
@psschwei
Copy link
Collaborator Author

#1205 (comment) shows a non-production way to make /static/ available

@david-alber
Copy link
Contributor

@psschwei have you decided which of the production methods to serve the /static/ directory is most suitable?

If the issue is still up for grabs, I would like to give it a try :)

@akihikokuroda
Copy link
Collaborator

@david-alber I've been working for another issue. Please go a head. Thanks!

@psschwei
Copy link
Collaborator Author

psschwei commented Mar 4, 2024

Given the short-term plan is to move our docs over to IQP in #1166 , I think we may want to get a little more clarity on that one (where docs will live, how they'll be served, etc.) before we spend too much time spinning up our own version of the docs

For reference, here's the API docs for runtime: https://docs.quantum.ibm.com/api/runtime

@david-alber
Copy link
Contributor

Given the short-term plan is to move our docs over to IQP in #1166 , I think we may want to get a little more clarity on that one (where docs will live, how they'll be served, etc.) before we spend too much time spinning up our own version of the docs

Maybe the Qiskit Runtime API swagger docs can serve as inspiration:
https://us-east.quantum-computing.cloud.ibm.com/openapi/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants