Skip to content

Add partials that fix explanation rendering. #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 21, 2022
Merged

Add partials that fix explanation rendering. #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions app/views/apitome/docs/_example.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<h2><%= example['description'] %></h2>

<%= render(partial: 'apitome/docs/explanation', locals: {explanation: example['resource_explanation']}) unless example['resource_explanation'].nil? %>
<%= render partial: 'apitome/docs/endpoint', locals: {method: example['http_method'], endpoint: example['route']} %>
<%= render partial: 'apitome/docs/params', locals: {params: example['parameters']} if example['parameters'].size > 0 %>

<% example['requests'].each_with_index do |request, index| %>
<div id="<%= "request-#{index}" %>">
<h3><%= t(:request, scope: :apitome) %></h3>
<div class="request">
<% begin %>
<%= render partial: 'apitome/docs/route', locals: {request: request, index: index} %>
<%= render partial: 'apitome/docs/headers', locals: {request: request, index: index, headers: request['request_headers']} %>
<%= render partial: 'apitome/docs/query', locals: {request: request, index: index} unless request['request_query_parameters'].empty? %>
<%= render partial: 'apitome/docs/body', locals: {request: request, index: index, body: request['request_body'], type: request['request_content_type']} if request['request_body'] %>
<%= render partial: 'apitome/docs/curl', locals: {request: request, index: index} if request['curl'] %>
<%
rescue => e
if Apitome.configuration.example_error_handler
Apitome.configuration.example_error_handler.call(e, "request", request)
else
raise
end
end
%>
</div>

<h3><%= t(:response, scope: :apitome) %></h3>
<div class="response">
<% begin %>
<%- if Apitome.configuration.simulated_response %>
<%= link_to('Simulated Response', simulated_path(example[:link])) if example[:link].present? %>
<%- end %>
<%= render partial: 'apitome/docs/response_fields', locals: {params: example['response_fields']} if example['response_fields'].size > 0 %>
<%= render partial: 'apitome/docs/status', locals: {request: request, index: index} %>
<%= render partial: 'apitome/docs/headers', locals: {request: request, index: index, headers: request['response_headers']} %>
<%= render partial: 'apitome/docs/body', locals: {request: request, index: index, body: request['response_body'], type: request['response_content_type']} if request['response_body'] %>
<%
rescue => e
if Apitome.configuration.example_error_handler
Apitome.configuration.example_error_handler.call(e, "response", request)
else
raise
end
end
%>
</div>
</div>
<% end %>
3 changes: 3 additions & 0 deletions app/views/apitome/docs/_explanation.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<div class="explanation">
<%= raw rendered_markdown(example['resource_explanation'].strip_heredoc) %>
</div>