Farmbot-Web-App/api_docs.md.erb

27 lines
532 B
Plaintext
Raw Normal View History

<% if response.success? or note.present? %>
2016-12-07 12:18:19 -07:00
# <%= request.method %> <%= request.path.first(45) %>
2017-02-21 13:27:41 -07:00
<% if note.present? %>
**Notes:** <%= note %>
2017-02-21 13:27:41 -07:00
<% end %>
2016-12-07 12:18:19 -07:00
<% if request.params.except(:controller, :action, :format, :id).keys.length > 0 %>
2015-06-10 05:56:35 -06:00
### Request
```
2016-11-29 13:30:42 -07:00
<%=
2016-12-29 09:16:15 -07:00
JSON.pretty_generate(request.params.except(:controller, :action, :format, :id, :user_id, :device_id))
2016-11-29 13:30:42 -07:00
%>
2015-06-10 05:56:35 -06:00
```
2016-12-07 12:09:38 -07:00
<% end %>
2015-06-10 05:56:35 -06:00
### Response
```
2015-06-10 06:10:42 -06:00
<%=
begin
2016-12-07 12:09:38 -07:00
JSON.pretty_generate(JSON.parse(response.body)).first(500)
2016-11-29 13:30:42 -07:00
rescue => e
2016-12-07 12:09:38 -07:00
"Empty Response"
2015-06-10 06:10:42 -06:00
end
%>
2015-06-10 05:56:35 -06:00
```
2015-06-10 06:10:42 -06:00
<% end %>