This commit is contained in:
2020-06-04 22:19:27 +00:00
parent e04440875c
commit f81360b2d0

View File

@@ -21,9 +21,10 @@ namespace AyaNova.Api.Controllers
}
/// <summary>
/// Get Health
/// Also available at /health on server root
/// confirms liveness and also db availability
/// Get Health (verify server AND database connection)
/// Note: for server monitoring or automation / orchestration use such as Docker prefer the mirror of this route at the server root: [api_server_url]/health
/// as it avoids API versioning issues
/// i.e. Docker: HEALTHCHECK CMD curl --fail http://localhost:5000/health || exit
/// </summary>
/// <remarks>Provides an indication about the health of the API</remarks>
/// <response code="200">API is healthy</response>