Web APIs Documentation
Available APIs

Web APIs

You will find on left, the list of all the web APIs offered by this app.

<% WSList.all.each do |api| %>
">

<%= api.verb.upcase %> <%= '[SSL]' if api.ssl %> /<%= api.url %>

<% if api.auth_required %> Authentication required <% end %> <%= "

#{api.doc.desc}

" if api.doc.desc %> <%# TODO support for namespaced params %> <% [["Required", :required_rules], ["Optional", :optional_rules]].each do |label,rule_meth| %> <% unless api.send(rule_meth).empty? %>

<%= label %> Params

    <% api.send(rule_meth).each do |rule| %>
  • <%= rule.name %> of type <%= rule.options[:type] || 'String' %> <% if desc = api.doc.params_doc[rule.name.to_sym] %> <%= desc %>  <% end %> <% if options = rule.options[:options] %> Value Options: <%= options.join(', ') %>  <% end %> <% if default = rule.options[:default] %> Default Value: <%= default %>  <% end %>
    • <% end %>
<% end %> <% end %>
<% if api.response.nodes.any? %>

Response description

<% api.response.elements.each do |el| %> <%= el.to_html %> <% end %> <% api.response.arrays.each do |arr| %> <%= arr.to_html %> <% end %>

Response example

<%= api.response.to_json %>

<% end %>
<% end %>