etc/rpc-help.erb

   1 <%= metastring %>
   2 ACTIONS:
   3 ========
   4    <%= entities.keys.sort.join(", ") %>
   5
   6 % entities.keys.sort.each do |action|
   7    <%= action %> action:
   8    <% (action.size + 8).times do %>-<% end %>
   9        <%= entities[action][:description] %>
  10
  11        INPUT:
  12 %  if entities[action][:input].size > 0
  13 %    entities[action][:input].keys.sort.each do |input|
  14            <%= input %>:
  15               Description: <%= entities[action][:input][input][:description] %>
  16                    Prompt: <%= entities[action][:input][input][:prompt] %>
  17                      Type: <%= entities[action][:input][input][:type] %>
  18                  Optional: <%= !!entities[action][:input][input][:optional] %>
  19 %        if entities[action][:input][input][:type] == :string
  20                Validation: <%= entities[action][:input][input][:validation] %>
  21                    Length: <%= entities[action][:input][input][:maxlength] %>
  22 %        elsif entities[action][:input][input][:type] == :list
  23              Valid Values: <%= entities[action][:input][input][:list].join(", ") %>
  24 %        end
  25 %        if entities[action][:input][input][:default]
  26             Default Value: <%= entities[action][:input][input][:default] %>
  27 %        end
  28
  29 %    end
  30 %  else
  31           This action does not have any inputs
  32 %  end
  33
  34        OUTPUT:
  35 %    entities[action][:output].keys.sort.each do |output|
  36            <%= output %>:
  37               Description: <%= entities[action][:output][output][:description] %>
  38                Display As: <%= entities[action][:output][output][:display_as] %>
  39 %        if entities[action][:output][output][:default]
  40             Default Value: <%= entities[action][:output][output][:default] %>
  41 %        end
  42
  43 %    end
  44 % end