nexmo-oas-renderer 2.1.3 → 2.2.0

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: faadea352082b3d76c8da570d39ba77aa64f5de16b4ac62f8875d7750c3a8e94
4
- data.tar.gz: 0b9b036687ce18bb6bbd810526bf148ecb827d8a0a4b8657208b62321141e52e
3
+ metadata.gz: 1a463231ba72ba74bc9a6555449eb2d2cba6155c32a2506235b04b8bf332678b
4
+ data.tar.gz: 9c8ed923712ff7e677c6f36b532e77fb41ef6120057d52635f7b1a892102aacc
5
5
  SHA512:
6
- metadata.gz: 98fd531733f922f6e4eb15419ee3bc2392f39e1079ef95f6bcf657303269439b8a6c93b76e50735489869b76cf1b5497a105bb44a1f3e2edc087e666b73da5a9
7
- data.tar.gz: 6d566a1770a5edc2f8b12c074374b34bc2758fd7d391a221c84397e9d5bbb9ac6664e654c58f7d54736411da44947e9e8671a231de407c8a377cd17b9f20f6d6
6
+ metadata.gz: b3e4c30d89a5cc22fd66491751235b49d4b56a5a63ce8e9a3d303e8c4989f5e3a47cc8964c5d78b6cc4f1d33467e1ca83065a00e399fcfc076607a81633b7c3e
7
+ data.tar.gz: df6590d1e2de8eb3771dcec2c0cf3617a7453e81e83a34318989d2f42d0513032dfd5c4a35ea3f991a8d1785f6871f6b800e5fb79a863f4c8890ebff89cd2754
@@ -1,3 +1,6 @@
1
+ # 2.2.0
2
+ * Add error list to API reference
3
+
1
4
  # 0.11.3
2
5
  * Change oas url constructor to be entire config parameter and not only partial
3
6
  * Bump websocket-extensions, fixes CVE-2020-7663
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- nexmo-oas-renderer (2.1.3)
4
+ nexmo-oas-renderer (2.2.0)
5
5
  activemodel (~> 6.0)
6
6
  activesupport (~> 6.0)
7
7
  banzai (~> 0.1.2)
@@ -136,9 +136,9 @@ GEM
136
136
  parallel (1.19.2)
137
137
  parser (2.7.1.4)
138
138
  ast (~> 2.4.1)
139
- public_suffix (4.0.5)
139
+ public_suffix (4.0.6)
140
140
  rack (2.2.3)
141
- rack-protection (2.0.8.1)
141
+ rack-protection (2.1.0)
142
142
  rack
143
143
  rack-test (1.1.0)
144
144
  rack (>= 1.0, < 3)
@@ -210,10 +210,10 @@ GEM
210
210
  rb-inotify (~> 0.9, >= 0.9.7)
211
211
  shotgun (0.9.2)
212
212
  rack (>= 1.0)
213
- sinatra (2.0.8.1)
213
+ sinatra (2.1.0)
214
214
  mustermann (~> 1.0)
215
- rack (~> 2.0)
216
- rack-protection (= 2.0.8.1)
215
+ rack (~> 2.2)
216
+ rack-protection (= 2.1.0)
217
217
  tilt (~> 2.0)
218
218
  sprockets (4.0.2)
219
219
  concurrent-ruby (~> 1.0)
@@ -3,7 +3,7 @@
3
3
  module Nexmo
4
4
  module OAS
5
5
  module Renderer
6
- VERSION = '2.1.3'
6
+ VERSION = '2.2.0'
7
7
  end
8
8
  end
9
9
  end
@@ -0,0 +1,34 @@
1
+ <% if definition.raw['x-errors'] %>
2
+ <div>
3
+ <div class="Vlt-grid">
4
+ <div class="Vlt-col oas-left-panel" style="padding-bottom: 36px;">
5
+ <h2 id="errors">Errors</h2>
6
+ <p>
7
+ 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>.
8
+ </p>
9
+ </div>
10
+ <div class="Vlt-col oas-right-panel"></div>
11
+ </div>
12
+ <div class="Vlt-grid">
13
+ <div class="Vlt-col Vlt-table oas-left-panel">
14
+ <table>
15
+ <thead>
16
+ <tr>
17
+ <th>Code</th>
18
+ <th>Details</th>
19
+ </tr>
20
+ </thead>
21
+ <tbody>
22
+ <% definition.raw['x-errors'].each do |name, body| %>
23
+ <tr>
24
+ <td><a href="/api-errors/<%= @specification.definition_name %>#<%= name %>"><b><%= name %></b></a></td>
25
+ <td><%= body['description'].render_markdown %> </td>
26
+ </tr>
27
+ <% end %>
28
+ </tbody>
29
+ </table>
30
+ </div>
31
+ <div class="Vlt-col oas-right-panel"></div>
32
+ </div>
33
+ </div>
34
+ <% end %>
@@ -13,6 +13,9 @@
13
13
  <a href="#webhooks" class="Vlt-btn Vlt-btn--tertiary group-link">Webhooks</a>
14
14
  <% end %>
15
15
 
16
+ <% if definition.raw['x-errors'] %>
17
+ <a href="#errors" class="Vlt-btn Vlt-btn--tertiary group-link">Errors</a>
18
+ <% end %>
16
19
 
17
20
  <% if @specification.formats.size > 1 %>
18
21
  <div class="Vlt-native-dropdown">
@@ -44,6 +47,10 @@
44
47
  <a href="#top" class="Vlt-btn Vlt-btn--tertiary group-link">Available Operations</a>
45
48
  <% end %>
46
49
 
50
+ <% if definition.raw['x-errors'] %>
51
+ <a href="#errors" class="Vlt-btn Vlt-btn--tertiary group-link">Errors</a>
52
+ <% end %>
53
+
47
54
  <br />
48
55
  <br />
49
56
 
@@ -21,6 +21,6 @@
21
21
  <% end %>
22
22
 
23
23
  <%= erb :'open_api/_webhooks', locals: { definition: definition } %>
24
-
24
+ <%= erb :'open_api/_errors', locals: {definition: definition } %>
25
25
  </div>
26
26
  </div>
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: nexmo-oas-renderer
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.1.3
4
+ version: 2.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Fabian Rodriguez
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2020-08-28 00:00:00.000000000 Z
11
+ date: 2020-09-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: activemodel
@@ -348,6 +348,7 @@ files:
348
348
  - lib/nexmo/oas/renderer/views/open_api/_callbacks.erb
349
349
  - lib/nexmo/oas/renderer/views/open_api/_code_examples.erb
350
350
  - lib/nexmo/oas/renderer/views/open_api/_endpoint.erb
351
+ - lib/nexmo/oas/renderer/views/open_api/_errors.erb
351
352
  - lib/nexmo/oas/renderer/views/open_api/_header.erb
352
353
  - lib/nexmo/oas/renderer/views/open_api/_model.erb
353
354
  - lib/nexmo/oas/renderer/views/open_api/_navigation.erb
@@ -389,8 +390,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
389
390
  - !ruby/object:Gem::Version
390
391
  version: '0'
391
392
  requirements: []
392
- rubyforge_project:
393
- rubygems_version: 2.7.6.2
393
+ rubygems_version: 3.1.4
394
394
  signing_key:
395
395
  specification_version: 4
396
396
  summary: OpenAPI Specification renderer.