Sha256: 4f3087096740ec6132d52417d71ae80b30581d945de30300adb0e287754e056b

Contents?: true

Size: 1.08 KB

Versions: 6

Compression:

Stored size: 1.08 KB

Contents

<p><%= @c.action.description %></p>
<h2>Contents</h2>
<p>
This directory is used to prepare input parameters, execute the action and retrieve
output parameters.
</p>
<dl>
    <dt><a href="input/help.html">input/</a></dt>
    <dd>Stage area for input parameters.</dd>

    <dt><a href="output/help.html">output/</a></dt>
    <dd>Contains output parameters after the action was executed.</dd>

    <dt><a href="meta/help.html">meta/</a></dt>
    <dd>Contains input and output global metadata parameters.</dd>

    <dt>exec</dt>
    <dd>Write <code>1</code> to this file to execute the action.</dd>

    <dt>exec.yml</dt>
    <dd>Editable YAML file with input parameters. The action is executed when the file
        is saved and closed.</dd>
    
    <dt>status</dt>
    <dd>Read action status. <code>1</code> if successful, <code>0</code> if not, empty
        if not yet run.</dd>

    <dt>message</dt>
    <dd>Error message returned from the API.</dd>

    <dt><a href="errors/help.html">errors/</a></dt>
    <dd>List of parameter errors.</dd>

    <dt>reset</dt>
    <dd>Reset input parameters.</dd>
</dl>

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
haveapi-fs-0.11.0 templates/help/html/action_dir.erb
haveapi-fs-0.10.0 templates/help/html/action_dir.erb
haveapi-fs-0.9.0 templates/help/html/action_dir.erb
haveapi-fs-0.8.0 templates/help/html/action_dir.erb
haveapi-fs-0.7.1 templates/help/html/action_dir.erb
haveapi-fs-0.7.0 templates/help/html/action_dir.erb