nexmo-oas-renderer 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a22719a6b2e7e60899cc1a2965f89278bd648b376ab5bbec05754ce47081db56
-  data.tar.gz: f9c09adf0d6f266a301f324446211b4ce9b2cb6a22e0a91fb1639c503fb7bcb7
+  metadata.gz: 5b5e0e8b5fa6f2398fce6e27b89653e00b1b6cf7b2fc0b89b00e466c59ff7010
+  data.tar.gz: 899fd7a44676aef146f525466edb0bf0bcccd49accd2d4ebb04f21fb06f2318f
 SHA512:
-  metadata.gz: 3b90abee001838f0e8885609eaf1a0b9a11e33988ccfdbb109734d7ab70c13ab241a22605a3db0c6115e2245c2b8ab6a8b16526a4b0fcd8ecf8dc17669e2a7ce
-  data.tar.gz: 711bb7ef04c84fe1f1222030dd56113699be627c3d086189b55fae418ea98b53649cd2f770b9972e8e8497564e450b6147fb89bf906d7f8e1f318d37d0d082c6
+  metadata.gz: dea762339636ed621dbf8b44267fb6eeee6be97d8f20be236193ff2d8bdfc9e432cca22ec30ed150fa78c8f97d9e318ecc3ab1263c23f47bb54601f65edee995
+  data.tar.gz: 8decb45d42b106fc52bc46e9f4575f2b58f4273e7d425ff9478259cb0c1ffd4603156957998abbb15d94515060f05e96a52960051dffc59610df8048ffd59dee

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nexmo-oas-renderer (2.0.1)
+    nexmo-oas-renderer (2.1.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)

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,58 +1,65 @@
-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";
+if(document.querySelector(".oas-wrapper")){
+  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) {
-    element.addEventListener('click', function (event) {
-      var link = event.target.getAttribute('data-tab-link');
-      var matchingTabs = document.querySelectorAll('[data-tab-link="' + link + '"]');
-      Array.from(matchingTabs).forEach(function (element) {
-        element.dispatchEvent(new Event('toggle'));
+  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) {
+      element.addEventListener('click', function (event) {
+        var link = event.target.getAttribute('data-tab-link');
+        var matchingTabs = document.querySelectorAll('[data-tab-link="' + link + '"]');
+        Array.from(matchingTabs).forEach(function (element) {
+          element.dispatchEvent(new Event('toggle'));
+        });
       });
     });
-  });
 
-  var toggleTopNav = function(event, closeOnly) {
+    var toggleTopNav = function(event, closeOnly) {
+
+      if (event) {
+        if (!Array.from(event.target.classList).includes("oas-trigger")) {
+          return;
+        }
+      }
 
-    if (event) {
-      if (!Array.from(event.target.classList).includes("oas-trigger")) {
+      var c = document.querySelector('.oas-trigger-content');
+      if (closeOnly === true) {
+        c.style.display = "none";
         return;
       }
-    }
+      c.style.display = c.style.display == 'block' ? 'none' : "block";
+    };
 
-    var c = document.querySelector('.oas-trigger-content');
-    if (closeOnly === true) {
-      c.style.display = "none";
-      return;
+    if (document.querySelector('.oas-trigger')) {
+      document.querySelector('.oas-trigger').addEventListener("click", toggleTopNav);
     }
-    c.style.display = c.style.display == 'block' ? 'none' : "block";
-  };
-  document.querySelector('.oas-trigger').addEventListener("click", toggleTopNav);
 
-  document.querySelectorAll('a').forEach((element) => {
-    var href = element.getAttribute("href");
-    if (!href){ return; }
-    if (href.slice(0,1) !== "#"){ return; }
-    element.addEventListener('click', function (event) {
-      event.preventDefault();
+    document.querySelectorAll('a').forEach((element) => {
+      var href = element.getAttribute("href");
+      if (!href){ return; }
+      if (href.slice(0,1) !== "#"){ return; }
+      element.addEventListener('click', function (event) {
+        event.preventDefault();
 
-      toggleTopNav(null, true);
+        toggleTopNav(null, true);
 
-      var to = document.querySelector(event.target.hash)
-      history.pushState({}, '', event.target.href);
-      window.scrollTo({
-        top: (window.scrollY + to.getBoundingClientRect().y) - 70,
-        left: 0,
-      })
+        var to = document.querySelector(event.target.hash)
+        history.pushState({}, '', event.target.href);
+        window.scrollTo({
+          top: (window.scrollY + to.getBoundingClientRect().y) - 70,
+          left: 0,
+        })
 
 
+      });
     });
+
   });
+}
 
-});

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

@@ -3,7 +3,7 @@
 module Nexmo
   module OAS
     module Renderer
-      VERSION = '2.0.1'
+      VERSION = '2.1.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/_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,7 +29,18 @@
         </div>
       <% end %>
 
-      <% if response.code == '204' || response.formats.empty? %>
+      <% 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 %>
+
+      <% 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>
       <% end %>

metadata

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