Add healthcheck to docs

nhsuk · May 26, 2021 · 7bfb4e8 · 7bfb4e8
1 parent 14a929b
commit 7bfb4e8
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -75,6 +75,14 @@ Free-text user comments.
 }
 ```
 
+### Healthcheck
+
+Test the health of the function. Useful for monitoring.
+
+Returns a 503 response if database is unreachable. 200 OK otherwise.
+
+`GET /healthcheck/`
+
 ## Contributing
 
 ### Tests