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

DOC: add a dedicated section for Xpublish's built-in REST API endpoints #55

Open
benbovy opened this issue Sep 18, 2020 · 0 comments
Open

DOC: add a dedicated section for Xpublish's built-in REST API endpoints #55

benbovy opened this issue Sep 18, 2020 · 0 comments
Assignees
@abkfenris
Labels
documentation Improvements or additions to documentation

Comments

@benbovy
Copy link
Contributor

benbovy commented Sep 18, 2020

Currently the built-in API routes are briefly documented in the Tutorial section, but if more routers are added (#50) it will be nice to have a separate, more detailed section.

https://sphinxcontrib-openapi.readthedocs.io/ could be useful to automatically generate that page.
@benbovy benbovy added the documentation Improvements or additions to documentation label Sep 18, 2020
@abkfenris abkfenris self-assigned this May 12, 2023
abkfenris added a commit to abkfenris/xpublish that referenced this issue May 12, 2023
@abkfenris
Start adding REST API docs
a84e193 
Works on xpublish-community#55
@abkfenris abkfenris mentioned this issue May 12, 2023
Merged
abkfenris added a commit that referenced this issue Jun 21, 2023
@abkfenris
Start adding REST API endpoint docs (#196)
2050e5a 
* Start adding REST API docs

Works on #55

* Set minimum FastAPI pin due to Path params changing

* Fix filtering of dataset info and add
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@abkfenris abkfenris

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@abkfenris @benbovy