diff --git a/apiary.apib b/apiary.apib index c5280b9..3c715b3 100644 --- a/apiary.apib +++ b/apiary.apib @@ -69,11 +69,7 @@ This API controls the metrics on your dashboard + 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 - + status (required, enum[string]) - + `OK` - + `Warning` - + `Critical` - + `Unknown` + + status (required, enum[string]) - One of: 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`) + freshness: 3600 (optional, number) - Time in seconds when to switch to `Unkown` state of there is no update (Valid: `0 < x < 604800`)