Extend and refine example values in Steering API
[EPIC] Future-proof AURA API (aura#192)
Parent:Go through all example values and check if there schema/values are correct.
Examples with invalid values
The examples in the Steering API hold missing values.
E.g. the example for the endpoint /api/v1/shows/{show_pk}/schedules/
is
[
{
"id": 0,
"rrule": 0,
"show": 0,
"byweekday": 0,
"dstart": "2022-05-03",
"tstart": "string",
"tend": "string",
"until": "2022-05-03",
"by_weekday": 0,
"first_date": "2022-05-03",
"start_time": "string",
"end_time": "string",
"last_date": "2022-05-03",
"is_repetition": true,
"add_days_no": 0,
"add_business_days_only": true,
"default_playlist_id": 0
}
]
Note the values for dstart
and tend
should represent a time value. Instead they are holding the value string
.
All examples should be reviewed an replaced with functional values.
Examples with invalid properties/schema definitions
Many examples list additionalProp{i}
properties, which are not actual properties.
"notes": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"playlists": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
Examples with missing properties
The docs for the POST /schedule
endpoint state to pass following JSON in the body:
{
"schedule": {
"addBusinessDaysOnly": true,
"addDaysNo": 0,
"byWeekday": 0,
"defaultPlaylistId": 0,
"dryrun": true,
"endTime": "string",
"firstDate": "2024-04-16",
"isRepetition": true,
"lastDate": "2024-04-16",
"startTime": "string"
},
"solutions": {
"additionalProp1": "theirs",
"additionalProp2": "theirs",
"additionalProp3": "theirs"
},
"notes": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
},
"playlists": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}
But the actual arguments should look like this, including the showId
:
{
"byWeekday": 0,
"firstDate": "2023-01-02",
"isRepetition": false,
"rruleId": 5,
"showId": 1,
"startTime": "19:00:00",
"endTime": "19:30:00",
"lastDate": "2023-12-31"
}
Edited by David Trattnig