Skip to content

Commit 50a824f

Browse files
committed
Add health endpoint docs
1 parent 6343e98 commit 50a824f

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

Diff for: README.md

+13
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,19 @@ To distinguish between a "query error" and a "schema error," you can check the `
7878
- `BAD_PAYLOAD`: The payload is invalid (see message for details).
7979
- `INTERNAL_ERROR`: Other errors.
8080

81+
### Health Check
82+
83+
Call `GET /healthz` endpoint to check the health of the service.
84+
85+
```bash
86+
curl --request GET \
87+
--url http://api-endpoint:8080/healthz
88+
```
89+
90+
```plain
91+
OK
92+
```
93+
8194
## License
8295

8396
Apache-2.0. See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)