Merge pull request #351 from terwey/issue_349

[WIP] Documenting the API in the Swagger (Open API v2) format.

Author: svaroqui

cluster/cluster.go

@@ -35,6 +35,25 @@ import (
 	"golang.org/x/crypto/ssh"
 )
 
+// A Clusters is a collection of Cluster objects
+//
+// swagger:response clusters
+type ClustersResponse struct {
+	// Cluster information message
+	// in: body
+	Body []Cluster
+}
+
+// A Cluster has all the information associated with the configured cluster model
+// and its servers.
+//
+// swagger:response cluster
+type ClusterResponse struct {
+	// Cluster information message
+	// in: body
+	Body Cluster
+}
+
 type Cluster struct {
 	Name                          string                      `json:"name"`
 	Tenant                        string                      `json:"tenant"`
@@ -168,6 +187,8 @@ func (a QueryRuleSorter) Len() int           { return len(a) }
 func (a QueryRuleSorter) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }
 func (a QueryRuleSorter) Less(i, j int) bool { return a[i].Id < a[j].Id }
 
+// The Agent describes the server where the cluster runs on.
+// swagger:response agent
 type Agent struct {
 	Id           string `json:"id"`
 	HostName     string `json:"hostName"`

cluster/crash.go

@@ -18,6 +18,7 @@ import (
 )
 
 // Crash will store informations on a crash based on the replication stream
+// swagger:response crash
 type Crash struct {
 	URL                         string
 	FailoverMasterLogFile       string
@@ -29,6 +30,8 @@ type Crash struct {
 	ElectedMasterURL            string
 }
 
+// Collection of Crash reports
+// swagger:response crashList
 type crashList []*Crash
 
 func (cluster *Cluster) newCrash(*Crash) (*Crash, error) {