Skip to content

Commit 0b95bd5

Browse files
committed
Add documentation to the README for both Health Check and Remote Reload
1 parent fa6cd0b commit 0b95bd5

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,16 @@ Alternatively, you can use `go get`:
6060
go get github.com/danielgtaylor/apisprout
6161
```
6262

63+
## Extra Features
64+
65+
### Remote Reload
66+
67+
If your API spec is loaded from a remote URL, you can live-reload it by hitting the `/__reload` endpoint.
68+
69+
### Health Check
70+
71+
A simple endpoint which returns status code `200` is available at `/__health`. This endpoint successfully returns `200` even if `--validate-server` is turned on, and the endpoint is being accessed from a non-validated host.
72+
6373
## Contributing
6474

6575
Contributions are very welcome. Please open a tracking issue or pull request and we can work to get things merged in.

0 commit comments

Comments
 (0)