From e9f5dd99657d44b7f9d779c9860005ac6b31a618 Mon Sep 17 00:00:00 2001
From: David Trattnig <david.trattnig@o94.at>
Date: Thu, 12 Mar 2020 19:47:25 +0100
Subject: [PATCH] Added API specs to documentation.
---
docs/engine-features.md | 72 +++++++++++++++++++++++++++++++++++++++++
1 file changed, 72 insertions(+)
diff --git a/docs/engine-features.md b/docs/engine-features.md
index 27f4b799..23bc8695 100644
--- a/docs/engine-features.md
+++ b/docs/engine-features.md
@@ -86,14 +86,86 @@ The Swagger Specification of a Track Service entry as YAML looks like this:
* `/api/v1/report/$MONTH` ...... Returns all playout details for the given month in the format `YYYY-MM`
+```yaml
+schemas:
+ Report:
+ properties:
+ fallback_type: {}
+ id: {}
+ playlist_id: {}
+ schedule.category: {}
+ schedule.is_repetition: {}
+ schedule.languages: {}
+ schedule.musicfocus: {}
+ schedule.schedule_end: {}
+ schedule.schedule_id: {}
+ schedule.schedule_start: {}
+ schedule.show_funding_category: {}
+ schedule.show_hosts: {}
+ schedule.show_id: {}
+ schedule.show_name: {}
+ schedule.show_type: {}
+ schedule.topic: {}
+ schedule.type: {}
+ schedule_fallback_id: {}
+ show_fallback_id: {}
+ station_fallback_id: {}
+ track: {}
+ track_start: {}
+ type: object
+ info:
+ title: Swagger API Specification for Aura Engine
+ version: 1.0.0
+ openapi: 3.0.2
+```
+
**Schedule API**: Retrieves information on the programme.
* `/api/v1/schedule/upcoming` .. Returns the next three schedules, after the one currently playing.
+
+```yaml
+schemas:
+ Schedule:
+ properties:
+ id: {}
+ schedule: {}
+ schedule_id: {}
+ schedule_start: {}
+ show_hosts: {}
+ show_id: {}
+ show_name: {}
+ show_type: {}
+ type: object
+ info:
+ title: Swagger API Specification for Aura Engine
+ version: 1.0.0
+ openapi: 3.0.2
+```
+
+
**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.
+
+```yaml
+schemas:
+ Clock:
+ properties:
+ current: {}
+ next: {}
+ track: {}
+ track_id: {}
+ track_start: {}
+ type: object
+ info:
+ title: Swagger API Specification for Aura Engine
+ version: 1.0.0
+ openapi: 3.0.2
+```
+
+
## Web Applications
* `/trackservice` ................. Web Application for displaying the Track-Service
--
GitLab