diff --git a/templates/docs/api.html b/templates/docs/api.html index 70512685..8aeabba6 100644 --- a/templates/docs/api.html +++ b/templates/docs/api.html @@ -816,8 +816,8 @@ number of returned pings depends on the account's billing plan: 100 for free acc

Get Project's Badges

GET SITE_ROOT/api/v1/badges/

-

Returns a map of all tags in the project, with badge URLs for each tag. For each tag, -SITE_NAME provides badges in a few different formats:

+

Returns a map of all tags in the project, with badge URLs for each tag. SITE_NAME +provides badges in a few different formats:

-

The response includes a special * tag: this tag reports the overal status +

The response includes a special * entry: this pseudo-tag reports the overal status of all checks in the project.

Response Codes

diff --git a/templates/docs/api.md b/templates/docs/api.md index 287663e8..978f46e9 100644 --- a/templates/docs/api.md +++ b/templates/docs/api.md @@ -953,8 +953,8 @@ curl --header "X-Api-Key: your-api-key" SITE_ROOT/api/v1/channels/ `GET SITE_ROOT/api/v1/badges/` -Returns a map of all tags in the project, with badge URLs for each tag. For each tag, -SITE_NAME provides badges in a few different formats: +Returns a map of all tags in the project, with badge URLs for each tag. SITE_NAME +provides badges in a few different formats: * `svg`: returns the badge as a SVG document. * `json`: returns a JSON document which you can use to generate a custom badge @@ -967,7 +967,7 @@ In addition, badges have 2-state and 3-state variations: considers any checks in the grace period as still "up". * `svg3`, `json3`, `shields3`: reports three states: "up", "late", and "down". -The response includes a special `*` tag: this tag reports the overal status +The response includes a special `*` entry: this pseudo-tag reports the overal status of all checks in the project. ### Response Codes