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.

Sign up for GitHub

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

Jump to bottom

Improve Restful API documentation embeded in FastAPI #2632

Open
nicolargo opened this issue Dec 22, 2023 · 4 comments
Open

Improve Restful API documentation embeded in FastAPI #2632

nicolargo opened this issue Dec 22, 2023 · 4 comments
Labels
documentation enhancement inactive needs contributor

Comments

@nicolargo
Copy link
Owner

The Restful API documentation(generated by Glances) is here: https://github.com/nicolargo/glances/blob/develop/docs/api.rst
But FastAPI embed an online documentation: http://0.0.0.0:61208/docs#/

The goal is to make the online version as close as possible than the one generated by the Glances.
@nicolargo nicolargo added this to the Glances 4.0.0 milestone Dec 22, 2023
@nicolargo nicolargo mentioned this issue Dec 22, 2023
Open
6 tasks
@nicolargo nicolargo modified the milestones: Glances 4.0.0, Glances 4.1.0 Apr 8, 2024
@github-actions GitHub Actions
Copy link

This issue is stale because it has been open for 3 months with no activity.

@nicolargo
Copy link
Owner Author

https://fastapi.tiangolo.com/how-to/custom-docs-ui-assets/?h=docs#include-the-custom-docs-for-static-files

@nicolargo nicolargo removed this from the Glances 4.2.0 milestone Oct 6, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 6, 2024

This issue is available for anyone to work on. Make sure to reference this issue in your pull request. ✨ Thank you for your contribution ! ✨

@github-actions github-actions bot removed the inactive label Oct 7, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 5, 2025

This issue is stale because it has been open for 3 months with no activity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement inactive needs contributor
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nicolargo