Sha256: 3802b0ce71008281495afd7c456e0579283b7c66e7106f1213b097de058999f9

Contents?: true

Size: 840 Bytes

Versions: 2

Compression:

Stored size: 840 Bytes

Contents

# <%= endpoint.verb -%> <%= base_path -%><%= path -%><%= "deprecated" if deprecated? -%>

<%= description %>

<% if show_request? %>
## Request
### Example Request
```
<%= example_request.to_markdown %>
```

### Example Parameters
<%= request_parameters.to_markdown %>
<% end %>

## Response
<% if show_response? %>
### Example Response
```
<%= example_response.to_markdown %>
```

### Response Parameters
<%= response_parameters.to_markdown %>
<% end %>

### Response Codes
<% if !successful_response_codes.empty? %>
#### Successful Response Codes
<% successful_response_codes.each do |response_code| %>
* <%= response_code.to_markdown %>
<% end %>
<% end %>

<% if !successful_response_codes.empty? %>
#### Failure Response Codes
<% failure_response_codes.each do |response_code| %>
* <%= response_code.to_markdown %>
<% end %>
<% end %>

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
fdoc-0.3.2 lib/fdoc/templates/endpoint.md.erb
fdoc-0.3.1 lib/fdoc/templates/endpoint.md.erb