Adding an explanation of action types to the API docs

Change-Id: I41b6c2cd64ed2fa1b662c014ba79588b1d550737
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
This commit is contained in:
Gergely Csatari 2018-11-15 17:30:14 +01:00
parent 51ef3aca3e
commit 8354080f0c
1 changed files with 7 additions and 2 deletions

View File

@ -51,8 +51,13 @@ Request
| actions.plugin | string | plug-in name. Default workflow executes | No | Yes |
| | | plug-ins in an alphabetical order | | |
+-------------------+----------------------+--------------------------------------------+-------------+-----------+
| actions.type | string | Default workflow support types: | No | Yes |
| | | 'pre', 'host' or 'post' | | |
| actions.type | string | Type of the workflow. Possible values are: | No | Yes |
| | | | | |
| | | * pre: executed before the host type | | |
| | | actions | | |
| | | * host: executed for every host | | |
| | | * post: executed after the host type | | |
| | | actions | | |
+-------------------+----------------------+--------------------------------------------+-------------+-----------+
| actions.metadata | dictionary | Metadata; hints to plug-ins | No | Yes |
+-------------------+----------------------+--------------------------------------------+-------------+-----------+