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

Show OpenAPI documentation for API tags #11083

Merged
merged 1 commit into from Jan 8, 2021

Conversation

davelopez
Copy link
Contributor

After merging #11056, I noticed that the api_tags_metadata was not passed to the FastAPI constructor.
This should fix it and show the documentation for tags like this:

image

@bgruening bgruening merged commit 45c796f into galaxyproject:dev Jan 8, 2021
@davelopez davelopez deleted the davelopez-patch-1 branch January 8, 2021 16:12
@hexylena
Copy link
Member

Quick question for the release notes, apologies for not following this stuff more closely, how do I get to this page? Is it something that's accessible from Galaxy, or some separate documentation that gets rendered?

@davelopez
Copy link
Contributor Author

Hi @hexylena, you can access it at http://127.0.0.1:8000/docs but it is currently only supported in dev if you launch galaxy through uvicorn here.

@hexylena
Copy link
Member

Thanks for the quick reply. Makes sense! I'll wait until this is visible in prod somewhere to mention it in the user-facing ones then. (and, briefly, any reason for /docs instead of /api/docs? or just /api? I tried those two before asking here :) )

@mvdbeek
Copy link
Member

mvdbeek commented Feb 17, 2021

No reason beyond it being the default route. I guess api/docs would be more consistent.

@hexylena
Copy link
Member

hexylena commented Feb 17, 2021

Only asking because I still have a vague hope of oneday seeing the python/user/admin docs at /docs :)

@davelopez
Copy link
Contributor Author

+1 for the /api/docs route :)

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

Successfully merging this pull request may close these issues.

None yet

4 participants