luzifer/mondash
1
0
Fork 0
mirror of https://github.com/Luzifer/mondash.git synced 2024-12-23 04:21:18 +00:00
Code Issues Releases Wiki Activity

Added "value" parameter to API documentation and welcome runner

Browse source
This commit is contained in:
Knut Ahlers 2015-07-06 20:34:50 +02:00
parent 13beddc97a
commit daa9b7eed7
2 changed files with 13 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
apiary.apib
View file

@ -2,7 +2,7 @@ FORMAT: 1A
HOST: https://mondash.org HOST: https://mondash.org
# MonDash # 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 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 MonDash provides a simple API to submit monitoring results and a simple dashboard to view those
results. results.
@ -33,13 +33,13 @@ as we are not storing any data beyond this DELETE request._
+ Request + Request
+ Header + Header
Authorization: MyAPIToken Authorization: MyAPIToken
+ Response 200 (text/plain) + Response 200 (text/plain)
OK OK
## Metric [/{dashid}/{metricid}] ## Metric [/{dashid}/{metricid}]
This API controls the metrics on your dashboard This API controls the metrics on your dashboard
@ -52,19 +52,20 @@ This API controls the metrics on your dashboard
+ Request (application/json) + Request (application/json)
+ Header + Header
Authorization: MyAPIToken Authorization: MyAPIToken
+ Body + Body
{ {
"title": "Amount of beer in the fridge", "title": "Amount of beer in the fridge",
"description": "Currently there are 12 bottles of beer in the fridge", "description": "Currently there are 12 bottles of beer in the fridge",
"status": "OK", "status": "OK",
"expires": 604800, "expires": 604800,
"freshness": 3600 "freshness": 3600,
"value": 12.0
} }
+ Attributes (object) + Attributes (object)
+ title (required, string) - The title of the metric to display on the dashboard + 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 + 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 + Request
+ Header + Header
Authorization: MyAPIToken Authorization: MyAPIToken
+ Response 200 (text/plain) + Response 200 (text/plain)
+ Body + Body
OK OK

1
welcome_runner.go
View file

@ -36,6 +36,7 @@ func runWelcomePage() {
Status: status, Status: status,
Expires: 86400, Expires: 86400,
Freshness: 120, Freshness: 120,
Value: float64(beers),
} }
body, err := json.Marshal(beer) body, err := json.Marshal(beer)