nexmo-oas-renderer 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56cc2167d6d0b24cd7b8ec43a8c91a90114095bd75a2e3a6c147d8e4e76fc29c
-  data.tar.gz: 43d33b5db76b3fa4a491c2a81a0a84772d06e7f18fc415d71b25cb6ca39aafe3
+  metadata.gz: b851f13c8369bb28d71c4b0c6ec1fd9f000727b5eb361da8740fa7bae22e74db
+  data.tar.gz: 5c516341b40d8dc5b0992456539367489b3298c08882a1aa425d8a5ed28331cd
 SHA512:
-  metadata.gz: dab7e9108f8c5d5c276e503d35344955028ebec7f83976c3748ef0b87e4f3bb40732f5fbdecdf53feed0800489ba405c21d18dceee223d3e3c53bda3e8017c97
-  data.tar.gz: 7fe3dba4854185b4bff399b5cd673f571781027695b876bc22a0faca2cea51321063fea1e64c17e221ca7e79e44e168df13d4907caac9f29a0fe3df9319014b6
+  metadata.gz: c65dea2d20a585ba768cd3898c20e90c8684e14631ebab025a7a8f381576cd4d7b3d9732b78985a249b74c31a1bcb2bd23a2840b9d2fe750a3fe0c17f45a1c4d
+  data.tar.gz: b7ebc350a3aec9cbc0e208b51051b2d8a7b6871f8a2e5cab0b56c243a96f269504ce49587cb66f2ecbcb8a0318869b9dc9c9e1cdbcc866f1d129ec381d2c16d8

data/.github/workflows/push-docker-publish.yml

@@ -0,0 +1,19 @@
+name: Publish Docker
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - '*'
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Publish to Registry
+      uses: elgohr/Publish-Docker-Github-Action@master
+      with:
+        name: nexmodev/nexmo-oas-renderer
+        username: ${{ secrets.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKER_PASSWORD }}
+        tag_names: true

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.7.1
+* Use schema's description when there isn't one at the parameter level
+
 # 0.7.0
 * Prevent sinatra from showing error traces, use custom 500 page instead
 * Bump oas_parser to version 0.23.0. Ensures interoperability between JSON and YAML formats by forcing keys to be strings

data/Dockerfile

@@ -0,0 +1,6 @@
+FROM ruby:2.6
+COPY . /
+RUN gem install bundler
+RUN bundle install
+EXPOSE 4567
+ENTRYPOINT ["bundle", "exec", "/exe/nexmo-oas-renderer"]

data/Gemfile.lock

@@ -124,7 +124,7 @@ GEM
       octicons (= 8.5.0)
       rails
     public_suffix (4.0.1)
-    rack (2.0.7)
+    rack (2.0.8)
     rack-protection (2.0.7)
       rack
     rack-test (1.1.0)

data/README.md

@@ -3,6 +3,7 @@ Sinatra application that provides a preview of how the OAS documents will be ren
 
 * [Dependencies](#requirements)
 * [Installation and Usage](#installation-and-usage)
+    * [Using Docker](#using-docker)
     * [As a standalone application](#as-a-standalone-application)
     * [Mounted into a Rails application](#mounted-into-a-rails-application)
     * [Specifying the path to the documents](#specifying-the-path-to-the-documents)
@@ -14,6 +15,22 @@ Sinatra application that provides a preview of how the OAS documents will be ren
 
 ## Installation and Usage
 
+### Using Docker
+
+You can run using Docker and it will serve the current directory (this will usually be the api-specification repo):
+
+```bash
+docker run --rm -p 4567:4567 -v `pwd`:/definitions -e 'OAS_PATH=/definitions' nexmodev/nexmo-oas-renderer:latest
+```
+
+Alternatively, add the following to your `~/.bashrc` file and you'll be able to run `nexmo-oas-renderer`
+
+```
+function nexmo-oas-renderer() {
+  docker run --rm -p 4567:4567 -v `pwd`:/definitions -e 'OAS_PATH=/definitions' nexmodev/nexmo-oas-renderer:latest
+}
+```
+
 ### As a standalone application
 
 Install the gem:

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

@@ -32,7 +32,8 @@ module Nexmo
         end
 
         set :mustermann_opts, { type: :rails }
-        set :oas_path, (ENV['OAS_PATH'] || '.')
+        set :oas_path, (ENV['OAS_PATH'] || './')
+        set :bind, '0.0.0.0'
 
         helpers do
           include Helpers::Render

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

@@ -1,7 +1,7 @@
 module Nexmo
   module OAS
     module Renderer
-      VERSION = "0.7.0"
+      VERSION = "0.7.1"
     end
   end
 end

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

@@ -75,10 +75,10 @@
           <td>
             <% if parameter.collection? || parameter.oneOf? %>
               <% if parameter.raw['x-nexmo-developer-collection-description-shown'] %>
-                <%= (parameter.description ? "#{parameter.description}" : '<i>None</i>').render_markdown %>
+                <%= (parameter.description || parameter.schema['description'] || '<i>None</i>').render_markdown %>
               <% end %>
             <% else %>
-              <%= (parameter.description ? "#{parameter.description}" : '<i>None</i>').render_markdown %>
+              <%= (parameter.description || parameter.schema['description'] || '<i>None</i>').render_markdown %>
             <% end %>
 
             <% if parameter.enum %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexmo-oas-renderer
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -229,10 +229,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.example"
+- ".github/workflows/push-docker-publish.yml"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
 - CONTRIBUTING.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt