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

DWI-29 Fast API Docs #8

Merged
merged 11 commits into from
Oct 16, 2024
Merged

DWI-29 Fast API Docs #8

merged 11 commits into from
Oct 16, 2024

Conversation

niquerio
Copy link
Contributor

@niquerio niquerio commented Oct 7, 2024

So far this has some breadcrumbs for filling out documentation in FastAPI.

There's some application metadata changes in aim/digifeeds/database/main.py. Documentation

There's an example item described in aim/digifeeds/database/schemas.py. Documentation

In main.py and in schemas.py there's example of how to document non-200 responses. Documentation

In main.py there's an example of using a docstring to describe an api path. Documentation

@niquerio niquerio marked this pull request as ready for review October 16, 2024 16:02
@niquerio niquerio merged commit 5266b1e into main Oct 16, 2024
1 check passed
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

Successfully merging this pull request may close these issues.

2 participants