Skip to content

Commit

Permalink
docs(README): Improving usage and endpoint section
Browse files Browse the repository at this point in the history
Signed-off-by: Vincent Boutour <[email protected]>
  • Loading branch information
ViBiOh committed Aug 7, 2021
1 parent 9235709 commit 4d7f495
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ style:
## mocks: Generate mocks
.PHONY: mocks
mocks:
find . -name "mock" -type d -exec rm {} \;
find . -name "mocks" -type d -exec rm {} \;
mockgen -destination pkg/mocks/crud.go -mock_names Crud=Crud -package mocks github.com/ViBiOh/fibr/pkg/provider Crud
mockgen -destination pkg/mocks/auth.go -mock_names Auth=Auth -package mocks github.com/ViBiOh/fibr/pkg/provider Auth
mockgen -destination pkg/mocks/share.go -mock_names App=Share -package mocks github.com/ViBiOh/fibr/pkg/share App
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ You'll find a Kubernetes exemple in the [`infra/`](infra/) folder, using my [`ap

## Endpoints

- `GET /health`: healthcheck of server, respond [`okStatus (default 204)`](#usage) or `503` during [`graceDuration`](#usage) when `SIGTERM` is received
- `GET /ready`: same response than `/health` but it also checks external dependencies availability
- `GET /health`: healthcheck of server, always respond [`okStatus (default 204)`](#usage)
- `GET /ready`: checks external dependencies availability and then respond [`okStatus (default 204)`](#usage) or `503` during [`graceDuration`](#usage) when `SIGTERM` is received
- `GET /version`: value of `VERSION` environment variable
- `GET /metrics`: Prometheus metrics, on a dedicated port [`prometheusPort (default 9090)`](#usage)

Expand Down
2 changes: 1 addition & 1 deletion infra/web.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ spec:
chart:
spec:
chart: app
version: '0.0.73'
version: '0.0.74'
sourceRef:
kind: HelmRepository
name: vibioh
Expand Down

0 comments on commit 4d7f495

Please sign in to comment.