diff --git a/docs/engine-features.md b/docs/engine-features.md index 27f4b799985eb23e7a0cab05dfbc9be4d66fd987..23bc869522693e7b4d2f0199b515d7c4cca4bd22 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