Burt API endpoints

burt_api.py

# Motiva Burt is served over a Restful API with POST, PUT, GET, and DELETE endpoints as such:

# POST /api/experiment/ request body expectation
# campaignStart model that is expected for request body when creating a campaign
campaignStart = api.model(
    "CampaignStart",
    {
        # Datetime string defining the current time
        "now": fields.String(required=True),
        # List of treatment ids
        "treatmentIds": fields.List(fields.Integer, required=True),
    },
)

# PUT /api/experiment/campaignID request body expectation
# campaignUpdate model that is expected for request body when updating a campaign
campaignUpdate = api.model(
    "CampaignUpdate",
    {
        # Datetime string defining the current time. NOTE that this timestamp
        # needs to be the same as the last call to GET etl-processor because
        # this value is used to fetch the record
        "now": fields.String(required=True),
        # Boolean defining whether or not to prune treatments
        "pruneTreatments": fields.Boolean(),
    },
)

# GET /api/experiment/campaignID query params,
# campaignID timezone now number-of-treatments optimization-criterion confidence-threshold hard-commit?
#
# GET returns a list of tuples of the form
# [<treatment-id> <suggested_number_of_attemps_in_this_experiment>, ...]


# DELETE /api/experiment/campaignID