/*
companion.go contains the definitions of api endpoints mainly used by the
companion containers for getting a list of all challenges, getting a list of all
running containers and starting and stopping challenge containers.
*/

package main

import "net/http"

// getChallenges returns some json containing a list of all challenges
//
// .../api/companion/getChallenges
func getChallenges(w http.ResponseWriter, r *http.Request) {

}

// getRunningContainers returns a list of all running containers in the network
// with the given uuid
//
// .../api/companion/getRunningContainers?uuid=ASDASD
//
// returns a list of all running containers within the uuid context
func getRunningContainers(w http.ResponseWriter, r *http.Request) {

}

// startContainer starts a challenge container
//
// .../api/companion/startContainer?uuid=ASDASD&challenge=DEFDEFDEF
//
// ASDASDASD is the uuid of the companion container in whose network the
// challenge shoud be inserted into
//
// DEFDEFDEF is the uuid of the challenge
func startContainer(w http.ResponseWriter, r *http.Request) {

}

// stopContainer stops one of the challenge containers
//
// .../api/companion/stopContainer?uuid=ASDASD&challenge=DEFDEFDEF
//
// ASDASDASD is the uuid of the companion container in whose network is the
// challenge is located
//
// DEFDEFDEF is the uuid of the challenge
func stopContainer(w http.ResponseWriter, r *http.Request) {

}