Sha256: c3dba0e47f36ff91ebf3073c79438f07dd1be37adec714719aedfd918fdc683a

Contents?: true

Size: 1.07 KB

Versions: 15

Compression:

Stored size: 1.07 KB

Contents

---
title: API Reference
search: true
---

<% resources.each do |resource| %>
# <%= resource.name %>

<% resource.examples.each do |example| %>
## <%= example.name %>

<%= example.description %>

<% example.requests.each do |request| -%>
```json
<% response_body = JSON.parse(request[:response_body]) if request[:response_body] %>
<%= JSON.pretty_generate(response_body) if response_body %>
```

### HTTP Request

`<%= request[:request_method] %> http://example.com<%= request[:request_path] %>`

<% end -%>
<% unless example.parameters.empty? -%>
### Query Parameters

Parameter | Required | Description
--------- | ------- | -----------
<% example.parameters.each do |parameter| -%>
<%= parameter.name %> | <%= !!parameter.required %> | <%= parameter.description %>
<% end -%>
<% end -%>

<% unless example.response_fields.empty? -%>
### Response Fields

Parameter | Type | Description
--------- | ------- | -----------
<% example.response_fields.each do |parameter| -%>
<%= parameter.name %> | <%= parameter.type %> | <%= parameter.description %>
<% end -%>
<% end -%>
<% end -%>
<% end -%>

Version data entries

15 entries across 15 versions & 1 rubygems

Version Path
rspec-api-docs-1.1.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-1.0.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-0.14.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-0.13.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-0.12.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-0.11.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-0.10.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-0.9.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-0.8.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-0.7.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-0.6.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-0.5.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-0.4.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-0.3.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb
rspec-api-docs-0.2.0 lib/rspec_api_docs/formatter/renderer/slate_renderer/slate_index.html.md.erb