Sha256: c1b9b5d78f7a45e7c68c5808bbeb4c43e560af4875a9343d609135df682ee328

Contents?: true

Size: 1.14 KB

Versions: 12

Compression:

Stored size: 1.14 KB

Contents

<% has_code = false %>

<h4>Possible Errors:</h4>
<p>
  Your request may be rejected with an HTTP status code and an error message
  from the following set:
</p>

<table class="endpoint-errors">
  <thead>
    <tr>
      <th>Response Code</th>
      <th>Details</th>
    </tr>
  </thead>

  <tbody>
    <% object.tags(:throws).each do |tag| %>
      <%
        error = JSON.parse(tag.text)
        error[:reason] = error['reason'] || ''
        error[:message] = error['message'] || ''
        error[:status] = tag.type
      %>

      <tr>
        <td>
          <%= error[:status] %>
          <%= Rack::Utils::HTTP_STATUS_CODES[error[:status].to_i] %>
        </td>

        <% if has_code %>
          <td>
            <code><%= error[:code] %></code>
          </td>
        <% end %>

        <td>
          <code>"<%= error[:message] %>"</code>

          <% unless error[:reason].empty? %>
            <p class="type-mute">
              <em>
                <!-- <p><strong>Reason:</strong></p> -->
                <%= linkify error[:reason] %>
              </em>
            </p>
          <% end %>
        </td>
      </tr>
    <% end %>
  </tbody>
</table>

Version data entries

12 entries across 12 versions & 1 rubygems

Version Path
yard-api-1.1.2 templates/api/tags/html/throws.erb
yard-api-1.1.1 templates/api/tags/html/throws.erb
yard-api-1.1.0 templates/api/tags/html/throws.erb
yard-api-1.0.1 templates/api/tags/html/throws.erb
yard-api-1.0.0 templates/api/tags/html/throws.erb
yard-api-0.3.7 templates/api/tags/html/throws.erb
yard-api-0.3.6 templates/api/tags/html/throws.erb
yard-api-0.3.5 templates/api/tags/html/throws.erb
yard-api-0.3.4 templates/api/tags/html/throws.erb
yard-api-0.3.3 templates/api/tags/html/throws.erb
yard-api-0.3.2 templates/api/tags/html/throws.erb
yard-api-0.3.1 templates/api/tags/html/throws.erb