Source code for api_example.endpoints.health

import fastapi

from api_example.endpoints.router import router

endpoint_description = """
Returns "OK" with a 200 status code (meaning that everything is fine).

That API endpoint may be used for instance for livelyness and readyness probes.
"""




@router.get("/health", description=endpoint_description, status_code=fastapi.status.HTTP_200_OK)
async def health() -> str:
    return "OK"