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

Fix API link #42

Open
nitrosx opened this issue Feb 1, 2024 · 6 comments
Open

Fix API link #42

nitrosx opened this issue Feb 1, 2024 · 6 comments

Comments

@nitrosx
Copy link
Member

nitrosx commented Feb 1, 2024

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

@sbliven
Copy link
Member

sbliven commented Feb 1, 2024

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.

@dani-lbnl
Copy link

dani-lbnl commented Mar 11, 2024

API link is still broken https://scicatproject.github.io/api/

@nitrosx
Copy link
Member Author

nitrosx commented Mar 13, 2024

@nitrosx
Copy link
Member Author

nitrosx commented Mar 13, 2024

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

@sbliven
Copy link
Member

sbliven commented Oct 22, 2024

@nitrosx Would it be OK to point to the ESS swagger page until we get this building statically from CI?

https://scicat.ess.eu/explorer

@nitrosx
Copy link
Member Author

nitrosx commented Oct 23, 2024

@sbliven please go ahead.
We should discuss about having one of this for the latest commit on master and one for the latest release

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

No branches or pull requests

3 participants