]> granicus.if.org Git - icinga2/commitdiff
Update docs
authorJean Flach <jean-marcel.flach@netways.de>
Fri, 20 Nov 2015 12:42:13 +0000 (13:42 +0100)
committerMichael Friedrich <michael.friedrich@netways.de>
Wed, 25 Nov 2015 07:54:11 +0000 (08:54 +0100)
An action was missing two parameters.

fixes #10645

doc/9-icinga2-api.md

index d8ce9211fca734aeefe3acd9675fe0e45c8c8c73..42d4e6a71ddadd32defedf727ea23d31daa947f0 100644 (file)
@@ -829,7 +829,7 @@ 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.
+  author    | string | **Required.** Name of the author, may be empty.
   comment   | string | **Required.** Comment text, may be empty.
 
 In addition to these parameters a [filter](9-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host` and `Service`.
@@ -900,13 +900,15 @@ Schedule a downtime for hosts and services.
 
 Send a `POST` request to the URL endpoint `/v1/actions/schedule-downtime`.
 
-  Parameter   | Type      | Description
-  ------------|-----------|--------------
-  start\_time | timestamp | **Required.** Timestamp marking the beginning of the downtime.
-  end\_time   | timestamp | **Required.** Timestamp marking the end of the downtime.
-  duration    | integer   | **Required.** Duration of the downtime in seconds if `fixed` is set to false.
-  fixed       | boolean   | **Optional.** Defaults to `false`. If true the downtime is `fixed` otherwise `flexible`. See [downtimes](5-advanced-topics.md#downtimes) for more information.
-  trigger\_name | string   | **Optional.** Sets the trigger for a triggered downtime. See [downtimes](5-advanced-topics.md#downtimes) for more information on triggered downtimes.
+  Parameter     | Type      | Description
+  --------------|-----------|--------------
+  author        | string    | **Required.** Name of the author.
+  comment       | string    | **Required.** Comment text.
+  start\_time   | timestamp | **Required.** Timestamp marking the beginning of the downtime.
+  end\_time     | timestamp | **Required.** Timestamp marking the end of the downtime.
+  duration      | integer   | **Required.** Duration of the downtime in seconds if `fixed` is set to false.
+  fixed         | boolean   | **Optional.** Defaults to `false`. If true the downtime is `fixed` otherwise `flexible`. See [downtimes](5-advanced-topics.md#downtimes) for more information.
+  trigger\_name | string    | **Optional.** Sets the trigger for a triggered downtime. See [downtimes](5-advanced-topics.md#downtimes) for more information on triggered downtimes.
 
 In addition to these parameters a [filter](9-icinga2-api.md#icinga2-api-filters) must be provided. The valid types for this action are `Host` and `Service`.