From adcd67514ec53264c176ba4d86ece8419f696e8a Mon Sep 17 00:00:00 2001
From: David Trattnig <david.trattnig@o94.at>
Date: Mon, 9 Mar 2020 09:08:38 +0100
Subject: [PATCH] API Documentation.
---
docs/engine-features.md | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
diff --git a/docs/engine-features.md b/docs/engine-features.md
index ad3bff25..2c271776 100644
--- a/docs/engine-features.md
+++ b/docs/engine-features.md
@@ -50,14 +50,14 @@ fallback handling scenarios. The available fallbacks are evaluated in following
Note: All filenames in the music folder should be ASCII encoded, otherwise this may cause engine failures.
-# Track-Service API
+## API Endpoints
-The Track Service API provides following endpoints:
+**Track Service API**: These endpoints provide information on the played tracks, their schedules and shows.
-* `/api/v1/` ............. Returns all Track Service entries for the last three hours
+* `/api/v1/` ............. Returns all Track Service entries for the current day
* `/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`
+* `/api/v1/current` ...... Returns the track currently playing
+* `/api/v1/day/$DAY` ..... Returns all tracks for a given day formated as `YYYY-MM-DD`
The Swagger Specification of a Track Service entry as YAML looks like this:
@@ -82,4 +82,6 @@ The Swagger Specification of a Track Service entry as YAML looks like this:
paths: {}
```
-# Programme API
\ No newline at end of file
+**Reporting API**: Create monthly reports using this endpoint.
+
+* `api/v1/report/$MONTH` ...... Returns all playout details for the given month in the format `YYYY-MM`
\ No newline at end of file
--
GitLab