Updated mcollective.init according to OSCI-658

[packages/precise/mcollective.git] / etc / data-help.erb

diff --git a/etc/data-help.erb b/etc/data-help.erb
new file mode 100644 (file)
index 0000000..eb2d543
--- /dev/null
+++ b/etc/data-help.erb
@@ -0,0 +1,28 @@
+<%= metastring %>
+QUERY FUNCTION INPUT:
+
+% if entities[:data][:input][:query]
+              Description: <%= entities[:data][:input][:query][:description] %>
+                   Prompt: <%= entities[:data][:input][:query][:prompt] %>
+                     Type: <%= entities[:data][:input][:query][:type] %>
+%        if entities[:data][:input][:query][:type] == :string
+               Validation: <%= entities[:data][:input][:query][:validation] %>
+                   Length: <%= entities[:data][:input][:query][:maxlength] %>
+%        elsif entities[:data][:input][:query][:type] == :list
+             Valid Values: <%= entities[:data][:input][:query][:list].join(", ") %>
+%        end
+%        if entities[:data][:input][:query][:default]
+            Default Value: <%= entities[:data][:input][:query][:default] %>
+%        end
+% else
+    This plugin does not take any input
+% end
+
+QUERY FUNCTION OUTPUT:
+
+%    entities[:data][:output].keys.sort.each do |output|
+           <%= output %>:
+              Description: <%= entities[:data][:output][output][:description] %>
+               Display As: <%= entities[:data][:output][output][:display_as] %>
+
+%    end