From acc18f2c9735c3db54709e5a76faa589c1867f24 Mon Sep 17 00:00:00 2001
From: David Trattnig <david.trattnig@o94.at>
Date: Mon, 2 Mar 2020 18:21:23 +0100
Subject: [PATCH] Documentation for track service API.

---
 README.md               |  2 ++
 docs/engine-features.md | 11 +++++++++++
 2 files changed, 13 insertions(+)

diff --git a/README.md b/README.md
index b346f45a..420b2307 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,8 @@ specifically build for the requirements of community radios.
 - Multichannel Line-out
 - Blank Detenction / Silence Detecter
 - Auto Pilot a.k.a. Fallback Handling
+- API to query Track-Service
+- API to query programme
 
 Read more on the [Engine Features](docs/engine-features.md) page.
 
diff --git a/docs/engine-features.md b/docs/engine-features.md
index 59598897..2c68da0a 100644
--- a/docs/engine-features.md
+++ b/docs/engine-features.md
@@ -49,3 +49,14 @@ fallback handling scenarios. The available fallbacks are evaluated in following
 3.2 Station Fallback via local music folder
 
 Note: All filenames in the music folder should be ASCII encoded, otherwise this may cause engine failures.
+
+# Track-Service API
+
+The Track Service API provides following endpoints:
+
+* `/api/v1/` ............. Returns all Track Service entries for the last three hours
+* `/api/v1/$ID` .......... Returns a Track Service entry by ID
+* `/api/v1/current` ...... Returns the currently playing track
+* `/api/v1/day/$DAY` ..... Returns the tracks for a given day formated as `YYYY-MM-DD`
+
+# Programme API
\ No newline at end of file
-- 
GitLab