Browse Source

Merge "Adding an explanation of action types to the API docs"

changes/02/616902/10
Zuul 4 years ago committed by Gerrit Code Review
parent
commit
f990b57944
  1. 9
      doc/source/api/admin.rst

9
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 |
+-------------------+----------------------+--------------------------------------------+-------------+-----------+

Loading…
Cancel
Save