Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Add better documentation for OpenAPI#37

Open
whitfin wants to merge 2 commits intojtom38:masterfrom
whitfin:better-docs
Open

Add better documentation for OpenAPI#37
whitfin wants to merge 2 commits intojtom38:masterfrom
whitfin:better-docs

Conversation

@whitfin
Copy link

@whitfin whitfin commented Jan 6, 2025

This updates the handler with a brief docstring, and adds a response model for the autogenerated OpenAPI documentation by FastAPI.

I also updated the values of the enum to have a consistent case; it's more likely to mistype Healthy rather than either HEALTHY or healthy.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant