Skip to content

Commit

Permalink
Documentation improvements.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexliesenfeld committed Jul 9, 2021
1 parent 41317df commit 7fceffe
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,8 @@ The data that is returned as part of health check results usually contains sensi
For this reason, this library provides support for authentication middleware that allows you to hide health details
or entirely block requests based on authentication success.

Example: Based on the example below, the authentication middleware will respond with a JSON response body that only
### Example
Based on the example below, the authentication middleware will respond with a JSON response body that only
contains the health status, and the corresponding HTTP status code (in this case HTTP status code 503 and JSON response
body `{ "status":"DOWN" }`).

Expand Down

0 comments on commit 7fceffe

Please sign in to comment.