RubyGems - nexmo-oas-renderer - Versions diffs - 2.1.1 - Mend

nexmo-oas-renderer 2.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (128) hide show

data/lib/nexmo/oas/renderer/views/concepts/list/plain.html.erb ADDED

@@ -0,0 +1,5 @@
+<ul class="Vlt-list Vlt-list--simple">
+  <% @concepts.each do |concept| %>
+    <li><a href="<%= concept.url %>"><%= concept.title %></a><% if concept.description %>: <%= concept.description.render_markdown.gsub(%r{^<p>},'').gsub(%r{^</p>}, '').strip %><% end %></li>
+  <% end %>
+</ul>

data/lib/nexmo/oas/renderer/views/layouts/_head.erb ADDED

@@ -0,0 +1,6 @@
+<head>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="stylesheet" href="/assets/stylesheets/volta.min.css"/>
+  <link rel="stylesheet" href="/assets/stylesheets/volta-prism.min.css"/>
+  <link rel="stylesheet" href="/assets/stylesheets/nexmo-oas-renderer.css"/>
+</head>

data/lib/nexmo/oas/renderer/views/layouts/_javascripts.erb ADDED

@@ -0,0 +1,14 @@
+<script src="/assets/javascripts/prism.js"></script>
+<script src="/assets/javascripts/popper.min.js"></script>
+<script src="/assets/javascripts/tooltip.min.js"></script>
+<script src="/assets/javascripts/volta.core.js"></script>
+<script src="/assets/javascripts/volta.accordion.js"></script>
+<script src="/assets/javascripts/volta.tabs.js"></script>
+<script src="/assets/javascripts/volta.modal.js"></script>
+<script src="/assets/javascripts/volta.tooltip.js"></script>
+<script src="/assets/javascripts/nexmo-oas-renderer.js?a=1"></script>
+<script src="/assets/javascripts/components/format.js"></script>
+<script type="text/javascript">
+  Volta.init(["accordion", "tab", "modal", "tooltip"]);
+  new Format
+</script>

data/lib/nexmo/oas/renderer/views/layouts/api.erb ADDED

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+  <%= erb :'layouts/_head' %>
+  <body class="Nxd-template">
+    <nav class="Vlt-sidenav" id="Vlt-sidenav">
+      <div class="Vlt-sidenav__scroll">
+        <% begin %>
+          <%= erb :"layouts/#{@specification.side_navigation}" %>
+        <% rescue Errno::ENOENT %>
+          <%= @navigation.navigation_from_content %>
+        <% end %>
+      </div>
+    </nav>
+    <main class="Vlt-main Vlt-main--light Nxd-main" tabindex="2">
+      <div class="Vlt-card" id="primary-content">
+        <%= yield %>
+      </div>
+    </main>
+    <%= erb :"layouts/_javascripts" %>
+  </body>
+</html>

data/lib/nexmo/oas/renderer/views/layouts/open_api.erb ADDED

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+  <%= erb :"layouts/_head" %>
+  <body class="Nxd-template">
+    <main>
+      <%= yield %>
+    </main>
+    <%= erb :"layouts/_javascripts" %>
+  </body>
+</html>

data/lib/nexmo/oas/renderer/views/open_api/_auth.erb ADDED

@@ -0,0 +1,74 @@
+<% if endpoint.jwt? || endpoint.basic_auth? || endpoint.oauth? %>
+  <h4>Authentication</h4>
+  <% if endpoint.jwt? && endpoint.basic_auth? %>
+    <p>This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.</p>
+    <p>You can use <em>either</em> JWT or Basic authentication, but not both at the same time.</p>
+  <% end %>
+  <div class="Vlt-table Vlt-table--bordered">
+    <table>
+      <thead>
+      <tr>
+        <th>Key</th>
+        <th>Description</th>
+        <th>Example</th>
+        <th>Default</th>
+      </tr>
+      </thead>
+      <tbody>
+      <% if endpoint.oauth? %>
+        <tr>
+          <td>
+            <b>Authorization</b>
+          </td>
+          <td>
+            <b>Your OAuth token.</b><br>
+            <small><a href="/vonage-business-cloud/vbc-apis/getting-started/authentication">Read more about OAuth tokens</a></small>
+          </td>
+          <td><code>Bearer &lt;access_token&gt;</code></td>
+          <td>
+            <em>None</em>
+          </td>
+        </tr>
+      <% end %>
+      <% if endpoint.jwt? %>
+        <tr>
+          <td>
+            <b>Authorization</b>
+          </td>
+          <td>
+            <b>Your JSON web token.</b><br>
+            <small><a href="/concepts/guides/authentication#json-web-tokens-jwt">Read more about JWTs</a></small>
+          </td>
+          <td><code>Bearer &lt;JWT&gt;</code></td>
+          <td>
+            <em>None</em>
+          </td>
+        </tr>
+      <% end %>
+      <% if endpoint.basic_auth? %>
+        <tr>
+          <td>
+            <b>Authorization</b>
+          </td>
+          <td>
+            <b>Base64 encoded API key and secret joined by a colon.</b><br>
+            <small><a href="/concepts/guides/authentication#header-based-api-key-and-secret-authentication">Read more</a></small>
+          </td>
+          <td><code>Basic &lt;base64&gt;</code></td>
+          <td>
+            <i>None</i>
+          </td>
+        </tr>
+      <% end %>
+      </tbody>
+    </table>
+  </div>
+<% end %>

data/lib/nexmo/oas/renderer/views/open_api/_available_endpoints.erb ADDED

@@ -0,0 +1,25 @@
+<h5>Available Operations:</h5>
+<ul>
+  <% endpoints.each do |endpoint| %>
+    <li>
+      <span style="width: 58px; text-align:center; margin-right:4px;" class="Vlt-badge Vlt-badge--margin-left Nxd-method-badge Nxd-method-badge--<%= endpoint.method %> Vlt-badge--small"><%= endpoint.method %></span>
+      <a href="#<%= endpoint.operationId %>"><%= normalize_summary_title(endpoint.summary, endpoint.operationId) %></a>
+    </li>
+    <% if endpoint.callbacks.any? %>
+      <% endpoint.callbacks.each do |callback| %>
+        <% callback.paths.each do |path| %>
+          <% path.endpoints.each do |endpoint| %>
+            <li style="margin-top: 8px;">
+              <span style="margin-left:24px; margin-right: 4px;">
+                <svg style="width: 12px; height:12px;" class="Vlt-black"><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-toggle" /></svg>
+              </span>
+              <a href="#<%= endpoint.operationId %>"><%= normalize_summary_title(endpoint.summary, endpoint.operationId) %></a>
+            </li>
+          <% end %>
+      <% end %>
+    <% end %>
+  <% end %>
+  <% end %>
+</ul>
+<br />

data/lib/nexmo/oas/renderer/views/open_api/_callback.erb ADDED

@@ -0,0 +1,5 @@
+<% callback.paths.each do |path| %>
+  <% path.endpoints.each do |endpoint| %>
+    <%= erb :'open_api/_callback_endpoint', locals: { endpoint: endpoint, webhook: webhook } %>
+  <% end %>
+<% end %>

data/lib/nexmo/oas/renderer/views/open_api/_callback_endpoint.erb ADDED

@@ -0,0 +1,38 @@
+<div class="Vlt-grid">
+  <div class="Vlt-col oas-left-panel" style="padding-bottom: 36px;">
+    <h3 id="<%= endpoint.operationId %>" class="Vlt-title--icon">
+      <%= endpoint.summary %>
+      <% if webhook %>
+          <span class="Vlt-badge Vlt-badge--orange">
+            <i class="icon icon-webhook"></i> Webhook
+          </span>
+      <% else %>
+          <span class="Vlt-badge Vlt-badge--green">
+            <i class="icon icon-callback"></i> Callback
+          </span>
+      <% end %>
+    </h3>
+    <% if endpoint.description %>
+      <p><%= endpoint.description.render_markdown %></p>
+    <% end %>
+    <div class="Vlt-badge-combined">
+      <code class="Vlt-badge Vlt-badge--large Nxd-method-badge Nxd-method-badge--<%= endpoint.method %>"><%= endpoint.method.upcase %></code>
+      <code class="Vlt-badge Vlt-badge--large Vlt-bg-grey-lighter Vlt-black">
+        <span class="api-path-host">https://example.com</span><%= (endpoint.raw['x-example-path'] || '/webhooks/event').gsub(/\{(.+?)\}/, '<span class="api-path-parameter">:\1</span>') %>
+      </code>
+    </div>
+    <%= erb :'open_api/_parameter_groups', locals: { endpoint: endpoint, callback: true } %>
+  </div>
+  <div class="Vlt-col oas-right-panel">
+    <% endpoint.request_body.formats.each_with_index do |format, index| %>
+      <div class="js-format" data-format="<%= format %>">
+        <%= erb :'open_api/_requests', locals: { endpoint: endpoint, title: "Example Payload" } %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/lib/nexmo/oas/renderer/views/open_api/_callbacks.erb ADDED

@@ -0,0 +1,5 @@
+<% if endpoint.callbacks.size.positive? %>
+  <% endpoint.callbacks.each do |callback| %>
+    <%= erb :'open_api/_callback', locals: { callback: callback, webhook: false } %>
+  <% end %>
+<% end %>

data/lib/nexmo/oas/renderer/views/open_api/_code_examples.erb ADDED

@@ -0,0 +1,16 @@
+<%
+  # @todo Re-enable code examples once we decide how to handle them in OAS
+  false && if endpoint.raw['x-code-example-path']
+%>
+  <h5>Example request</h5>
+  <%=
+    markdown = <<~HEREDOC
+    ```tabbed_examples
+    config: #{endpoint.raw['x-code-example-path']}
+    ```
+    HEREDOC
+    markdown.render_markdown
+  %>
+<% end %>

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

@@ -0,0 +1,54 @@
+<div class="Vlt-grid">
+  <div class="Vlt-col oas-left-panel" style="padding-bottom: 36px;">
+    <h3 id='<%= endpoint.operationId %>'><%= endpoint.summary %></h3>
+    <% if endpoint.description %>
+      <p><%= endpoint.description.render_markdown %></p>
+    <% end %>
+    <% servers = endpoint.path.servers ? endpoint.path.servers : endpoint.definition.servers %>
+    <% raise "`servers` parameter not provided at either the path level or document root" unless servers.size.positive? %>
+    <%
+      path = endpoint.path.path.gsub(/\{(.+?)\}/, ':\1').chomp("/")
+      uri = URI("#{servers[0]['url']}#{path}")
+    %>
+    <div class="oas-path-full Vlt-badge-combined">
+      <code class="Vlt-badge Vlt-badge--large Nxd-method-badge Nxd-method-badge--<%= endpoint.method %>"><%= endpoint.method.upcase %></code>
+      <code class="Vlt-badge Vlt-badge--large Vlt-bg-grey-lighter Vlt-black">
+        <span><%= uri.scheme %>://<%= uri.host %></span><%= uri.path.gsub(/:([^\/]+)/, '<span class="api-path-parameter">:\1</span>') %>
+      </code>
+    </div>
+    <div class="oas-path-small Vlt-badge-combined" style="margin-bottom: 8px;">
+      <code class="Vlt-badge Vlt-badge--large">Host</code>
+      <code class="Vlt-badge Vlt-badge--large Vlt-bg-grey-lighter Vlt-black">
+        <%= uri.scheme %>://<%= uri.host %>
+      </code>
+    </div>
+    <div class="oas-path-small Vlt-badge-combined">
+      <code class="Vlt-badge Vlt-badge--large Nxd-method-badge Nxd-method-badge--<%= endpoint.method %>"><%= endpoint.method.upcase %></code>
+      <code class="Vlt-badge Vlt-badge--large Vlt-bg-grey-lighter Vlt-black">
+        <%= uri.path.gsub(/:([^\/]+)/, '<span class="api-path-parameter">:\1</span>') %>
+      </code>
+    </div>
+    <%= erb :'open_api/_auth', locals: { endpoint: endpoint } %>
+    <%= erb :'open_api/_parameter_groups', locals: { endpoint: endpoint } %>
+    <%= erb :'open_api/_response_descriptions', locals: { endpoint: endpoint, auto_expand_responses: @auto_expand_responses } %>
+  </div>
+  <div class="Vlt-col oas-right-panel">
+    <%= erb :'open_api/_requests', locals: { endpoint: endpoint } %>
+    <%= erb :'open_api/_responses', locals: { endpoint: endpoint } %>
+  </div>
+</div>

data/lib/nexmo/oas/renderer/views/open_api/_header.erb ADDED

@@ -0,0 +1,71 @@
+<div class="Vlt-grid">
+  <div class="Vlt-col oas-left-panel header-row" style="padding-top:20px;">
+    <a href="<%= @theme_link %>" class="Vlt-switch Vlt-switch--secondary" style="float:right;">
+        <span class="Vlt-switch__slider"></span>
+    </a>
+    <div class="Nxd-api__title">
+      <h1>
+        <%= definition.info['title'] %>
+      </h1>
+      <% if definition.info['x-label'] %>
+        <div>
+                <span class="Vlt-badge Vlt-badge--<%= definition.info['x-label'].parameterize %>">
+                  <%= definition.info['x-label'] %>
+                </span>
+        </div>
+      <% end %>
+    </div>
+    <% if definition.info['description'] %>
+      <p><%= definition.info['description'].render_markdown %></p>
+    <% end %>
+    <div class="Vlt-grid">
+      <div class="Vlt-col">
+        <a href=<%= url("#{request.path}.#{definition.format}") %> class='Vlt-btn Vlt-btn--secondary Vlt-btn--app'>
+        <svg><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-download" /></svg>
+        Download OAS 3 Definition
+        </a>
+      </div>
+      <div class="Vlt-col Vlt-right Vlt-right-sm">
+        <a href="<%=  Nexmo::OAS::Renderer::API.github_path %>/<%= @specification.definition_name %>.yml" class='Vlt-btn Vlt-btn--tertiary Vlt-btn--app Vlt-right Vlt-bg-grey-lighter'>
+          <svg className="Vlt-icon Vlt-black">
+            <use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-github" />
+          </svg>
+          Improve this specification
+        </a>
+      </div>
+    </div>
+    <%
+      # If there's only one group, everything is untagged
+      if @specification.groups.size === 1
+    %>
+      <%= erb :'open_api/_available_endpoints', locals: { endpoints: definition.endpoints } %>
+    <% end %>
+  </div>
+  <%
+    has_switcher = @specification.available_versions && @specification.available_versions.count > 1
+  %>
+  <div class="oas-right-panel Vlt-col <%= has_switcher ? '' : 'sm-hidden' %>">
+    <% if has_switcher %>
+      <div class="Vlt-callout Vlt-callout--shoutout Nxd-version">
+        <i></i>
+        <div class="Vlt-callout__content">
+          <h4>There are multiple versions of this API available</h4>
+          <p>
+            <% @specification.available_versions.each do |v| %>
+              <a href="/api/<%= v['name'] %>" <%= v['version'] == @specification.current_version ? 'class=active':'' %>>Version <%= v['version'] %></a> <%= '|' unless v == @specification.available_versions.last %>
+            <% end %>
+          </p>
+        </div>
+      </div>
+    <% end %>
+  </div>
+</div>

data/lib/nexmo/oas/renderer/views/open_api/_model.erb ADDED

@@ -0,0 +1,43 @@
+<div class="Vlt-grid">
+  <div class="Vlt-col oas-left-panel">
+    <h2 id="<%= group['name'].parameterize %>" class='Vlt-grey-dark group-header'><%= group['name'] %></h2>
+    <p class="Vlt-grey-darker"><%= group['description']&.render_markdown %></p>
+    <%= erb :'open_api/_available_endpoints', locals: { endpoints: endpoints } %>
+    <% if group['schema'] %>
+      <% group['schema'].each do |format, schema| %>
+        <div class="js-format" data-format="<%= format %>">
+          <%
+            if schema['properties']
+              properties = schema['properties']
+            elsif schema['allOf']
+              properties = schema['allOf'].map { |o| o['properties'] }.reduce(&:merge)
+            end
+            properties = properties.map do |name, definition|
+              OasParser::Property.new(self, schema, name, definition)
+            end
+          %>
+          <%= erb :'open_api/_parameters', locals: { parameters: properties, model: true, format: format  } %>
+        </div>
+      <% end %>
+    <% end %>
+  </div>
+  <div class="Vlt-col oas-right-panel <%= !group['schema'] ? 'sm-hidden' : '' %>">
+    <% if group['schema'] %>
+      <% group['schema'].each do |format, schema| %>
+        <div class="js-format" data-format="<%= format %>">
+          <h5>Example Model</h5>
+          <%= ResponseParserDecorator.new(schema).html(format, xml_options: schema['xml']) %>
+        </div>
+      <% end %>
+    <% end %>
+  </div>
+</div>

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

@@ -0,0 +1,68 @@
+<header class="oas-navbar oas-navbar-full">
+  <% if @specification.groups.size == 1 %>
+    <a href="#top" class="Vlt-btn Vlt-btn--tertiary group-link">Available Operations</a>
+  <% end %>
+  <% @specification.groups.each do |name, endpoints| %>
+    <% next unless name %>
+    <a href="#<%= name.parameterize %>" class="Vlt-btn Vlt-btn--tertiary group-link"><%= name %></a>
+  <% end %>
+  <% if @specification.definition.raw['x-webhooks'] || definition.webhooks.size.positive? %>
+    <a href="#webhooks" class="Vlt-btn Vlt-btn--tertiary group-link">Webhooks</a>
+  <% end %>
+  <% if @specification.formats.size > 1 %>
+    <div class="Vlt-native-dropdown">
+      <select class="js-format-selector">
+        <% @specification.formats.each do |value, name| %>
+          <option value="<%= value %>"><%= name %> Responses</option>
+        <% end %>
+      </select>
+    </div>
+  <% end %>
+</header>
+<header class="oas-navbar oas-navbar-small">
+  <div id="oas-nav-accordion" style="width: 100%;">
+    <span role="link" class="oas-trigger">
+      <% if @specification.formats.size > 1 %>
+        <div class="Vlt-native-dropdown">
+          <select class="js-format-selector">
+            <% @specification.formats.each do |value, name| %>
+              <option value="<%= value %>"><%= name %> Responses</option>
+            <% end %>
+          </select>
+        </div>
+      <% end %>
+    </span>
+    <div class="oas-trigger-content">
+      <% if @specification.groups.size == 1 %>
+      <a href="#top" class="Vlt-btn Vlt-btn--tertiary group-link">Available Operations</a>
+      <% end %>
+      <br />
+      <br />
+      <% has_webhooks = @specification.definition.raw['x-webhooks'] || definition.webhooks.size.positive? %>
+      <% if @specification.groups.size > 1 || has_webhooks %>
+        <h4>Endpoints</h4>
+        <% @specification.groups.each do |name, endpoints| %>
+          <% next unless name %>
+          <a href="#<%= name.parameterize %>" class="Vlt-btn Vlt-btn--tertiary group-link"><%= name %></a>
+        <% end %>
+      <% end %>
+      <% if has_webhooks %>
+        <a href="#webhooks" class="Vlt-btn Vlt-btn--tertiary group-link">Webhooks</a>
+      <% end %>
+    </div>
+  </div>
+</header>
+<span id="top"></span>