summaryrefslogtreecommitdiffstats
path: root/web/api/badges/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-10-17 09:30:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-10-17 09:30:20 +0000
commit386ccdd61e8256c8b21ee27ee2fc12438fc5ca98 (patch)
treec9fbcacdb01f029f46133a5ba7ecd610c2bcb041 /web/api/badges/README.md
parentAdding upstream version 1.42.4. (diff)
downloadnetdata-386ccdd61e8256c8b21ee27ee2fc12438fc5ca98.tar.xz
netdata-386ccdd61e8256c8b21ee27ee2fc12438fc5ca98.zip
Adding upstream version 1.43.0.upstream/1.43.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'web/api/badges/README.md')
-rw-r--r--web/api/badges/README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/web/api/badges/README.md b/web/api/badges/README.md
index e83186bb2..f6c031181 100644
--- a/web/api/badges/README.md
+++ b/web/api/badges/README.md
@@ -77,11 +77,11 @@ Here is what you can put for `options` (these are standard Netdata API options):
- `alarm=NAME`
- Render the current value and status of an alarm linked to the chart. This option can be ignored if the badge to be generated is not related to an alarm.
+ Render the current value and status of an alert linked to the chart. This option can be ignored if the badge to be generated is not related to an alert.
- The current value of the alarm will be rendered. The color of the badge will indicate the status of the alarm.
+ The current value of the alert will be rendered. The color of the badge will indicate the status of the alert.
- For alarm badges, **both `chart` and `alarm` parameters are required**.
+ For alert badges, **both `chart` and `alarm` parameters are required**.
- `dimensions=DIMENSION1|DIMENSION2|...`