nexmo-oas-renderer 0.11.1 → 2.1.0

data/lib/nexmo/oas/renderer/views/open_api/_request_json.erb

@@ -0,0 +1,4 @@
+<% output = Nexmo::OAS::Renderer::Presenters::RequestBodyRaw.new(parameters) %>
+
+<h4>Example Request</h4>
+<pre class="highlight javascript" style="white-space: pre-wrap"><code><%= output.to_json %></code></pre>

data/lib/nexmo/oas/renderer/views/open_api/_request_one_of.erb

@@ -0,0 +1,70 @@
+<%
+  body = endpoint.request_body
+
+  # If we're calling this recursively (a oneOf a oneOf) then schema is passed in
+  # rather than pulling it from the body
+  schema ||= endpoint.request_body.content[format]['schema']['oneOf']
+
+  # Handle any cases where the top level of the oneOf is an allOf
+  schemas = schema.map do |s|
+    if s['allOf']
+      newSchema = body.handle_all_of(s)
+      s.each do |k,v|
+        newSchema[k] = v
+      end
+
+      next newSchema
+    end
+    s
+  end
+
+  panels = []
+
+  schemas.each_with_index do |schema, index|
+    if schema['properties']
+      schema['properties'] = schema['properties'].map do |name, definition|
+        # Sometimes we get in to a weird situation where we already have a Property
+        next name if name.instance_of?(OasParser::Property)
+        OasParser::Property.new(self, schema, name, definition)
+      end
+      .sort_by do |prop|
+        prop.required ? -1 : 1
+      end
+    end
+
+    subtitle = schema['title'] || schema['description']
+
+    if defined?(parent)
+      subtitle = "#{parent} &raquo; #{subtitle}"
+    end
+
+    panels.push({
+      'title' => subtitle,
+      'description' => schema['title'] || schema['description'],
+      'parameters' => schema['properties'],
+      'oneOf' => schema['oneOf'],
+      'x-tab-id' => schema['x-tab-id'] || schema['title'].parameterize,
+      'active' => index == 0
+    })
+  end
+%>
+
+<div class="Vlt-tabs js-format" data-format="<%= format %>">
+  <div class="Vlt-tabs__header" style="display:none;" role="tablist" aria-label="Responses">
+    <% panels.each do |panel| %>
+      <span data-tab-link="<%= panel['x-tab-id'] %>" class="Vlt-tabs__link <%= panel['active'] ? 'Vlt-tabs__link_active' : '' %>">
+      </span>
+    <% end %>
+  </div>
+  <div class="Vlt-tabs__content">
+    <% panels.each do |panel| %>
+      <div class="Vlt-tabs__panel <%= panel['active'] ? 'Vlt-tabs__panel_active' : '' %>">
+        <% unless panel['oneOf'] %>
+          <%= erb :'open_api/_request_single', locals: { title: title, subtitle: panel['title'], endpoint: endpoint, params: panel['parameters'], format: format } %>
+        <% else %>
+          <%= erb :'open_api/_request_one_of', locals: { title: title, parent: panel['title'], endpoint: endpoint, schema: panel['oneOf'], format: format } %>
+        <% end %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/lib/nexmo/oas/renderer/views/open_api/_request_single.erb

@@ -0,0 +1,53 @@
+<%
+  renderer = Nexmo::OAS::Renderer::Presenters::RequestBodyRaw
+  params ||= endpoint.request_body.properties_for_format(format)
+
+  requests = []
+
+  # Only show the required fields tab if there are any required fields
+  required_params = params.select do |param|
+    param.required
+  end
+
+  requests.push(
+      {
+          'title' => 'Required Fields Only',
+          'id' => 'required-only',
+          'value' => renderer.new(params, { 'required_only' => true }, endpoint)
+      }) if required_params.any?
+
+  # Always show the all fields tab
+  requests.push(
+      {
+          'title' => 'All Fields',
+          'id' => 'all-fields',
+          'value' => renderer.new(params, { 'required_only' => false }, endpoint)
+      }
+  )
+
+  # Remove the "required only" option if the two request bodies are identical
+  unique_requests = requests.map { |r| r['value'].to_format('application/json') }.to_set.size
+  requests.shift if (unique_requests == 1 && requests.size != unique_requests)
+
+  title = "Example Request" unless title
+  if defined?(subtitle)
+    title = "#{title} &raquo; #{subtitle}"
+  end
+
+%>
+
+<h4 class="Vlt-grey-light"><%= title %></h4>
+  <div class="Vlt-tabs">
+    <div class="Vlt-tabs__header" role="tablist" aria-label="Responses">
+      <% requests.each_with_index do |request, index| %>
+        <div role='tab' tabindex="-1" data-tab-link="<%= request['id'] %>" class="<%= index === 0 ? 'Vlt-tabs__link_active' : '' %> Vlt-tabs__link tab-sync"><%= request['title'] %></div>
+        <% end %>
+    </div>
+    <div class="Vlt-tabs__content">
+      <% requests.each_with_index do |request, index| %>
+        <div role='tabpanel' class="Vlt-js-tabs__panel <%= index === 0 ? 'Vlt-tabs__panel_active' : '' %>">
+          <pre class="<%= format == 'application/json' ? 'language-json' : 'language-shell' %> Vlt-prism--copy-disabled <%= @theme_light ? 'Vlt-prism--dark' : '' %>"><code><%= request['value'].to_format(format) %></code></pre>
+        </div>
+      <% end %>
+    </div>
+</div>

data/lib/nexmo/oas/renderer/views/open_api/_requests.erb

@@ -0,0 +1,22 @@
+<%
+  return unless endpoint.request_body
+  return if endpoint.request_body.raw['x-hide-request']
+  title = defined?(title) ? title : nil
+
+  renderer = Nexmo::OAS::Renderer::Presenters::RequestBodyRaw
+
+  # The first format defined is preferred. This is usually application/json
+  format = endpoint.request_body.formats[0]
+%>
+
+<%
+  if endpoint.request_body.exhibits_one_of_multiple_schemas?(format)
+%>
+  <%= erb :'open_api/_request_one_of', locals: { endpoint: endpoint, format: format, title: title } %>
+
+<% else %>
+  <%= erb :'open_api/_request_single', locals: { endpoint: endpoint, format: format, title: title} %>
+<%
+  end
+%>
+

data/lib/nexmo/oas/renderer/views/open_api/_response_description_parameters.erb

@@ -13,120 +13,118 @@
 %>
 
 <% if schema['properties'] %>
-  <% schema['properties'].each do |key, value| %>
+  <% parentField = parentField ? "#{parentField}." : '' %>
+  <% schema['properties'].each do |key, parameter| %>
     <%
       next if key == '_links'
-      next if value['x-skip-response-description']
+      next if parameter['x-skip-response-description']
       parent = "#{endpoint.method}_#{endpoint.path.path.gsub("/", "_")[1..-1]}" unless parent
       responseFieldId = parent + "_" + key
     %>
-    <tr id="<%= responseFieldId %>" <% if value['properties'] %> class=" Vlt-table__row--noline" <% end %>>
-      <td>
-        <b><%= key %></b>
-        <% if value['items'] %>
-          <br />
-          <small>array of <%= value['items']['type'] %>s</small>
+    <div class="oas-grid">
+      <div id="<%= responseFieldId %>" class="oas-parameter-name <%= !parentField.blank? ? 'oas-parameter-name-nested' : '' %>">
+        <% if parentField.blank? %>
+          <b><%= key %></b>
         <% else %>
-          <br />
-          <small>
-            <i><%= value['type'] %></i>
-          </small>
+          <div class="Vlt-tooltip Vlt-tooltip--top" title="<%= parentField %><%= key %>">
+            <b><%= key %></b>
+          </div>
         <% end %>
-      </td>
-      <td>
-        <%= value['description'] ? value['description'].render_markdown : '' %>
-        <% if value['enum']%>
+      </div>
+
+      <div class="oas-parameter-description">
+        <div class="oas-parameter-meta">
+          <%= parameter['type'] %>
+          <% if parameter['type'] == 'array' %>
+            <% if parameter['items'] && parameter['items']['type'] %>
+              of <%= (parameter['items']['type']) %>s
+            <% end %>
+          <% end %>
+        </div>
+
+        <%= (parameter['description'] || '' ).render_markdown %>
+
+        <% if parameter['enum'] %>
           <small class="Vlt-grey-dark">
-            One of: <%= parameter_values(value['enum']) %>
+            One of:
+            <%= parameter_values(parameter['enum']) %>
           </small>
         <% end %>
 
+      </div>
 
-        <% if value['items'] # If this is an array, we need to show the structure of the children %>
 
-          <% if value['items']['oneOf'] || value['items']['anyOf'] # If it's a oneOf/anyOf, we need tabs! %>
-            <%
+      <% arrayMarker = "" %>
+      <% if parameter['items'] # If this is an array, we need to show the structure of the children %>
+        <% arrayMarker = "[]" %>
+        <% if parameter['items']['oneOf'] || parameter['items']['anyOf'] # If it's a oneOf/anyOf, we need tabs! %>
+          <%
 
-              if value['items']['oneOf']
-                qualifier = 'one'
-                key = 'oneOf'
-              else
-                qualifier = 'any'
-                key = 'anyOf'
-              end
+            if parameter['items']['oneOf']
+              qualifier = 'one'
+              lookupKey = 'oneOf'
+            else
+              qualifier = 'any'
+              lookupKey = 'anyOf'
+            end
 
-              schemas = value['items'][key].map do |item|
-                if item['allOf']
-                  item = item.deep_merge(item['allOf'].reduce { |a,b| a.deep_merge(b) })
-                  item.delete('allOf')
-                end
-                item
+            schemas = parameter['items'][lookupKey].map do |item|
+              if item['allOf']
+                item = item.deep_merge(item['allOf'].reduce { |a,b| a.deep_merge(b) })
+                item.delete('allOf')
               end
-            %>
-          <% else %>
-            <% value['properties'] = value['items']['properties'] %>
-            <% schemas = [value] %>
-          <% end %>
-
+              item
+            end
+          %>
         <% else %>
-          <% schemas = [value] if value['properties'] %>
+          <% parameter['properties'] = parameter['items']['properties'] %>
         <% end %>
+      <% end %>
 
-        <% if schemas %>
-          <% needs_tabs = schemas.size > 1 %>
-          </td>
-          </tr>
-
-          <tr class="Vlt-table__row--nohighlight">
-            <td colspan="2">
+      <%
+        schemas = [parameter]
+      %>
 
-              <% if needs_tabs %>
-                <div class="Vlt-callout Vlt-callout--shoutout">
-                  <i></i>
-                  <div class="Vlt-callout__content">
-                    This array contains <strong><%= qualifier %></strong> of the following objects:
-                  </div>
+      <% if schemas %>
+        <% needs_tabs = schemas.size > 1 %>
+            <% if needs_tabs %>
+              <div class="Vlt-callout Vlt-callout--shoutout">
+                <i></i>
+                <div class="Vlt-callout__content">
+                  This array contains <strong><%= qualifier %></strong> of the following objects:
                 </div>
-                <div class="Vlt-tabs js-format">
-                  <div class="Vlt-tabs__header Vlt-tabs__header--bordered" role="tablist" aria-label="Responses">
-                    <% schemas.each_with_index do |schema, index| %>
-                      <div
-                        class="Vlt-tabs__link <%= index == 0 ? 'Vlt-tabs__link_active' : '' %> <%= schema['x-tab-id'] ? "tab-sync" : '' %>"
-                        <% if schema['x-tab-id'] %>
-                          data-tab-link="<%= schema['x-tab-id'] %>"
-                          <% end %>
+              </div>
+              <div class="Vlt-tabs js-format">
+                <div class="Vlt-tabs__header Vlt-tabs__header--bordered" role="tablist" aria-label="Responses">
+                  <% schemas.each_with_index do |schema, index| %>
+                    <div
+                      class="Vlt-tabs__link <%= index == 0 ? 'Vlt-tabs__link_active' : '' %> <%= schema['x-tab-id'] ? "tab-sync" : '' %>"
+                      <% if schema['x-tab-id'] %>
+                      data-tab-link="<%= schema['x-tab-id'] %>"
+                      <% end %>
                       >
-                        <%= schema['description'] %>
-                      </div>
-                    <% end %>
-                  </div>
-                  <div class="Vlt-tabs__content">
-              <% end %>
-
-              <% schemas.each_with_index do |value, index| %>
-                <div class="Vlt-tabs__panel <%= index == 0 ? 'Vlt-tabs__panel_active' : '' %>">
-                  <div class="Vlt-table Vlt-table--bordered">
-                    <table>
-                      <thead>
-                      <tr>
-                        <th>Field</th>
-                        <th>Description</th>
-                      </tr>
-                      </thead>
-                      <tbody>
-                      <%= erb :'open_api/_response_description_parameters', locals: { endpoint: endpoint, schema: value, parent: responseFieldId } %>
-                      </tbody>
-                    </table>
-                  </div>
+                      <%= schema['description'] %>
+                    </div>
+                  <% end %>
                 </div>
-              <% end %>
+                <div class="Vlt-tabs__content">
+            <% end %>
 
-              <% if needs_tabs %>
+            <% schemas.each_with_index do |value, index| %>
+              <div class="Vlt-tabs__panel <%= index == 0 ? 'Vlt-tabs__panel_active' : '' %>">
+                <div class="oas-parameter-nested">
+                <%= erb :'open_api/_response_description_parameters', locals: { endpoint: endpoint, schema: value, parent: responseFieldId, parentField: "#{parentField}#{key}#{arrayMarker}" } %>
                 </div>
-                </div>
-              <% end %>
-        <% end %>
-        </td>
-        </tr>
+              </div>
+            <% end %>
+
+            <% if needs_tabs %>
+              </div>
+              </div>
+            <% end %>
+      <% end %>
+    </div>
   <% end %>
 <% end %>
+
+

data/lib/nexmo/oas/renderer/views/open_api/_response_descriptions.erb

@@ -1,19 +1,27 @@
-<% endpoint.responses.each do |response| %>
-  <% next unless response.success? %>
-  <% next if response.code.to_i == 204 %>
-  <% next unless response.content %>
+<%
+  responses = endpoint.responses.select do |response|
+    next false unless response.success?
+    next false unless response.content
+    true
+  end
+
+  return unless responses.size.positive?
+%>
+<h4>Responses</h4>
+
+<% responses.each do |response| %>
   <% id = SecureRandom.hex %>
-  <p class="collapsible">
-    <a class="Vlt-js-accordion__trigger Nxd-accordion-button" data-accordion="acc<%= id %>">
-      <span class="response-description-toggle Vlt-btn Vlt-btn--tertiary Vlt-btn--block Vlt-bg-grey-lighter">
-        <%= @specification.auto_expand_responses ? 'Hide' : 'View' %> response field descriptions
-      </span>
-    </a>
-  </p>
+  <div class="Vlt-accordion--chevron-left">
+  <div role="button" style="padding: 12px;" class="response-description-toggle  Vlt-bg-<%= response.code[0] == "2" ? 'green' : 'red' %> Vlt-accordion__trigger Vlt-js-accordion__trigger Nxd-accordion-button" data-accordion="acc<%= id %>">
+    <strong><%= response.code %></strong> <%= response.description %>
+  </div>
 
   <div id="acc<%= id %>" class="Vlt-js-accordion__content <%= @specification.auto_expand_responses ? 'Vlt-js-accordion__content_open' : '' %>">
-    <h4>Response Fields</h4>
+    <% missing = @specification.formats.keys %>
+
     <% response.formats.each_with_index do |format, index| %>
+      <% missing.delete(format) %>
+
       <% if response.exhibits_one_of_multiple_schemas?(format) %>
         <%= erb :'open_api/_response_tabs', locals: { endpoint: endpoint, format: format, response: response, content: :descriptions } %>
       <% else %>
@@ -21,5 +29,17 @@
         <%= erb :'open_api/_response_fields', locals: { endpoint: endpoint, schema: schema, format: format, index: nil } %>
       <% end %>
     <% end %>
+
+    <% missing.each do |format| %>
+      <div class="js-format Nxd-api__response" data-format="<%= format %>">
+        <div class="Vlt-callout Vlt-callout--warning" style="margin-top: 8px;">
+          <i></i>
+          <div class="Vlt-callout__content">
+            <p>This endpoint does not support <code><%= format %></code></p>
+          </div>
+        </div>
+      </div>
+    <% end %>
+  </div>
   </div>
 <% end %>

data/lib/nexmo/oas/renderer/views/open_api/_response_fields.erb

@@ -1,18 +1,3 @@
 <div class="js-format Nxd-api__response" data-format="<%= format %>">
-  <div class="Vlt-table Vlt-table--bordered">
-    <table>
-      <thead>
-        <% if index %>
-          <tr><th colspan="2"><%= schema['description'] || "Response #{index + 1}"%></th></tr>
-        <% end %>
-        <tr>
-          <th>Field</th>
-          <th>Description</th>
-        </tr>
-      </thead>
-      <tbody>
-        <%= erb :'open_api/_response_description_parameters', locals: { response: response, endpoint: endpoint, schema: schema } %>
-      </tbody>
-    </table>
-  </div>
+  <%= erb :'open_api/_response_description_parameters', locals: { response: response, endpoint: endpoint, schema: schema } %>
 </div>

data/lib/nexmo/oas/renderer/views/open_api/_response_tabs.erb

@@ -1,7 +1,7 @@
-<% tabs = Nexmo::OAS::Renderer::Presenters::ResponseTabs.new(format, response, content, endpoint) %>
+<% tabs = Nexmo::OAS::Renderer::Presenters::ResponseTabs.new(format, response, content, endpoint, theme_light: @theme_light) %>
 
 <div class='Vlt-tabs js-format' data-format='<%= tabs.format %>'>
-  <div class='Vlt-tabs__header Vlt-tabs__header--bordered' role='tablist' aria-label='Responses'>
+  <div class='Vlt-tabs__header' role='tablist' aria-label='Responses'>
     <% tabs.tab_links.each do |link| %>
       <div role='tab' class='<%= link.css_classes %>' <% if link.data_tab_link %>data-tab-link="<%= link.data_tab_link %>"<% end %>>
         <%= link.content %>