From daa9b7eed7f64c13c8aed34b0a458aaa482a1b92 Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Mon, 6 Jul 2015 20:34:50 +0200 Subject: [PATCH] Added "value" parameter to API documentation and welcome runner --- apiary.apib | 23 ++++++++++++----------- welcome_runner.go | 1 + 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/apiary.apib b/apiary.apib index f3fc1a8..c5280b9 100644 --- a/apiary.apib +++ b/apiary.apib @@ -2,7 +2,7 @@ FORMAT: 1A HOST: https://mondash.org # MonDash -MonDash is a service for everyone having to display monitoring results to people who have not +MonDash is a service for everyone having to display monitoring results to people who have not the time or knowledge to get familar with Nagios / Icinga or similar monitoring systems. Therefore MonDash provides a simple API to submit monitoring results and a simple dashboard to view those results. @@ -33,13 +33,13 @@ as we are not storing any data beyond this DELETE request._ + Request + Header - + Authorization: MyAPIToken - + + Response 200 (text/plain) OK - + ## Metric [/{dashid}/{metricid}] This API controls the metrics on your dashboard @@ -52,19 +52,20 @@ This API controls the metrics on your dashboard + Request (application/json) + Header - + Authorization: MyAPIToken - + + Body - + { "title": "Amount of beer in the fridge", "description": "Currently there are 12 bottles of beer in the fridge", "status": "OK", "expires": 604800, - "freshness": 3600 + "freshness": 3600, + "value": 12.0 } - + + Attributes (object) + title (required, string) - The title of the metric to display on the dashboard + description (required, string) - A descriptive text for the current state of the metric @@ -87,11 +88,11 @@ This API controls the metrics on your dashboard + Request + Header - + Authorization: MyAPIToken + Response 200 (text/plain) + Body - + OK diff --git a/welcome_runner.go b/welcome_runner.go index 92f7849..c342f49 100644 --- a/welcome_runner.go +++ b/welcome_runner.go @@ -36,6 +36,7 @@ func runWelcomePage() { Status: status, Expires: 86400, Freshness: 120, + Value: float64(beers), } body, err := json.Marshal(beer)