<%= api.name %>

<%- if api.description %>

Description

<%= api.description %>
<%- end %> <%- if api.endpoint %>

Endpoint

<%= api.endpoint %>
<%- end %>

Objects

<%- api.objects.each do |o| %>

<%= o.name %>

Parameters

<%- o.parameters.each do |parameter| %> <%- end %>
Name Type Default Description Example
<%= parameter.name %> <%- if parameter.type %> <%= parameter.type %> <%- end %> <%- if parameter.default %> <%= parameter.default %> <%- end %> <%- if parameter.required %> required <%- end %> <%- if parameter.description %> <%= parameter.description %> <%- end %> <%- if parameter.example %> <%= parameter.example %> <%- end %>
<%- if o.example %>

Example

<%= o.example %>
<%- end %>
<%- end %>

Resources

<%- api.resources.each do |resource| %>

<%= resource.name %>

<%= resource.description %>

Requests

<%- resource.requests.each do |req| %>
<%= req.name %>
<%- if req.path %>

Path

<%= req.path %>
<%- end %> <%- if req.description %>

Description

<%= req.description %>
<%- end %>

Parameters

<%- req.parameters.each do |parameter| %> <%- end %>
Name Type Default Description Example
<%- if parameter.class == DocSmoosher::ApiObject %> <%= parameter.name %> <%- else %> <%= parameter.name %> <%- end %> <%- if parameter.type %> <%= parameter.type %> <%- end %> <%- if parameter.default %> <%= parameter.default %> <%- end %> <%- if parameter.required %> required <%- end %> <%- if parameter.description %> <%= parameter.description %> <%- end %> <%- if parameter.example && parameter.class != DocSmoosher::ApiObject %> <%= parameter.example %> <%- end %>
<%- if req.response %>

Response

<%= req.response.to_json %>
<%- end %>
<%- end %>
<%- end %>