nexmo-oas-renderer 2.0.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a22719a6b2e7e60899cc1a2965f89278bd648b376ab5bbec05754ce47081db56
-  data.tar.gz: f9c09adf0d6f266a301f324446211b4ce9b2cb6a22e0a91fb1639c503fb7bcb7
+  metadata.gz: 1a463231ba72ba74bc9a6555449eb2d2cba6155c32a2506235b04b8bf332678b
+  data.tar.gz: 9c8ed923712ff7e677c6f36b532e77fb41ef6120057d52635f7b1a892102aacc
 SHA512:
-  metadata.gz: 3b90abee001838f0e8885609eaf1a0b9a11e33988ccfdbb109734d7ab70c13ab241a22605a3db0c6115e2245c2b8ab6a8b16526a4b0fcd8ecf8dc17669e2a7ce
-  data.tar.gz: 711bb7ef04c84fe1f1222030dd56113699be627c3d086189b55fae418ea98b53649cd2f770b9972e8e8497564e450b6147fb89bf906d7f8e1f318d37d0d082c6
+  metadata.gz: b3e4c30d89a5cc22fd66491751235b49d4b56a5a63ce8e9a3d303e8c4989f5e3a47cc8964c5d78b6cc4f1d33467e1ca83065a00e399fcfc076607a81633b7c3e
+  data.tar.gz: df6590d1e2de8eb3771dcec2c0cf3617a7453e81e83a34318989d2f42d0513032dfd5c4a35ea3f991a8d1785f6871f6b800e5fb79a863f4c8890ebff89cd2754

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 2.2.0
+* Add error list to API reference
+
 # 0.11.3
 * Change oas url constructor to be entire config parameter and not only partial
 * Bump websocket-extensions, fixes CVE-2020-7663

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nexmo-oas-renderer (2.0.1)
+    nexmo-oas-renderer (2.2.0)
       activemodel (~> 6.0)
       activesupport (~> 6.0)
       banzai (~> 0.1.2)
@@ -82,7 +82,7 @@ GEM
     crass (1.0.6)
     deep_merge (1.2.1)
     diff-lcs (1.4.2)
-    dotenv (2.7.5)
+    dotenv (2.7.6)
     erubi (1.9.0)
     ffi (1.13.1)
     globalid (0.4.2)
@@ -109,7 +109,7 @@ GEM
       hansi (~> 0.2.0)
       mustermann (= 1.1.1)
     neatjson (0.9)
-    nexmo_markdown_renderer (0.4.0)
+    nexmo_markdown_renderer (0.4.1)
       activemodel (~> 6.0)
       banzai (~> 0.1.2)
       i18n (~> 1.7)
@@ -136,9 +136,9 @@ GEM
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
-    public_suffix (4.0.5)
+    public_suffix (4.0.6)
     rack (2.2.3)
-    rack-protection (2.0.8.1)
+    rack-protection (2.1.0)
       rack
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -210,10 +210,10 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.7)
     shotgun (0.9.2)
       rack (>= 1.0)
-    sinatra (2.0.8.1)
+    sinatra (2.1.0)
       mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.8.1)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
       tilt (~> 2.0)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)

data/lib/nexmo/oas/renderer/presenters/api_specification.rb

@@ -11,11 +11,19 @@ module Nexmo
           end
 
           def side_navigation
-            "api/#{@document_name}"
+            if defined?(NexmoDeveloper::Application)
+              "#{Rails.configuration.docs_base_path}/api/#{@document_name}"
+            else
+              "api/#{@document_name}"
+            end
           end
 
           def document_path
-            "_api/#{@document_name}.md"
+            if defined?(NexmoDeveloper::Application)
+              "#{Rails.configuration.docs_base_path}/_api/#{@document_name}.md"
+            else
+              "_api/#{@document_name}.md"
+            end
           end
 
           def document

data/lib/nexmo/oas/renderer/public/assets/javascripts/nexmo-oas-renderer.js

@@ -1,11 +1,17 @@
-if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
-  var h = window.location.href;
-  if (h.indexOf("?theme=") === -1) {
-    window.location.href = h + "?theme=dark";
+document.addEventListener("DOMContentLoaded", function() {
+  // Only run this JS on OAS pages
+  if(!document.querySelector(".oas-wrapper")){
+    return;
+  }
+
+  if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
+    var queryString = new URLSearchParams(window.location.search);
+    if (!queryString.get('theme')) {
+      queryString.set("theme", "dark");
+      window.location.search = queryString.toString();
+    }
   }
-}
 
-document.addEventListener("DOMContentLoaded", function() {
   // Handle people clicking on oneOf tabs by changing every one on the page
   var oneOfTabs = document.querySelectorAll('[data-tab-link]');
   Array.from(oneOfTabs).forEach(function (element) {
@@ -33,7 +39,10 @@ document.addEventListener("DOMContentLoaded", function() {
     }
     c.style.display = c.style.display == 'block' ? 'none' : "block";
   };
-  document.querySelector('.oas-trigger').addEventListener("click", toggleTopNav);
+
+  if (document.querySelector('.oas-trigger')) {
+    document.querySelector('.oas-trigger').addEventListener("click", toggleTopNav);
+  }
 
   document.querySelectorAll('a').forEach((element) => {
     var href = element.getAttribute("href");
@@ -54,5 +63,5 @@ document.addEventListener("DOMContentLoaded", function() {
 
     });
   });
-
 });
+

data/lib/nexmo/oas/renderer/version.rb

@@ -3,7 +3,7 @@
 module Nexmo
   module OAS
     module Renderer
-      VERSION = '2.0.1'
+      VERSION = '2.2.0'
     end
   end
 end

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

@@ -10,7 +10,7 @@
     <% raise "`servers` parameter not provided at either the path level or document root" unless servers.size.positive? %>
 
     <%
-      path = endpoint.path.path.gsub(/\{(.+?)\}/, ':\1')
+      path = endpoint.path.path.gsub(/\{(.+?)\}/, ':\1').chomp("/")
       uri = URI("#{servers[0]['url']}#{path}")
     %>
     <div class="oas-path-full Vlt-badge-combined">

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

@@ -0,0 +1,34 @@
+<% if definition.raw['x-errors'] %>
+    <div>
+        <div class="Vlt-grid">
+            <div class="Vlt-col oas-left-panel" style="padding-bottom: 36px;">
+                <h2 id="errors">Errors</h2>
+                <p>
+                  The following is a non-exhaustive list of error codes that may occur while using this API. These codes are in addition to any of our <a href="/api-errors">generic error codes</a>.
+                </p>
+            </div>
+            <div class="Vlt-col oas-right-panel"></div>
+        </div>
+        <div class="Vlt-grid">
+            <div class="Vlt-col Vlt-table oas-left-panel">
+                <table>
+                    <thead>
+                        <tr>
+                            <th>Code</th>
+                            <th>Details</th>
+                        </tr>
+                    </thead>
+                    <tbody>
+                    <% definition.raw['x-errors'].each do |name, body| %>
+                        <tr>
+                          <td><a href="/api-errors/<%= @specification.definition_name %>#<%= name %>"><b><%= name %></b></a></td>
+                            <td><%= body['description'].render_markdown %> </td>
+                        </tr>
+                    <% end %>
+                    </tbody>
+                </table>
+            </div>
+            <div class="Vlt-col oas-right-panel"></div>
+        </div>
+    </div>
+<% end %>

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

@@ -13,6 +13,9 @@
     <a href="#webhooks" class="Vlt-btn Vlt-btn--tertiary group-link">Webhooks</a>
   <% end %>
 
+  <% if definition.raw['x-errors'] %>
+    <a href="#errors" class="Vlt-btn Vlt-btn--tertiary group-link">Errors</a>
+  <% end %>
 
   <% if @specification.formats.size > 1 %>
     <div class="Vlt-native-dropdown">
@@ -44,6 +47,10 @@
       <a href="#top" class="Vlt-btn Vlt-btn--tertiary group-link">Available Operations</a>
       <% end %>
 
+      <% if definition.raw['x-errors'] %>
+        <a href="#errors" class="Vlt-btn Vlt-btn--tertiary group-link">Errors</a>
+      <% end %>
+
       <br />
       <br />
 

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

@@ -29,14 +29,7 @@
   <% unless endpoint.request_body.exhibits_one_of_multiple_schemas?(format) %>
 
     <%
-      # @mheap: This is hacky handling for allOf, but it works for now
-      # We probably want real allOf support in OasParser, but that's more time than I have right now
-      allOf = endpoint.request_body.content[format]['schema']['allOf']
-      if allOf
-        params = endpoint.request_body.handle_all_of(allOf)
-      else
-        params = endpoint.request_body.properties_for_format(format)
-      end
+      params = endpoint.request_body.properties_for_format(format)
       if params
     %>
 

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

@@ -59,11 +59,11 @@
           <span class="constraint">Required</span>
         <% end %>
 
-        <% if parameter.minimum %>
-          | <span class="constraint">Min:</span> <%= parameter.minimum %>
+        <% if parameter.minimum || parameter.raw['minLength'] %>
+          | <span class="constraint">Min:</span> <%= parameter.minimum || parameter.raw['minLength'] %>
         <% end %>
-        <% if parameter.maximum %>
-          | <span class="constraint">Max:</span> <%= parameter.maximum %>
+        <% if parameter.maximum || parameter.raw['maxLength'] %>
+          | <span class="constraint">Max:</span> <%= parameter.maximum || parameter.raw['maxLength'] %>
         <% end %>
       </div>
 

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

@@ -17,7 +17,11 @@
   </div>
 
   <div id="acc<%= id %>" class="Vlt-js-accordion__content <%= @specification.auto_expand_responses ? 'Vlt-js-accordion__content_open' : '' %>">
+    <% 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 %>
@@ -25,6 +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/_responses.erb

@@ -9,7 +9,11 @@
 <div id="response-tabs-<%= endpoint.operationId.parameterize %>" style="margin-bottom: 64px;">
   <% endpoint.responses.each_with_index do |response, index| %>
     <div class="Vlt-js-tabs__panel <%= index === 0 ? 'Vlt-js-tabs__panel_active' : '' %>">
+
+      <% missing = @specification.formats.keys %>
+
       <% response.formats.each do |format| %>
+        <% missing.delete(format) %>
         <div class="js-format" data-format="<%= format %>">
           <% if response.exhibits_one_of_multiple_schemas?(format) %>
             <%= erb :'open_api/_response_tabs', locals: { format: format, endpoint: endpoint, response: response, content: :responses } %>
@@ -25,11 +29,23 @@
         </div>
       <% end %>
 
-      <% if response.code == '204' || response.formats.empty? %>
+      <% if response.code == '204' %>
         <% content = response.description ? response.description : 'No content' %>
         <pre class="language-json Vlt-prism--copy-disabled <%= @theme_light ? 'Vlt-prism--dark' : '' %>"><code><%= content %></code></pre>
+      <% else %>
+        <% missing.each do |format| %>
+          <div class="js-format Nxd-api__response" data-format="<%= format %>">
+            <div class="Vlt-callout Vlt-callout--warning">
+              <i></i>
+              <div class="Vlt-callout__content">
+                <p>This endpoint does not support <code><%= format %></code></p>
+              </div>
+            </div>
+          </div>
+        <% end %>
       <% end %>
-    </div>
+
+  </div>
 
   <% end %>
 </div>

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

@@ -21,6 +21,6 @@
     <% end %>
 
     <%= erb :'open_api/_webhooks', locals: { definition: definition } %>
-
+    <%= erb :'open_api/_errors', locals: {definition: definition } %>
   </div>
 </div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo-oas-renderer
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-01 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -348,6 +348,7 @@ files:
 - lib/nexmo/oas/renderer/views/open_api/_callbacks.erb
 - lib/nexmo/oas/renderer/views/open_api/_code_examples.erb
 - lib/nexmo/oas/renderer/views/open_api/_endpoint.erb
+- lib/nexmo/oas/renderer/views/open_api/_errors.erb
 - lib/nexmo/oas/renderer/views/open_api/_header.erb
 - lib/nexmo/oas/renderer/views/open_api/_model.erb
 - lib/nexmo/oas/renderer/views/open_api/_navigation.erb
@@ -389,8 +390,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: OpenAPI Specification renderer.