From 7e339972ad94bfb441dbd57f46c9cb77fa9b60ea Mon Sep 17 00:00:00 2001
From: Thomas Kaul <4159106+dtslvr@users.noreply.github.com>
Date: Mon, 7 Oct 2024 17:49:29 +0200
Subject: [PATCH] Feature/extend public api with health check endpoint (#3825)

* Add health check endpoint documentation

* Update changelog
---
 CHANGELOG.md |  6 ++++++
 README.md    | 14 ++++++++++++++
 2 files changed, 20 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 54cad4be4..80b0236d8 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.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
diff --git a/README.md b/README.md
index 477554749..989cc37ea 100644
--- a/README.md
+++ b/README.md
@@ -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