<%- if req.path %>
Path
<%= req.path %>
<%- end %>
<%- if req.description %>
Description
<%= req.description %>
<%- end %>
Parameters
Name
|
Type
|
Default
|
|
Description
|
Example
|
<%- req.parameters.each do |parameter| %>
<%- 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 %>
|
<%- end %>
<%- if req.response %>
Response
<%= req.response.to_json %>
<%- end %>