-
Notifications
You must be signed in to change notification settings - Fork 10
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
Fix API link #42
Comments
Can't we generate the swagger page in our CI? I'd prefer this to be hosted on github rather than requiring access to a scicat instance. |
API link is still broken https://scicatproject.github.io/api/ |
A quick search online on "static swagger html pages", brought me to the following resources:
I think we should test the solution offer in the last link |
The link to the API has been temporarily removed, until we find a way to produce a static version of the swagger API to include in the documentation |
@nitrosx Would it be OK to point to the ESS swagger page until we get this building statically from CI? |
@sbliven please go ahead. |
Currently the documentation show a broken link to the API on the navigation in the left bar.
We need to remove such link and add a page where we explain that swagger interface is ultimate source of true regarding the API.
We should also make sure that we have instructions on how to spin up a local instance of scicat and access the swagger interface
The text was updated successfully, but these errors were encountered: