Browse Source
Feature/extend public api with health check endpoint (#3825)
* Add health check endpoint documentation
* Update changelog
pull/3965/head
Thomas Kaul
3 months ago
committed by
GitHub
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with
20 additions and
0 deletions
-
CHANGELOG.md
-
README.md
|
|
|
@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file. |
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
|
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
|
|
|
|
|
|
|
## Unreleased |
|
|
|
|
|
|
|
### Added |
|
|
|
|
|
|
|
- Extended the _Public API_ with the health check endpoint (experimental) |
|
|
|
|
|
|
|
## 2.113.0 - 2024-10-06 |
|
|
|
|
|
|
|
### Added |
|
|
|
|
|
|
|
@ -163,6 +163,20 @@ You can get the _Bearer Token_ via `POST http://localhost:3333/api/v1/auth/anony |
|
|
|
|
|
|
|
Deprecated: `GET http://localhost:3333/api/v1/auth/anonymous/<INSERT_SECURITY_TOKEN_OF_ACCOUNT>` or `curl -s http://localhost:3333/api/v1/auth/anonymous/<INSERT_SECURITY_TOKEN_OF_ACCOUNT>`. |
|
|
|
|
|
|
|
### Health Check (experimental) |
|
|
|
|
|
|
|
#### Request |
|
|
|
|
|
|
|
`GET http://localhost:3333/api/v1/health` |
|
|
|
|
|
|
|
**Info:** No Bearer Token is required for health check |
|
|
|
|
|
|
|
#### Response |
|
|
|
|
|
|
|
##### Success |
|
|
|
|
|
|
|
`200 OK` |
|
|
|
|
|
|
|
### Import Activities |
|
|
|
|
|
|
|
#### Prerequisites |
|
|
|
|
