Skip to content

Commit

Permalink
Merge pull request #219 from peejaychilds/health-api-docs
Browse files Browse the repository at this point in the history
document api/v1/healthz endpoint
  • Loading branch information
karimra authored Sep 7, 2023
2 parents 9168854 + 2d5c255 commit c61fff7
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/user_guide/api/api_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,5 @@ api-server:
* [Targets](./targets.md)
* [Cluster](./cluster.md)
* [Other](./other.md)
2 changes: 1 addition & 1 deletion docs/user_guide/api/configuration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# /api/v1/config
# Configuration

## /api/v1/config

Expand Down
18 changes: 18 additions & 0 deletions docs/user_guide/api/other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Other

## /api/v1/healthz

### `GET /api/v1/healthz`

Health check endpoint for Kubernetes or similar

=== "Request"
```bash
curl --request GET gnmic-api-address:port/api/v1/healthz
```
=== "200 OK"
```json
{
"status": "healthy"
}
```

0 comments on commit c61fff7

Please sign in to comment.