nexmo-oas-renderer 0.9.0 → 0.11.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.travis.yml +8 -0
- data/CHANGELOG.md +15 -0
- data/Gemfile +1 -1
- data/Gemfile.lock +80 -80
- data/README.md +8 -0
- data/lib/nexmo/oas/renderer/app.rb +14 -0
- data/lib/nexmo/oas/renderer/public/assets/stylesheets/sass/api.scss +1 -1
- data/lib/nexmo/oas/renderer/version.rb +1 -1
- data/lib/nexmo/oas/renderer/views/open_api/_callback_endpoint.erb +1 -2
- data/lib/nexmo/oas/renderer/views/open_api/_navigation.erb +11 -0
- data/lib/nexmo/oas/renderer/views/open_api/_parameters.erb +16 -0
- data/lib/nexmo/oas/renderer/views/open_api/show.erb +27 -1
- data/nexmo-oas-renderer.gemspec +2 -2
- metadata +7 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b753eec25e0d213d9c6946acce5968449faf2e7b9bb3b08011c7678386e3d8e0
|
4
|
+
data.tar.gz: 67e4903e6a29dff0ba77a6aa1f6a2360ef583c4fa8d92205ebcf42d2ca090169
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e6ec295a683050ab7b3f0556cc5d3cef0295cd8e844657eb37928ec45bc55ad8c64e0d8db7fc5d67e59fef05b984fc7d1778a9178447e1791e859aa2164632f8
|
7
|
+
data.tar.gz: 85b6f30aa11d76aa2f0590f5074c5897ee871036dbb715ddf7b7199661db0bfd4e452dcbe202cb08216565dd180caa78779e4360367b3cc139067b197f488f7b
|
data/.travis.yml
ADDED
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,18 @@
|
|
1
|
+
# 0.11.3
|
2
|
+
* Change oas url constructor to be entire config parameter and not only partial
|
3
|
+
* Bump websocket-extensions, fixes CVE-2020-7663
|
4
|
+
* Bump rails, fixes CVE-2020-8165, CVE-2020-8164, CVE-2020-8162
|
5
|
+
|
6
|
+
# 0.11.2
|
7
|
+
* Add instructions for docker on windows #68
|
8
|
+
* Add nested array rendering support
|
9
|
+
|
10
|
+
# 0.11.1
|
11
|
+
* Bump nexmo-markdown-renderer to v0.3
|
12
|
+
|
13
|
+
# 0.11.0
|
14
|
+
* Add ability to customize OAS github's repo
|
15
|
+
|
1
16
|
# 0.9.0
|
2
17
|
* Use volta2 styles
|
3
18
|
|
data/Gemfile
CHANGED
data/Gemfile.lock
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
nexmo-oas-renderer (0.
|
4
|
+
nexmo-oas-renderer (0.11.3)
|
5
5
|
activemodel (~> 6.0)
|
6
6
|
activesupport (~> 6.0)
|
7
7
|
banzai (~> 0.1.2)
|
8
8
|
dotenv (~> 2.7)
|
9
9
|
neatjson (~> 0.8)
|
10
|
-
nexmo_markdown_renderer (~> 0.
|
11
|
-
oas_parser (~> 0.
|
10
|
+
nexmo_markdown_renderer (~> 0.3)
|
11
|
+
oas_parser (~> 0.25.1)
|
12
12
|
octicons_helper (~> 8.2)
|
13
13
|
redcarpet (= 3.4.0)
|
14
14
|
rouge (= 2.0.7)
|
@@ -19,61 +19,61 @@ PATH
|
|
19
19
|
GEM
|
20
20
|
remote: https://rubygems.org/
|
21
21
|
specs:
|
22
|
-
actioncable (6.0.
|
23
|
-
actionpack (= 6.0.
|
22
|
+
actioncable (6.0.3.1)
|
23
|
+
actionpack (= 6.0.3.1)
|
24
24
|
nio4r (~> 2.0)
|
25
25
|
websocket-driver (>= 0.6.1)
|
26
|
-
actionmailbox (6.0.
|
27
|
-
actionpack (= 6.0.
|
28
|
-
activejob (= 6.0.
|
29
|
-
activerecord (= 6.0.
|
30
|
-
activestorage (= 6.0.
|
31
|
-
activesupport (= 6.0.
|
26
|
+
actionmailbox (6.0.3.1)
|
27
|
+
actionpack (= 6.0.3.1)
|
28
|
+
activejob (= 6.0.3.1)
|
29
|
+
activerecord (= 6.0.3.1)
|
30
|
+
activestorage (= 6.0.3.1)
|
31
|
+
activesupport (= 6.0.3.1)
|
32
32
|
mail (>= 2.7.1)
|
33
|
-
actionmailer (6.0.
|
34
|
-
actionpack (= 6.0.
|
35
|
-
actionview (= 6.0.
|
36
|
-
activejob (= 6.0.
|
33
|
+
actionmailer (6.0.3.1)
|
34
|
+
actionpack (= 6.0.3.1)
|
35
|
+
actionview (= 6.0.3.1)
|
36
|
+
activejob (= 6.0.3.1)
|
37
37
|
mail (~> 2.5, >= 2.5.4)
|
38
38
|
rails-dom-testing (~> 2.0)
|
39
|
-
actionpack (6.0.
|
40
|
-
actionview (= 6.0.
|
41
|
-
activesupport (= 6.0.
|
39
|
+
actionpack (6.0.3.1)
|
40
|
+
actionview (= 6.0.3.1)
|
41
|
+
activesupport (= 6.0.3.1)
|
42
42
|
rack (~> 2.0, >= 2.0.8)
|
43
43
|
rack-test (>= 0.6.3)
|
44
44
|
rails-dom-testing (~> 2.0)
|
45
45
|
rails-html-sanitizer (~> 1.0, >= 1.2.0)
|
46
|
-
actiontext (6.0.
|
47
|
-
actionpack (= 6.0.
|
48
|
-
activerecord (= 6.0.
|
49
|
-
activestorage (= 6.0.
|
50
|
-
activesupport (= 6.0.
|
46
|
+
actiontext (6.0.3.1)
|
47
|
+
actionpack (= 6.0.3.1)
|
48
|
+
activerecord (= 6.0.3.1)
|
49
|
+
activestorage (= 6.0.3.1)
|
50
|
+
activesupport (= 6.0.3.1)
|
51
51
|
nokogiri (>= 1.8.5)
|
52
|
-
actionview (6.0.
|
53
|
-
activesupport (= 6.0.
|
52
|
+
actionview (6.0.3.1)
|
53
|
+
activesupport (= 6.0.3.1)
|
54
54
|
builder (~> 3.1)
|
55
55
|
erubi (~> 1.4)
|
56
56
|
rails-dom-testing (~> 2.0)
|
57
57
|
rails-html-sanitizer (~> 1.1, >= 1.2.0)
|
58
|
-
activejob (6.0.
|
59
|
-
activesupport (= 6.0.
|
58
|
+
activejob (6.0.3.1)
|
59
|
+
activesupport (= 6.0.3.1)
|
60
60
|
globalid (>= 0.3.6)
|
61
|
-
activemodel (6.0.
|
62
|
-
activesupport (= 6.0.
|
63
|
-
activerecord (6.0.
|
64
|
-
activemodel (= 6.0.
|
65
|
-
activesupport (= 6.0.
|
66
|
-
activestorage (6.0.
|
67
|
-
actionpack (= 6.0.
|
68
|
-
activejob (= 6.0.
|
69
|
-
activerecord (= 6.0.
|
61
|
+
activemodel (6.0.3.1)
|
62
|
+
activesupport (= 6.0.3.1)
|
63
|
+
activerecord (6.0.3.1)
|
64
|
+
activemodel (= 6.0.3.1)
|
65
|
+
activesupport (= 6.0.3.1)
|
66
|
+
activestorage (6.0.3.1)
|
67
|
+
actionpack (= 6.0.3.1)
|
68
|
+
activejob (= 6.0.3.1)
|
69
|
+
activerecord (= 6.0.3.1)
|
70
70
|
marcel (~> 0.3.1)
|
71
|
-
activesupport (6.0.
|
71
|
+
activesupport (6.0.3.1)
|
72
72
|
concurrent-ruby (~> 1.0, >= 1.0.2)
|
73
73
|
i18n (>= 0.7, < 2)
|
74
74
|
minitest (~> 5.1)
|
75
75
|
tzinfo (~> 1.1)
|
76
|
-
zeitwerk (~> 2.2)
|
76
|
+
zeitwerk (~> 2.2, >= 2.2.2)
|
77
77
|
addressable (2.7.0)
|
78
78
|
public_suffix (>= 2.0.2, < 5.0)
|
79
79
|
banzai (0.1.3)
|
@@ -84,32 +84,32 @@ GEM
|
|
84
84
|
diff-lcs (1.3)
|
85
85
|
dotenv (2.7.5)
|
86
86
|
erubi (1.9.0)
|
87
|
-
ffi (1.
|
87
|
+
ffi (1.13.1)
|
88
88
|
globalid (0.4.2)
|
89
89
|
activesupport (>= 4.2.0)
|
90
90
|
hansi (0.2.0)
|
91
91
|
hash-deep-merge (0.1.1)
|
92
|
-
i18n (1.8.
|
92
|
+
i18n (1.8.3)
|
93
93
|
concurrent-ruby (~> 1.0)
|
94
|
-
loofah (2.
|
94
|
+
loofah (2.5.0)
|
95
95
|
crass (~> 1.0.2)
|
96
96
|
nokogiri (>= 1.5.9)
|
97
97
|
mail (2.7.1)
|
98
98
|
mini_mime (>= 0.1.1)
|
99
99
|
marcel (0.3.3)
|
100
100
|
mimemagic (~> 0.3.2)
|
101
|
-
method_source (0.
|
102
|
-
mimemagic (0.3.
|
101
|
+
method_source (1.0.0)
|
102
|
+
mimemagic (0.3.5)
|
103
103
|
mini_mime (1.0.2)
|
104
104
|
mini_portile2 (2.4.0)
|
105
|
-
minitest (5.14.
|
105
|
+
minitest (5.14.1)
|
106
106
|
mustermann (1.1.1)
|
107
107
|
ruby2_keywords (~> 0.0.1)
|
108
108
|
mustermann-contrib (1.1.1)
|
109
109
|
hansi (~> 0.2.0)
|
110
110
|
mustermann (= 1.1.1)
|
111
111
|
neatjson (0.9)
|
112
|
-
nexmo_markdown_renderer (0.
|
112
|
+
nexmo_markdown_renderer (0.4.0)
|
113
113
|
activemodel (~> 6.0)
|
114
114
|
banzai (~> 0.1.2)
|
115
115
|
i18n (~> 1.7)
|
@@ -120,7 +120,7 @@ GEM
|
|
120
120
|
nio4r (2.5.2)
|
121
121
|
nokogiri (1.10.9)
|
122
122
|
mini_portile2 (~> 2.4.0)
|
123
|
-
oas_parser (0.
|
123
|
+
oas_parser (0.25.1)
|
124
124
|
activesupport (>= 4.0.0)
|
125
125
|
addressable (~> 2.3)
|
126
126
|
builder (~> 3.2.3)
|
@@ -133,57 +133,57 @@ GEM
|
|
133
133
|
octicons_helper (8.5.0)
|
134
134
|
octicons (= 8.5.0)
|
135
135
|
rails
|
136
|
-
public_suffix (4.0.
|
136
|
+
public_suffix (4.0.5)
|
137
137
|
rack (2.2.2)
|
138
138
|
rack-protection (2.0.8.1)
|
139
139
|
rack
|
140
140
|
rack-test (1.1.0)
|
141
141
|
rack (>= 1.0, < 3)
|
142
|
-
rails (6.0.
|
143
|
-
actioncable (= 6.0.
|
144
|
-
actionmailbox (= 6.0.
|
145
|
-
actionmailer (= 6.0.
|
146
|
-
actionpack (= 6.0.
|
147
|
-
actiontext (= 6.0.
|
148
|
-
actionview (= 6.0.
|
149
|
-
activejob (= 6.0.
|
150
|
-
activemodel (= 6.0.
|
151
|
-
activerecord (= 6.0.
|
152
|
-
activestorage (= 6.0.
|
153
|
-
activesupport (= 6.0.
|
142
|
+
rails (6.0.3.1)
|
143
|
+
actioncable (= 6.0.3.1)
|
144
|
+
actionmailbox (= 6.0.3.1)
|
145
|
+
actionmailer (= 6.0.3.1)
|
146
|
+
actionpack (= 6.0.3.1)
|
147
|
+
actiontext (= 6.0.3.1)
|
148
|
+
actionview (= 6.0.3.1)
|
149
|
+
activejob (= 6.0.3.1)
|
150
|
+
activemodel (= 6.0.3.1)
|
151
|
+
activerecord (= 6.0.3.1)
|
152
|
+
activestorage (= 6.0.3.1)
|
153
|
+
activesupport (= 6.0.3.1)
|
154
154
|
bundler (>= 1.3.0)
|
155
|
-
railties (= 6.0.
|
155
|
+
railties (= 6.0.3.1)
|
156
156
|
sprockets-rails (>= 2.0.0)
|
157
157
|
rails-dom-testing (2.0.3)
|
158
158
|
activesupport (>= 4.2.0)
|
159
159
|
nokogiri (>= 1.6)
|
160
160
|
rails-html-sanitizer (1.3.0)
|
161
161
|
loofah (~> 2.3)
|
162
|
-
railties (6.0.
|
163
|
-
actionpack (= 6.0.
|
164
|
-
activesupport (= 6.0.
|
162
|
+
railties (6.0.3.1)
|
163
|
+
actionpack (= 6.0.3.1)
|
164
|
+
activesupport (= 6.0.3.1)
|
165
165
|
method_source
|
166
166
|
rake (>= 0.8.7)
|
167
167
|
thor (>= 0.20.3, < 2.0)
|
168
168
|
rake (13.0.1)
|
169
|
-
rb-fsevent (0.10.
|
169
|
+
rb-fsevent (0.10.4)
|
170
170
|
rb-inotify (0.10.1)
|
171
171
|
ffi (~> 1.0)
|
172
172
|
redcarpet (3.4.0)
|
173
173
|
rouge (2.0.7)
|
174
|
-
rspec (3.
|
175
|
-
rspec-core (~> 3.
|
176
|
-
rspec-expectations (~> 3.
|
177
|
-
rspec-mocks (~> 3.
|
178
|
-
rspec-core (3.
|
179
|
-
rspec-support (~> 3.
|
180
|
-
rspec-expectations (3.
|
174
|
+
rspec (3.9.0)
|
175
|
+
rspec-core (~> 3.9.0)
|
176
|
+
rspec-expectations (~> 3.9.0)
|
177
|
+
rspec-mocks (~> 3.9.0)
|
178
|
+
rspec-core (3.9.1)
|
179
|
+
rspec-support (~> 3.9.1)
|
180
|
+
rspec-expectations (3.9.1)
|
181
181
|
diff-lcs (>= 1.2.0, < 2.0)
|
182
|
-
rspec-support (~> 3.
|
183
|
-
rspec-mocks (3.
|
182
|
+
rspec-support (~> 3.9.0)
|
183
|
+
rspec-mocks (3.9.1)
|
184
184
|
diff-lcs (>= 1.2.0, < 2.0)
|
185
|
-
rspec-support (~> 3.
|
186
|
-
rspec-support (3.
|
185
|
+
rspec-support (~> 3.9.0)
|
186
|
+
rspec-support (3.9.2)
|
187
187
|
ruby2_keywords (0.0.2)
|
188
188
|
sass (3.7.4)
|
189
189
|
sass-listen (~> 4.0.0)
|
@@ -197,7 +197,7 @@ GEM
|
|
197
197
|
rack (~> 2.0)
|
198
198
|
rack-protection (= 2.0.8.1)
|
199
199
|
tilt (~> 2.0)
|
200
|
-
sprockets (4.0.
|
200
|
+
sprockets (4.0.2)
|
201
201
|
concurrent-ruby (~> 1.0)
|
202
202
|
rack (> 1, < 3)
|
203
203
|
sprockets-rails (3.2.1)
|
@@ -207,11 +207,11 @@ GEM
|
|
207
207
|
thor (1.0.1)
|
208
208
|
thread_safe (0.3.6)
|
209
209
|
tilt (2.0.10)
|
210
|
-
tzinfo (1.2.
|
210
|
+
tzinfo (1.2.7)
|
211
211
|
thread_safe (~> 0.1)
|
212
|
-
websocket-driver (0.7.
|
212
|
+
websocket-driver (0.7.2)
|
213
213
|
websocket-extensions (>= 0.1.0)
|
214
|
-
websocket-extensions (0.1.
|
214
|
+
websocket-extensions (0.1.5)
|
215
215
|
zeitwerk (2.3.0)
|
216
216
|
|
217
217
|
PLATFORMS
|
@@ -220,7 +220,7 @@ PLATFORMS
|
|
220
220
|
DEPENDENCIES
|
221
221
|
bundler (~> 2.0)
|
222
222
|
nexmo-oas-renderer!
|
223
|
-
rails (~> 6.0.
|
223
|
+
rails (~> 6.0.3)
|
224
224
|
rake (~> 13.0)
|
225
225
|
rspec (~> 3.8)
|
226
226
|
|
data/README.md
CHANGED
@@ -19,6 +19,8 @@ Sinatra application that provides a preview of how the OAS documents will be ren
|
|
19
19
|
|
20
20
|
You can run using Docker and it will serve the current directory (this will usually be the api-specification repo):
|
21
21
|
|
22
|
+
#### Mac/Linux
|
23
|
+
|
22
24
|
```bash
|
23
25
|
docker run --rm -p 4567:4567 -v `pwd`:/definitions -e 'OAS_PATH=/definitions' nexmodev/nexmo-oas-renderer:latest
|
24
26
|
```
|
@@ -31,6 +33,12 @@ function nexmo-oas-renderer() {
|
|
31
33
|
}
|
32
34
|
```
|
33
35
|
|
36
|
+
#### Windows
|
37
|
+
|
38
|
+
```ps
|
39
|
+
docker run --rm -p 4567:4567 -v %CD%:/definitions -e 'OAS_PATH=/definitions' nexmodev/nexmo-oas-renderer:latest
|
40
|
+
```
|
41
|
+
|
34
42
|
### As a standalone application
|
35
43
|
|
36
44
|
Install the gem:
|
@@ -32,6 +32,7 @@ module Nexmo
|
|
32
32
|
set :mustermann_opts, { type: :rails }
|
33
33
|
set :oas_path, (ENV['OAS_PATH'] || './')
|
34
34
|
set :bind, '0.0.0.0'
|
35
|
+
set :github_path, Proc.new { load_business_yaml }
|
35
36
|
|
36
37
|
helpers do
|
37
38
|
include Helpers::Render
|
@@ -58,6 +59,19 @@ module Nexmo
|
|
58
59
|
end
|
59
60
|
end
|
60
61
|
|
62
|
+
def self.load_business_yaml
|
63
|
+
if defined?(NexmoDeveloper::Application) && !File.exist?("#{Rails.configuration.docs_base_path}/config/business_info.yml")
|
64
|
+
raise "Application requires a 'config/business_info.yml' file to be defined inside the documentation path."
|
65
|
+
elsif defined?(NexmoDeveloper::Application) && File.exist?("#{Rails.configuration.docs_base_path}/config/business_info.yml")
|
66
|
+
@url ||= begin
|
67
|
+
config = YAML.load_file("#{Rails.configuration.docs_base_path}/config/business_info.yml")
|
68
|
+
config['oas_url']
|
69
|
+
end
|
70
|
+
else
|
71
|
+
"https://www.github.com/nexmo/api-specification/blob/master/definitions"
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
61
75
|
def check_redirect!
|
62
76
|
if defined?(NexmoDeveloper::Application)
|
63
77
|
redirect_path = Redirector.find(request)
|
@@ -20,8 +20,7 @@
|
|
20
20
|
<div class="Vlt-badge-combined">
|
21
21
|
<code class="Vlt-badge Vlt-white Vlt-badge--large Nxd-method-badge Nxd-method-badge--<%= endpoint.method %>"><%= endpoint.method.upcase %></code>
|
22
22
|
<code class="Vlt-badge Vlt-badge--large Vlt-bg-grey-lighter Vlt-black">
|
23
|
-
<span class="api-path-host">https://example.com</span>
|
24
|
-
<%= (endpoint.raw['x-example-path'] || '/webhooks/event').gsub(/\{(.+?)\}/, '<span class="api-path-parameter">:\1</span>') %>
|
23
|
+
<span class="api-path-host">https://example.com</span><%= (endpoint.raw['x-example-path'] || '/webhooks/event').gsub(/\{(.+?)\}/, '<span class="api-path-parameter">:\1</span>') %>
|
25
24
|
</code>
|
26
25
|
</div>
|
27
26
|
|
@@ -48,6 +48,17 @@
|
|
48
48
|
<% end %>
|
49
49
|
<% end %>
|
50
50
|
|
51
|
+
<% definition.webhooks.each do |webhook| %>
|
52
|
+
<% webhook.endpoints.each do |endpoint| %>
|
53
|
+
<li>
|
54
|
+
<a href="#<%= webhook.name %>" class="Vlt-sidemenu__link">
|
55
|
+
<svg class="Vlt-grey-darker"><use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-mind-map" /></svg>
|
56
|
+
<span class="Vlt-sidemenu__label"><%= endpoint.summary %></span>
|
57
|
+
</a>
|
58
|
+
</li>
|
59
|
+
<% end %>
|
60
|
+
<% end %>
|
61
|
+
|
51
62
|
<% if definition.raw['x-webhooks'] %>
|
52
63
|
<% definition.raw['x-webhooks'].each do |name, definition| %>
|
53
64
|
<% callback = OasParser::Callback.new(self, name, definition) %>
|
@@ -20,6 +20,7 @@
|
|
20
20
|
</thead>
|
21
21
|
<tbody>
|
22
22
|
<% parameters.each do |parameter| %>
|
23
|
+
<% next if parameter.name == "_links" %>
|
23
24
|
<tr class="<% if parameter.collection? %> Vlt-table__row--noline <% end %>">
|
24
25
|
<td class="Vlt-table__cell--nowrap">
|
25
26
|
<b><%= parameter.name %></b><br>
|
@@ -141,6 +142,7 @@
|
|
141
142
|
should_render_row = false
|
142
143
|
should_render_row = should_render_row || parameter.subproperties_are_one_of_many?
|
143
144
|
should_render_row = should_render_row || (parameter.properties && parameter.object? && parameter.properties.size.positive?)
|
145
|
+
should_render_row = should_render_row || (parameter.array? && parameter.items['properties'])
|
144
146
|
%>
|
145
147
|
<% if parameter.collection? && should_render_row %>
|
146
148
|
|
@@ -158,6 +160,20 @@
|
|
158
160
|
<% if parameter.properties && parameter.object? && parameter.properties.size.positive? %>
|
159
161
|
<%= erb :'open_api/_parameters', locals: { parameters: parameter.properties, model: model, format: format, callback: callback } %>
|
160
162
|
<% end %>
|
163
|
+
<% if parameter.array?
|
164
|
+
items = parameter.items
|
165
|
+
# Merge allOf entries
|
166
|
+
if items['allOf']
|
167
|
+
items = items['allOf'].reduce { |a,b| a.deep_merge(b) }
|
168
|
+
end
|
169
|
+
# Cast back to properties
|
170
|
+
next unless items['properties']
|
171
|
+
items['properties'] = items['properties'].map do |name, definition|
|
172
|
+
OasParser::Property.new(nil, items, name, definition)
|
173
|
+
end
|
174
|
+
%>
|
175
|
+
<%= erb :'open_api/_parameters', locals: { parameters: items['properties'], model: model, format: format, callback: callback } %>
|
176
|
+
<% end %>
|
161
177
|
<% end %>
|
162
178
|
</td>
|
163
179
|
</tr>
|
@@ -31,7 +31,7 @@
|
|
31
31
|
</a>
|
32
32
|
</div>
|
33
33
|
<div class="Vlt-col Vlt-right">
|
34
|
-
<a href="
|
34
|
+
<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'>
|
35
35
|
<svg className="Vlt-icon Vlt-black">
|
36
36
|
<use xlink:href="/assets/symbol/volta-icons.svg#Vlt-icon-github" />
|
37
37
|
</svg>
|
@@ -82,12 +82,38 @@
|
|
82
82
|
<% end %>
|
83
83
|
<% end %>
|
84
84
|
|
85
|
+
<% if @specification.definition.raw['x-webhooks'] || definition.webhooks.size.positive? %>
|
86
|
+
<div class="Vlt-grid">
|
87
|
+
<div class="Vlt-col Vlt-col--2of3 Nxd-api__docs">
|
88
|
+
<div>
|
89
|
+
<h2>Webhooks</h2>
|
90
|
+
<p>
|
91
|
+
Webhooks are an extension of an API, but instead of your code requesting data, the API sends data to you. The data arrives in a web request to your application.
|
92
|
+
</p>
|
93
|
+
<p>To learn more about webhooks, see our <a href="/concepts/guides/webhooks">webhooks documentation</a></p>
|
94
|
+
|
95
|
+
<p>This API may send any of the webhooks documented below to the URL that you have configured. You must repond with a `200` or `204` HTTP response, or the requests will be retried</p>
|
96
|
+
<br />
|
97
|
+
</div>
|
98
|
+
</div>
|
99
|
+
|
100
|
+
<div class="Vlt-col Vlt-col--1of3 Nxd-api__code">
|
101
|
+
</div>
|
102
|
+
</div>
|
103
|
+
<% end %>
|
104
|
+
|
85
105
|
<% if @specification.definition.raw['x-webhooks'] %>
|
86
106
|
<% @specification.definition.raw['x-webhooks'].each do |name, definition| %>
|
87
107
|
<%= erb :'open_api/_callback', locals: { callback: OasParser::Callback.new(self, name, definition), webhook: true } %>
|
88
108
|
<% end %>
|
89
109
|
<% end %>
|
90
110
|
|
111
|
+
<% definition.webhooks.each do |webhook| %>
|
112
|
+
<% webhook.endpoints.each do |endpoint| %>
|
113
|
+
<%= erb :'open_api/_callback_endpoint', locals: { webhook: webhook, endpoint: endpoint } %>
|
114
|
+
<% end %>
|
115
|
+
<% end %>
|
116
|
+
|
91
117
|
<% if @specification.definition_errors %>
|
92
118
|
<div class="Vlt-grid" id="errors">
|
93
119
|
<div class="Vlt-col Vlt-col--2of3 Nxd-api__docs">
|
data/nexmo-oas-renderer.gemspec
CHANGED
@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
|
|
34
34
|
spec.add_runtime_dependency 'sinatra', '~> 2.0'
|
35
35
|
spec.add_runtime_dependency 'shotgun', '~> 0.9'
|
36
36
|
spec.add_runtime_dependency 'rouge', '2.0.7'
|
37
|
-
spec.add_runtime_dependency 'oas_parser', '~> 0.
|
37
|
+
spec.add_runtime_dependency 'oas_parser', '~> 0.25.1'
|
38
38
|
spec.add_runtime_dependency 'neatjson', '~> 0.8'
|
39
39
|
spec.add_runtime_dependency 'activesupport', '~> 6.0'
|
40
40
|
spec.add_runtime_dependency 'banzai', '~> 0.1.2'
|
@@ -43,7 +43,7 @@ Gem::Specification.new do |spec|
|
|
43
43
|
spec.add_runtime_dependency 'sass', '~> 3.1'
|
44
44
|
spec.add_runtime_dependency 'activemodel', '~> 6.0'
|
45
45
|
spec.add_runtime_dependency "dotenv", "~> 2.7"
|
46
|
-
spec.add_runtime_dependency 'nexmo_markdown_renderer', '~> 0.
|
46
|
+
spec.add_runtime_dependency 'nexmo_markdown_renderer', '~> 0.3'
|
47
47
|
|
48
48
|
spec.add_development_dependency "bundler", "~> 2.0"
|
49
49
|
spec.add_development_dependency "rake", "~> 13.0"
|
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: 0.
|
4
|
+
version: 0.11.3
|
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-
|
11
|
+
date: 2020-06-17 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: sinatra
|
@@ -58,14 +58,14 @@ dependencies:
|
|
58
58
|
requirements:
|
59
59
|
- - "~>"
|
60
60
|
- !ruby/object:Gem::Version
|
61
|
-
version:
|
61
|
+
version: 0.25.1
|
62
62
|
type: :runtime
|
63
63
|
prerelease: false
|
64
64
|
version_requirements: !ruby/object:Gem::Requirement
|
65
65
|
requirements:
|
66
66
|
- - "~>"
|
67
67
|
- !ruby/object:Gem::Version
|
68
|
-
version:
|
68
|
+
version: 0.25.1
|
69
69
|
- !ruby/object:Gem::Dependency
|
70
70
|
name: neatjson
|
71
71
|
requirement: !ruby/object:Gem::Requirement
|
@@ -184,14 +184,14 @@ dependencies:
|
|
184
184
|
requirements:
|
185
185
|
- - "~>"
|
186
186
|
- !ruby/object:Gem::Version
|
187
|
-
version: '0.
|
187
|
+
version: '0.3'
|
188
188
|
type: :runtime
|
189
189
|
prerelease: false
|
190
190
|
version_requirements: !ruby/object:Gem::Requirement
|
191
191
|
requirements:
|
192
192
|
- - "~>"
|
193
193
|
- !ruby/object:Gem::Version
|
194
|
-
version: '0.
|
194
|
+
version: '0.3'
|
195
195
|
- !ruby/object:Gem::Dependency
|
196
196
|
name: bundler
|
197
197
|
requirement: !ruby/object:Gem::Requirement
|
@@ -246,6 +246,7 @@ files:
|
|
246
246
|
- ".github/workflows/push-docker-publish.yml"
|
247
247
|
- ".gitignore"
|
248
248
|
- ".rspec"
|
249
|
+
- ".travis.yml"
|
249
250
|
- CHANGELOG.md
|
250
251
|
- CONTRIBUTING.md
|
251
252
|
- Dockerfile
|