add comment

mackerelio · May 31, 2015 · a3fce15 · a3fce15
1 parent 16654cd
commit a3fce15
Showing 1 changed file with 7 additions and 7 deletions.
diff --git a/mackerel/api.go b/mackerel/api.go
@@ -16,7 +16,7 @@ import (
 
 var logger = logging.GetLogger("api")
 
-// CreatingMetricsValue XXX
+// CreatingMetricsValue parameters of metric values
 type CreatingMetricsValue struct {
 	HostID string      `json:"hostId"`
 	Name   string      `json:"name"`
@@ -82,7 +82,7 @@ func closeResp(resp *http.Response) {
 	}
 }
 
-// FindHost XXX
+// FindHost find the host
 func (api *API) FindHost(id string) (*Host, error) {
 	resp, err := api.get(fmt.Sprintf("/api/v0/hosts/%s", id))
 	defer closeResp(resp)
@@ -104,7 +104,7 @@ func (api *API) FindHost(id string) (*Host, error) {
 	return data.Host, err
 }
 
-// CreateHost XXX
+// CreateHost register the host to mackerel
 func (api *API) CreateHost(name string, meta map[string]interface{}, interfaces []map[string]interface{}, roleFullnames []string, displayName string) (string, error) {
 	resp, err := api.postJSON("/api/v0/hosts", map[string]interface{}{
 		"name":          name,
@@ -146,7 +146,7 @@ func (api *API) UpdateHost(hostID string, hostSpec HostSpec) error {
 	return nil
 }
 
-// PostMetricsValues XXX
+// PostMetricsValues post metrics
 func (api *API) PostMetricsValues(metricsValues [](*CreatingMetricsValue)) error {
 	resp, err := api.postJSON("/api/v0/tsdb", metricsValues)
 	defer closeResp(resp)
@@ -160,22 +160,22 @@ func (api *API) PostMetricsValues(metricsValues [](*CreatingMetricsValue)) error
 	return nil
 }
 
-// CreateGraphDefsPayload XXX
+// CreateGraphDefsPayload payload for post graph defs
 type CreateGraphDefsPayload struct {
 	Name        string                         `json:"name"`
 	DisplayName string                         `json:"displayName"`
 	Unit        string                         `json:"unit"`
 	Metrics     []CreateGraphDefsPayloadMetric `json:"metrics"`
 }
 
-// CreateGraphDefsPayloadMetric XXX
+// CreateGraphDefsPayloadMetric repreesnt graph defs of each metric
 type CreateGraphDefsPayloadMetric struct {
 	Name        string `json:"name"`
 	DisplayName string `json:"displayName"`
 	IsStacked   bool   `json:"isStacked"`
 }
 
-// CreateGraphDefs XXX
+// CreateGraphDefs register graph defs
 func (api *API) CreateGraphDefs(payloads []CreateGraphDefsPayload) error {
 	resp, err := api.postJSON("/api/v0/graph-defs/create", payloads)
 	defer closeResp(resp)