Add support for adLibOptions property in executeAdLib

[scriptorian]

This PR has been opened by SuperFly.tv on behalf of EVS Broadcast Equipment.

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Feature

What is the current behaviour? (You can also link to an open issue here)

The playlist API request executeAdLib allows the client to trigger adLibs that have been created by the blueprints while loading a rundown. The endpoint offers some options for the way these adLibs will be executed though the use of the actionType property that sets a particular trigger mode.

The client discovers the available adLibs and actionTypes by subscribing to the adLibs subscription in the Live Status Gateway (LSG).

What is the new behaviour (if this is a feature change)?

This change adds a new parameter adLibOptions to the executeAdLib request, allowing the client to modify specific properties of the adLib not available through trigger modes, for example the required duration of a video clip.

The adLibOptions property should conform to the optionsSchema that is provided in the adLibs subscription of the LSG thanks to PR #1221. The changes in combination allow the options property to be passed to the blueprints and validated before being used to modify the adLib execution.

The optionsSchema is expected to support only simple changes to the rundown-created adLibs and the properties will normally be optional. The exception to this is templateAdLibs where some required properties are not known during rundown loading. The options validation in this case will ensure that all necessary properties are available before executing the adLib.

Other information:

Status

• [x] PR is ready to be reviewed.
• [x] Code documentation for the relevant parts in the code have been added/updated by the PR author
• [x] Relevant unit tests have been checked.
• [x] The functionality has been tested by the PR author

Affected Areas

• This PR affects the REST API implementation.
• Without blueprint changes there will be no change in behaviour.