From 12ffab681f62adec8816126e41cf9d05025a66da Mon Sep 17 00:00:00 2001 From: David Trattnig <david.trattnig@o94.at> Date: Thu, 12 Mar 2020 19:39:15 +0100 Subject: [PATCH] Documentation stubs for new features. --- README.md | 5 ++++- docs/engine-features.md | 10 ++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 43a714bc..06f9998b 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,10 @@ specifically build for the requirements of community radios. - Blank Detenction / Silence Detecter - Auto Pilot a.k.a. Fallback Handling - API to query Track-Service -- API to query programme +- API to query monthly reports +- API to query data for a studio clock +- Web Application for displaying the Track-Service +- Web Application for displaying the studio clock Read more on the [Engine Features](docs/engine-features.md) page. diff --git a/docs/engine-features.md b/docs/engine-features.md index eb84947c..27f4b799 100644 --- a/docs/engine-features.md +++ b/docs/engine-features.md @@ -89,3 +89,13 @@ The Swagger Specification of a Track Service entry as YAML looks like this: **Schedule API**: Retrieves information on the programme. * `/api/v1/schedule/upcoming` .. Returns the next three schedules, after the one currently playing. + +**Clock API**: Retrieve all data relevant for a studio clock. + +* `/api/v1/clock` .............. Returns the current show, next show, playlist and time left until the next show. + +## Web Applications + +* `/trackservice` ................. Web Application for displaying the Track-Service +* `/clock` ........................ Web Application for displaying the studio clock + -- GitLab