API Required for On Demand Show Adding

[OStillman]

Revamp Endpoint for Adding an On Demand Show. This needs to be an API driven endpoint with clear entry/exit points, error catching and fully configured for use

Must Contain:

• [x] Endpoint in Endpoint Control
• [x] On Demand Addition File
• [x] Input Sanitisation inc. JSON Schema
• [x] Error Catching - Both User & Server
• [x] Fully Documented Endpoint Usage & Flow

[OStillman]

Branch V1.1.1-On-Demand-API Set up to for On Demand API Revamp

[OStillman]

Endpoint = /od Method = POST DB Table = ODShows & channels (for service attribute)

[OStillman]

Each request requires:

• id (auto generated)
• name
• service (channel foreign key)
  • select * from channels where type == "OD";
  • When adding to DB, we need the ID, how are we sending via the API?
  • API can provide all OD service and their associated details + ID number.
  • Requester should know the OD service ID the new entry is associated with.
  • API will check the received ID is an OD show and refuse if not
• watching (Y/N)
• episode (number) - Optional
• series (number) - Optional
• tags (array of strings)

[OStillman]

Progress Update:

• OD Add Endpoint Created
• Input validation with valid error outputs created
• Can add to database

TODO:

• In /API/db/od.py need to add check for Service - does it exist and is it an OD service?
  • If not and IS a channel for Live - user cannot add and needs to be told
  • If not and IS NOT a channel for Live - user cannot add but will be told they need to register the OD service to be able to add a show to it

[OStillman]

Progress update:

• Re-wrote the OD Add enpoint - data loss...
• Can add to database, with tags added as required and linked in the link table

TODO:

• As before check the service (channel). HAS to be OD and HAS to exist - report if either of these are invalid and do not add show

[OStillman]

Completed.

Findings

• Need to consider "admin" endpoints e.g. Service/Channel Additions