[EPIC] Review and consolidate the AURA API for duplicated, nested endpoints
[EPIC] Future-proof AURA API (#192)
Parent:Currently many API endpoints in Steering do the same thing. For example the endpoint to create a Timeslot Note has 4 variations.
The overall AURA API design should be reviewed and cleaned up.
For the API overview check api.aura.radio.
List of deprecated endpoints
These steering
nested routes are deprecated and will be removed:
deprecated route | replacement route | additional JSON parameters |
---|---|---|
/shows/:showId/notes/ | /notes/ | showId |
/shows/:showId/notes/:noteId/ | /notes/:noteId/ | |
/shows/:showId/schedules/ | /schedules/ | showId |
/shows/:showId/schedules/:scheduleId/ | /schedules/:scheduleId/ | |
/shows/:showId/schedules/:scheduleId/timeslots/ | /timeslots/ | scheduleId |
/shows/:showId/schedules/:scheduleId/timeslots/:timeslotId/note/ | /notes/ | timeslotId |
/shows/:showId/schedules/:scheduleId/timeslots/:timeslotId/note/:noteId/ | /notes/:noteId/ | |
/shows/:showId/timeslots/ | /timeslots/ | showId |
/shows/:showId/timeslots/:timeslotId/ | /timeslots/:timeslotId/ | |
/shows/:showId/timeslots/:timeslotId/note/ | /notes/ | timeslotId |
/shows/:showId/timeslots/:timeslotId/note/:noteId/ | /notes/:noteId/ |
These tank
nested routes are deprecated and will be removed:
deprecated route | replacement route | additional JSON parameters |
---|---|---|
/shows/:showId/imports | /imports | showId |
/shows/:showId/files | /files | showId |
/shows/:showId/files/:fileId | /files/:fileId | |
/shows/:showId/files/:fileId/usage | /files/:fileId/usage | |
/shows/:showId/files/:fileId/logs | /files/:fileId/logs | |
/shows/:showId/files/:fileId/import | /files/:fileId/import | |
/shows/:showId/files/:fileId/upload | /files/:fileId/upload | |
/shows/:showId/playlists | /playlists | showId |
Edited by Ernesto Rico Schmidt