Skip to content

Commit ff7ceb5

Browse files
authored
Update README for new canonical path
/internal/{info/health} is the canonical path. /info and /health are legacy paths.
1 parent 6167c61 commit ff7ceb5

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Code_Checks](https://github.com/OpenConext/Monitor-bundle/actions/workflows/code_checks.yaml/badge.svg)](https://github.com/OpenConext/Monitor-bundle/actions/workflows/code_checks.yaml)
44

5-
A Symfony 5/6/7 bundle that adds a /health and /info endpoint to your application.
5+
A Symfony 5/6/7 bundle that adds an /internal/health and /internal/info endpoint to your application.
66

77
The endpoints return JSON responses. The `/internal/info` endpoint tries to give as much information about the currently installed
88
version of the application as possible. This information is based on the build path of the installation. But also
@@ -55,11 +55,11 @@ When a health check failed the HTTP Response status code will be 503. And the JS
5555
security:
5656
firewalls:
5757
monitor:
58-
pattern: ^/(info|health)$
58+
pattern: ^/internal/(info|health)$
5959
security: false
6060
6161
```
62-
* The /info and /health endpoints should now be available for everybody. Applying custom access restriction is up to
62+
* The /internal/info and /internal/health endpoints should now be available for everybody. Applying custom access restriction is up to
6363
the implementer of this bundle.
6464
6565
## Adding Health Checks

0 commit comments

Comments
 (0)