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

Fix apiary documentation

Browse source
This commit is contained in:
Knut Ahlers 2016-03-27 18:49:53 +02:00
parent a707308b88
commit bf1b40a7bc
1 changed files with 1 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
apiary.apib
View file

@ -69,11 +69,7 @@ This API controls the metrics on your dashboard
+ 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
+ status (required, enum[string]) + status (required, enum[string]) - One of: OK, Warning, Critical, Unknown
+ `OK`
+ `Warning`
+ `Critical`
+ `Unknown`
+ expires: 604800 (optional, number) - Time in seconds when to remove the metric if there is no update (Valid: `0 < x < 604800`) + expires: 604800 (optional, number) - Time in seconds when to remove the metric if there is no update (Valid: `0 < x < 604800`)
+ freshness: 3600 (optional, number) - Time in seconds when to switch to `Unkown` state of there is no update (Valid: `0 < x < 604800`) + freshness: 3600 (optional, number) - Time in seconds when to switch to `Unkown` state of there is no update (Valid: `0 < x < 604800`)