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

Add internal API docs #117

Open
zachlipton opened this issue Aug 13, 2020 · 1 comment
Open

Add internal API docs #117

zachlipton opened this issue Aug 13, 2020 · 1 comment
Assignees

Comments

@zachlipton
Copy link
Collaborator

The docs that are in covid-api-specs are somewhat out of date.

I was thinking of using flasgger (or something else—have only done minimal research, but it seemed more lightweight than converting everything over to connexion or something) to generate some API docs out of docstrings in the code, especially so others can see how to push edits if needed.

@zachlipton zachlipton self-assigned this Aug 14, 2020
@zachlipton
Copy link
Collaborator Author

I came up with a convoluted yet seemingly effective way to programmatically turn the sqlalchemy field list into OpenAPI docs so we don't need to maintain all that every time we want to add/change a field. It's going to take some time to flesh out all the API docs though.

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

No branches or pull requests

1 participant