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

Start adding REST API endpoint docs #196

Merged
merged 4 commits into from
Jun 21, 2023

Conversation

abkfenris
Copy link
Member

@abkfenris abkfenris commented May 12, 2023

An initial pass at including the API Endpoints in the docs. FastAPI isn't including the return types when available in the OpenAPI spec, which I haven't spent too much time debugging.

This depends on running docs/source/api/generate_openapi.py before generating the docs and after any changes that may change the endpoint signatures. It's not required to be run to work on other parts of the docs, those sections should error and be blank instead.

Additionally did a little re-arranging of the API docs, and added sections for each included plugin.

image

Rendered PR docs:

Works on #55

@abkfenris abkfenris marked this pull request as draft May 12, 2023 16:09
@abkfenris
Copy link
Member Author

And apparently I have an old version of FastAPI locally.

@abkfenris
Copy link
Member Author

I think that changed in 0.78.0 https://github.com/tiangolo/fastapi/releases/tag/0.78.0 so clearly,

python -m pip list | grep fastapi                                         
fastapi                       0.77.1

@abkfenris abkfenris added the documentation Improvements or additions to documentation label May 12, 2023
@abkfenris abkfenris requested a review from benbovy May 12, 2023 17:16
@abkfenris abkfenris marked this pull request as ready for review May 12, 2023 17:16
@abkfenris abkfenris merged commit 2050e5a into xpublish-community:main Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant