API v1 spec

[ChristianSch]

• CRUD /experiment: the experiment
  • POST /experiment: create new experiment
  • GET /experiment: get all experiments
  • GET /experiment/:id: get experiment data (all of it)
  • PUT /experiment/:id: change experiment data (only the meta data about the experiment)
  • DELETE /experiment/:id: remove experiment from database
• CRUD /experiment/:id/model: the different models that ought to be compared for the experiment
  • POST /experiment/:id/model: create a new model
  • GET /experiment/:id/model: get all models
  • GET /experiment/:id/model/:id: get model data
  • PUT /experiment/:id/model/:id: change model data (only meta data about the model)
  • DELETE /experiment/:id/model/:id: remove model
• CRUD /experiment/:id/model/:id/measurements
  • POST /experiment/:id/model/:id/measurements: create a new measurement point
  • GET /experiment/:id/model/:id/measurements: get all measurement points (sorted by name)
  • GET /experiment/:id/model/:id/measurements/forname/:name: get all metrics with a name (for example f1_micro or totalLoss)

[ChristianSch]

Maybe the routes for the measurement points should be expanded. If the individual points have an _id, we might want to allow deleting them, in case of mistaken submits. Otherwise it might be bad if one cherry picks measurement points without any feedback to other users or the future self, i.e. an activity timeline or a transparency report.