From 8354080f0ce058e38a7e34bf8a201f8af10abc0b Mon Sep 17 00:00:00 2001 From: Gergely Csatari Date: Thu, 15 Nov 2018 17:30:14 +0100 Subject: [PATCH] Adding an explanation of action types to the API docs Change-Id: I41b6c2cd64ed2fa1b662c014ba79588b1d550737 Signed-off-by: Gergely Csatari --- doc/source/api/admin.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/source/api/admin.rst b/doc/source/api/admin.rst index 131d476..2331402 100644 --- a/doc/source/api/admin.rst +++ b/doc/source/api/admin.rst @@ -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 | +-------------------+----------------------+--------------------------------------------+-------------+-----------+