Merge pull request #8943 from Icinga/bugfix/api-add-comment-expiry-docs

Docs: Describe parameter 'expiry' in 'add-comment' API action
Icinga · Jul 30, 2021 · 4c90709 · 4c90709
2 parents 40c1865 + 3bc90e8
commit 4c90709
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/doc/12-icinga2-api.md b/doc/12-icinga2-api.md
@@ -1276,10 +1276,11 @@ Adds a `comment` from an `author` to services or hosts.
 
 Send a `POST` request to the URL endpoint `/v1/actions/add-comment`.
 
-  Parameter | Type   | Description
-  ----------|--------|--------------
-  author    | string | **Required.** Name of the author, may be empty.
-  comment   | string | **Required.** Comment text, may be empty.
+  Parameter | Type      | Description
+  ----------|-----------|--------------
+  author    | string    | **Required.** Name of the author, may be empty.
+  comment   | string    | **Required.** Comment text, may be empty.
+  expiry    | Timestamp | **Optional.** Comment expiry time.
 
 In addition to these parameters a [filter](12-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host` and `Service`.