nexmo-oas-renderer 2.0.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c59677181d5a5a5582488555f1857e61b54dc7aab95f7e159c6345d623997b0
-  data.tar.gz: da45cf0fc8a2fc1307580f52f3ede113a1de3d4d7dbd0efbda71f5121b919756
+  metadata.gz: faadea352082b3d76c8da570d39ba77aa64f5de16b4ac62f8875d7750c3a8e94
+  data.tar.gz: 0b9b036687ce18bb6bbd810526bf148ecb827d8a0a4b8657208b62321141e52e
 SHA512:
-  metadata.gz: dee724d81371ec9f67d58bd31702db2398f0b176eaf35574c2fc7ca505290935d0a27495c0752452552aa57c73e45098fd36c61a4ea4dc55e54cf021f4f0ba88
-  data.tar.gz: d2f8a7a80acf92c00a71c20fc43a6fb637860c287902be8a23d48054c177e739a999e1083485323463b21a03b4840fa78007cd74eb359e096caef1108182af6d
+  metadata.gz: 98fd531733f922f6e4eb15419ee3bc2392f39e1079ef95f6bcf657303269439b8a6c93b76e50735489869b76cf1b5497a105bb44a1f3e2edc087e666b73da5a9
+  data.tar.gz: 6d566a1770a5edc2f8b12c074374b34bc2758fd7d391a221c84397e9d5bbb9ac6664e654c58f7d54736411da44947e9e8671a231de407c8a377cd17b9f20f6d6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nexmo-oas-renderer (2.0.0)
+    nexmo-oas-renderer (2.1.3)
       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)
@@ -120,7 +120,7 @@ GEM
     nio4r (2.5.2)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    oas_parser (0.25.2)
+    oas_parser (0.25.1)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)

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.0'
+      VERSION = '2.1.3'
     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/_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>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo-oas-renderer
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.3
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-01 00:00:00.000000000 Z
+date: 2020-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel