@loopback/openapi-spec-builder 4.0.0-alpha.6 → 4.0.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.
- package/LICENSE +1 -1
- package/README.md +57 -28
- package/dist/index.d.ts +18 -0
- package/dist/index.js +26 -0
- package/dist/index.js.map +1 -0
- package/dist/openapi-spec-builder.d.ts +188 -0
- package/dist/openapi-spec-builder.js +352 -0
- package/dist/openapi-spec-builder.js.map +1 -0
- package/package.json +37 -24
- package/src/index.ts +24 -0
- package/src/openapi-spec-builder.ts +394 -0
- package/api-docs/apple-touch-icon-114x114-precomposed.png +0 -0
- package/api-docs/apple-touch-icon-144x144-precomposed.png +0 -0
- package/api-docs/apple-touch-icon-57x57-precomposed.png +0 -0
- package/api-docs/apple-touch-icon-72x72-precomposed.png +0 -0
- package/api-docs/apple-touch-icon-precomposed.png +0 -0
- package/api-docs/apple-touch-icon.png +0 -0
- package/api-docs/css/bootstrap.min.css +0 -9
- package/api-docs/css/code-themes/arta.css +0 -158
- package/api-docs/css/code-themes/ascetic.css +0 -50
- package/api-docs/css/code-themes/brown_paper.css +0 -104
- package/api-docs/css/code-themes/brown_papersq.png +0 -0
- package/api-docs/css/code-themes/dark.css +0 -103
- package/api-docs/css/code-themes/default.css +0 -135
- package/api-docs/css/code-themes/far.css +0 -111
- package/api-docs/css/code-themes/github.css +0 -127
- package/api-docs/css/code-themes/googlecode.css +0 -144
- package/api-docs/css/code-themes/idea.css +0 -121
- package/api-docs/css/code-themes/ir_black.css +0 -104
- package/api-docs/css/code-themes/magula.css +0 -121
- package/api-docs/css/code-themes/monokai.css +0 -114
- package/api-docs/css/code-themes/pojoaque.css +0 -104
- package/api-docs/css/code-themes/pojoaque.jpg +0 -0
- package/api-docs/css/code-themes/rainbow.css +0 -114
- package/api-docs/css/code-themes/school_book.css +0 -111
- package/api-docs/css/code-themes/school_book.png +0 -0
- package/api-docs/css/code-themes/sl-theme.css +0 -45
- package/api-docs/css/code-themes/solarized_dark.css +0 -88
- package/api-docs/css/code-themes/solarized_light.css +0 -88
- package/api-docs/css/code-themes/sunburst.css +0 -158
- package/api-docs/css/code-themes/tomorrow-night-blue.css +0 -52
- package/api-docs/css/code-themes/tomorrow-night-bright.css +0 -51
- package/api-docs/css/code-themes/tomorrow-night-eighties.css +0 -51
- package/api-docs/css/code-themes/tomorrow-night.css +0 -52
- package/api-docs/css/code-themes/tomorrow.css +0 -49
- package/api-docs/css/code-themes/vs.css +0 -86
- package/api-docs/css/code-themes/xcode.css +0 -154
- package/api-docs/css/code-themes/zenburn.css +0 -115
- package/api-docs/css/main.css +0 -139
- package/api-docs/favicon.ico +0 -0
- package/api-docs/fonts/0ihfXUL2emPh0ROJezvraLO3LdcAZYWl9Si6vvxL-qU.woff +0 -0
- package/api-docs/fonts/OsJ2DjdpjqFRVUSto6IffLO3LdcAZYWl9Si6vvxL-qU.woff +0 -0
- package/api-docs/fonts/_aijTyevf54tkVDLy-dlnLO3LdcAZYWl9Si6vvxL-qU.woff +0 -0
- package/api-docs/index.html +0 -1021
- package/api-docs/js/main.js +0 -19
- package/api-docs/js/vendor/bootstrap.min.js +0 -6
- package/api-docs/js/vendor/jquery-1.10.1.min.js +0 -6
- package/api-docs/js/vendor/jquery.scrollTo-1.4.3.1.js +0 -218
- package/api-docs/js/vendor/modernizr-2.6.2-respond-1.1.0.min.js +0 -11
- package/index.d.ts +0 -6
- package/index.js +0 -9
- package/lib/index.d.ts +0 -1
- package/lib/index.js +0 -11
- package/lib/index.js.map +0 -1
- package/lib/openapi-spec-builder.d.ts +0 -82
- package/lib/openapi-spec-builder.js +0 -138
- package/lib/openapi-spec-builder.js.map +0 -1
- package/lib6/index.d.ts +0 -1
- package/lib6/index.js +0 -11
- package/lib6/index.js.map +0 -1
- package/lib6/openapi-spec-builder.d.ts +0 -82
- package/lib6/openapi-spec-builder.js +0 -138
- package/lib6/openapi-spec-builder.js.map +0 -1
package/api-docs/index.html
DELETED
|
@@ -1,1021 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
|
3
|
-
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
|
4
|
-
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
|
5
|
-
<!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
|
|
6
|
-
<head>
|
|
7
|
-
<meta charset="utf-8">
|
|
8
|
-
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
9
|
-
<title></title>
|
|
10
|
-
<meta name="description" content="">
|
|
11
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
12
|
-
|
|
13
|
-
<link rel="stylesheet" href="css/bootstrap.min.css">
|
|
14
|
-
<link rel="stylesheet" href="css/code-themes/sl-theme.css">
|
|
15
|
-
<link rel="stylesheet" href="css/main.css">
|
|
16
|
-
</head>
|
|
17
|
-
<body>
|
|
18
|
-
<div class="navbar navbar-inverse navbar-static-top" role="navigation">
|
|
19
|
-
<div class="navbar-header">
|
|
20
|
-
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
|
|
21
|
-
<span class="icon-bar"></span>
|
|
22
|
-
<span class="icon-bar"></span>
|
|
23
|
-
<span class="icon-bar"></span>
|
|
24
|
-
</button>
|
|
25
|
-
<a class="navbar-brand" href="/">docs.strongloop.com</a>
|
|
26
|
-
</div>
|
|
27
|
-
<div id="modules"></div>
|
|
28
|
-
</div>
|
|
29
|
-
|
|
30
|
-
<div class="row">
|
|
31
|
-
<div class="col-lg-3 column scroll-spy-target">
|
|
32
|
-
<ul class="nav nav-pills nav-stacked">
|
|
33
|
-
<div id="versions"></div>
|
|
34
|
-
|
|
35
|
-
<li class="depth-3">
|
|
36
|
-
<a href="#BuilderBase">Class: BuilderBase</a>
|
|
37
|
-
</li>
|
|
38
|
-
|
|
39
|
-
<li class="depth-4">
|
|
40
|
-
<a href="#78">constructor</a>
|
|
41
|
-
</li>
|
|
42
|
-
|
|
43
|
-
<li class="depth-4">
|
|
44
|
-
<a href="#85">build</a>
|
|
45
|
-
</li>
|
|
46
|
-
|
|
47
|
-
<li class="depth-4">
|
|
48
|
-
<a href="#81">withExtension</a>
|
|
49
|
-
</li>
|
|
50
|
-
|
|
51
|
-
<li class="depth-3">
|
|
52
|
-
<a href="#OpenApiSpecBuilder">Class: OpenApiSpecBuilder</a>
|
|
53
|
-
</li>
|
|
54
|
-
|
|
55
|
-
<li class="depth-4">
|
|
56
|
-
<a href="#88">constructor</a>
|
|
57
|
-
</li>
|
|
58
|
-
|
|
59
|
-
<li class="depth-4">
|
|
60
|
-
<a href="#90">withOperation</a>
|
|
61
|
-
</li>
|
|
62
|
-
|
|
63
|
-
<li class="depth-4">
|
|
64
|
-
<a href="#95">withOperationReturningString</a>
|
|
65
|
-
</li>
|
|
66
|
-
|
|
67
|
-
<li class="depth-3">
|
|
68
|
-
<a href="#OperationSpecBuilder">Class: OperationSpecBuilder</a>
|
|
69
|
-
</li>
|
|
70
|
-
|
|
71
|
-
<li class="depth-4">
|
|
72
|
-
<a href="#108">constructor</a>
|
|
73
|
-
</li>
|
|
74
|
-
|
|
75
|
-
<li class="depth-4">
|
|
76
|
-
<a href="#120">withOperationName</a>
|
|
77
|
-
</li>
|
|
78
|
-
|
|
79
|
-
<li class="depth-4">
|
|
80
|
-
<a href="#117">withParameter</a>
|
|
81
|
-
</li>
|
|
82
|
-
|
|
83
|
-
<li class="depth-4">
|
|
84
|
-
<a href="#110">withResponse</a>
|
|
85
|
-
</li>
|
|
86
|
-
|
|
87
|
-
<li class="depth-4">
|
|
88
|
-
<a href="#114">withStringResponse</a>
|
|
89
|
-
</li>
|
|
90
|
-
|
|
91
|
-
<li class="depth-3">
|
|
92
|
-
<a href="#Extendable">Interface: Extendable</a>
|
|
93
|
-
</li>
|
|
94
|
-
|
|
95
|
-
<li class="depth-3">
|
|
96
|
-
<a href="#130">Function: anOpenApiSpec</a>
|
|
97
|
-
</li>
|
|
98
|
-
|
|
99
|
-
<li class="depth-3">
|
|
100
|
-
<a href="#132">Function: anOperationSpec</a>
|
|
101
|
-
</li>
|
|
102
|
-
|
|
103
|
-
</ul>
|
|
104
|
-
|
|
105
|
-
</div>
|
|
106
|
-
<div class="col-lg-9 col-lg-offset-3 column" data-spy="scroll" data-target=".scroll-spy-target" data-offset="0">
|
|
107
|
-
<div class="readability">
|
|
108
|
-
|
|
109
|
-
<section class="code-doc ">
|
|
110
|
-
<a name="BuilderBase"></a>
|
|
111
|
-
<h3 class="code-ref">Class: builderbase = new BuilderBase()</h3>
|
|
112
|
-
<!--
|
|
113
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
114
|
-
Function and Parameters of constructor or function.
|
|
115
|
-
(Excludes Type alias).
|
|
116
|
-
-->
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
</section>
|
|
123
|
-
|
|
124
|
-
<section class="code-doc ">
|
|
125
|
-
<a name="78"></a>
|
|
126
|
-
|
|
127
|
-
<h4 class="code-ref">constructor(initialSpec: T) : BuilderBase</h4>
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
<!--
|
|
131
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
132
|
-
Function and Parameters of constructor or function.
|
|
133
|
-
(Excludes Type alias).
|
|
134
|
-
-->
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
<div class="code-arguments-hdr">Arguments</div>
|
|
142
|
-
<table class="params code-arguments">
|
|
143
|
-
<tr>
|
|
144
|
-
<th class="hdr-name">Name</th>
|
|
145
|
-
<th class="hdr-type">Type</th>
|
|
146
|
-
<th class="hdr-desc">Description</th>
|
|
147
|
-
</tr>
|
|
148
|
-
|
|
149
|
-
<tr class="code-arg">
|
|
150
|
-
<td>
|
|
151
|
-
<strong class="code-arg-name">initialSpec</strong>
|
|
152
|
-
</td>
|
|
153
|
-
<td class="code-arg-types">
|
|
154
|
-
|
|
155
|
-
<code>T</code>
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
</td>
|
|
159
|
-
<td class="code-arg-desc">
|
|
160
|
-
<!--
|
|
161
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
162
|
-
Function and Parameters of constructor or function.
|
|
163
|
-
(Excludes Type alias).
|
|
164
|
-
-->
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
</td>
|
|
171
|
-
</tr>
|
|
172
|
-
|
|
173
|
-
</table>
|
|
174
|
-
|
|
175
|
-
</section>
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
<section class="code-doc ">
|
|
179
|
-
<a name="85"></a>
|
|
180
|
-
|
|
181
|
-
<h4 class="code-ref">build() : T</h4>
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
<!--
|
|
185
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
186
|
-
Function and Parameters of constructor or function.
|
|
187
|
-
(Excludes Type alias).
|
|
188
|
-
-->
|
|
189
|
-
|
|
190
|
-
<div class="code-desc">
|
|
191
|
-
<p><p>Build the spec object.</p>
|
|
192
|
-
</p>
|
|
193
|
-
<p></p>
|
|
194
|
-
</div>
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
</section>
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
<section class="code-doc ">
|
|
206
|
-
<a name="81"></a>
|
|
207
|
-
|
|
208
|
-
<h4 class="code-ref">withExtension(key: string, value: <a href="#ExtensionValue">ExtensionValue</a>) : this</h4>
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
<!--
|
|
212
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
213
|
-
Function and Parameters of constructor or function.
|
|
214
|
-
(Excludes Type alias).
|
|
215
|
-
-->
|
|
216
|
-
|
|
217
|
-
<div class="code-desc">
|
|
218
|
-
<p><p>Add a custom (extension) property to the spec object.</p>
|
|
219
|
-
</p>
|
|
220
|
-
<p></p>
|
|
221
|
-
</div>
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
<div class="code-arguments-hdr">Arguments</div>
|
|
229
|
-
<table class="params code-arguments">
|
|
230
|
-
<tr>
|
|
231
|
-
<th class="hdr-name">Name</th>
|
|
232
|
-
<th class="hdr-type">Type</th>
|
|
233
|
-
<th class="hdr-desc">Description</th>
|
|
234
|
-
</tr>
|
|
235
|
-
|
|
236
|
-
<tr class="code-arg">
|
|
237
|
-
<td>
|
|
238
|
-
<strong class="code-arg-name">key</strong>
|
|
239
|
-
</td>
|
|
240
|
-
<td class="code-arg-types">
|
|
241
|
-
|
|
242
|
-
<code>string</code>
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
</td>
|
|
246
|
-
<td class="code-arg-desc">
|
|
247
|
-
<!--
|
|
248
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
249
|
-
Function and Parameters of constructor or function.
|
|
250
|
-
(Excludes Type alias).
|
|
251
|
-
-->
|
|
252
|
-
|
|
253
|
-
<div class="code-desc">
|
|
254
|
-
<p></p>
|
|
255
|
-
<p><p>The property name starting with "x-".</p>
|
|
256
|
-
</p>
|
|
257
|
-
</div>
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
</td>
|
|
264
|
-
</tr>
|
|
265
|
-
|
|
266
|
-
<tr class="code-arg">
|
|
267
|
-
<td>
|
|
268
|
-
<strong class="code-arg-name">value</strong>
|
|
269
|
-
</td>
|
|
270
|
-
<td class="code-arg-types">
|
|
271
|
-
|
|
272
|
-
<code><a href="#ExtensionValue">ExtensionValue</a></code>
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
</td>
|
|
276
|
-
<td class="code-arg-desc">
|
|
277
|
-
<!--
|
|
278
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
279
|
-
Function and Parameters of constructor or function.
|
|
280
|
-
(Excludes Type alias).
|
|
281
|
-
-->
|
|
282
|
-
|
|
283
|
-
<div class="code-desc">
|
|
284
|
-
<p></p>
|
|
285
|
-
<p><p>The property value.</p>
|
|
286
|
-
</p>
|
|
287
|
-
</div>
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
</td>
|
|
294
|
-
</tr>
|
|
295
|
-
|
|
296
|
-
</table>
|
|
297
|
-
|
|
298
|
-
</section>
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
<section class="code-doc ">
|
|
303
|
-
<a name="OpenApiSpecBuilder"></a>
|
|
304
|
-
<h3 class="code-ref">Class: openapispecbuilder = new OpenApiSpecBuilder()</h3>
|
|
305
|
-
<!--
|
|
306
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
307
|
-
Function and Parameters of constructor or function.
|
|
308
|
-
(Excludes Type alias).
|
|
309
|
-
-->
|
|
310
|
-
|
|
311
|
-
<div class="code-desc">
|
|
312
|
-
<p><p>A builder for creating OpenApiSpec documents.</p>
|
|
313
|
-
</p>
|
|
314
|
-
<p></p>
|
|
315
|
-
</div>
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
</section>
|
|
322
|
-
|
|
323
|
-
<section class="code-doc ">
|
|
324
|
-
<a name="88"></a>
|
|
325
|
-
|
|
326
|
-
<h4 class="code-ref">constructor() : OpenApiSpecBuilder</h4>
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
<!--
|
|
330
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
331
|
-
Function and Parameters of constructor or function.
|
|
332
|
-
(Excludes Type alias).
|
|
333
|
-
-->
|
|
334
|
-
|
|
335
|
-
<div class="code-desc">
|
|
336
|
-
<p></p>
|
|
337
|
-
<p></p>
|
|
338
|
-
</div>
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
</section>
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
<section class="code-doc ">
|
|
349
|
-
<a name="90"></a>
|
|
350
|
-
|
|
351
|
-
<h4 class="code-ref">withOperation(verb: string, path: string, spec: undefined) : this</h4>
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
<!--
|
|
355
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
356
|
-
Function and Parameters of constructor or function.
|
|
357
|
-
(Excludes Type alias).
|
|
358
|
-
-->
|
|
359
|
-
|
|
360
|
-
<div class="code-desc">
|
|
361
|
-
<p><p>Define a new OperationObject at the given path and verb (method).</p>
|
|
362
|
-
</p>
|
|
363
|
-
<p></p>
|
|
364
|
-
</div>
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
<div class="code-arguments-hdr">Arguments</div>
|
|
372
|
-
<table class="params code-arguments">
|
|
373
|
-
<tr>
|
|
374
|
-
<th class="hdr-name">Name</th>
|
|
375
|
-
<th class="hdr-type">Type</th>
|
|
376
|
-
<th class="hdr-desc">Description</th>
|
|
377
|
-
</tr>
|
|
378
|
-
|
|
379
|
-
<tr class="code-arg">
|
|
380
|
-
<td>
|
|
381
|
-
<strong class="code-arg-name">verb</strong>
|
|
382
|
-
</td>
|
|
383
|
-
<td class="code-arg-types">
|
|
384
|
-
|
|
385
|
-
<code>string</code>
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
</td>
|
|
389
|
-
<td class="code-arg-desc">
|
|
390
|
-
<!--
|
|
391
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
392
|
-
Function and Parameters of constructor or function.
|
|
393
|
-
(Excludes Type alias).
|
|
394
|
-
-->
|
|
395
|
-
|
|
396
|
-
<div class="code-desc">
|
|
397
|
-
<p></p>
|
|
398
|
-
<p><p>The HTTP verb.</p>
|
|
399
|
-
</p>
|
|
400
|
-
</div>
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
</td>
|
|
407
|
-
</tr>
|
|
408
|
-
|
|
409
|
-
<tr class="code-arg">
|
|
410
|
-
<td>
|
|
411
|
-
<strong class="code-arg-name">path</strong>
|
|
412
|
-
</td>
|
|
413
|
-
<td class="code-arg-types">
|
|
414
|
-
|
|
415
|
-
<code>string</code>
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
</td>
|
|
419
|
-
<td class="code-arg-desc">
|
|
420
|
-
<!--
|
|
421
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
422
|
-
Function and Parameters of constructor or function.
|
|
423
|
-
(Excludes Type alias).
|
|
424
|
-
-->
|
|
425
|
-
|
|
426
|
-
<div class="code-desc">
|
|
427
|
-
<p></p>
|
|
428
|
-
<p><p>The path relative to basePath.</p>
|
|
429
|
-
</p>
|
|
430
|
-
</div>
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
</td>
|
|
437
|
-
</tr>
|
|
438
|
-
|
|
439
|
-
<tr class="code-arg">
|
|
440
|
-
<td>
|
|
441
|
-
<strong class="code-arg-name">spec</strong>
|
|
442
|
-
</td>
|
|
443
|
-
<td class="code-arg-types">
|
|
444
|
-
|
|
445
|
-
<code></code>
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
</td>
|
|
449
|
-
<td class="code-arg-desc">
|
|
450
|
-
<!--
|
|
451
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
452
|
-
Function and Parameters of constructor or function.
|
|
453
|
-
(Excludes Type alias).
|
|
454
|
-
-->
|
|
455
|
-
|
|
456
|
-
<div class="code-desc">
|
|
457
|
-
<p></p>
|
|
458
|
-
<p><p>Additional specification of the operation.</p>
|
|
459
|
-
</p>
|
|
460
|
-
</div>
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
</td>
|
|
467
|
-
</tr>
|
|
468
|
-
|
|
469
|
-
</table>
|
|
470
|
-
|
|
471
|
-
</section>
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
<section class="code-doc ">
|
|
476
|
-
<a name="95"></a>
|
|
477
|
-
|
|
478
|
-
<h4 class="code-ref">withOperationReturningString(verb: string, path: string, operationName: string) : this</h4>
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
<!--
|
|
482
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
483
|
-
Function and Parameters of constructor or function.
|
|
484
|
-
(Excludes Type alias).
|
|
485
|
-
-->
|
|
486
|
-
|
|
487
|
-
<div class="code-desc">
|
|
488
|
-
<p><p>Define a new operation that returns a string response.</p>
|
|
489
|
-
</p>
|
|
490
|
-
<p></p>
|
|
491
|
-
</div>
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
<div class="code-arguments-hdr">Arguments</div>
|
|
499
|
-
<table class="params code-arguments">
|
|
500
|
-
<tr>
|
|
501
|
-
<th class="hdr-name">Name</th>
|
|
502
|
-
<th class="hdr-type">Type</th>
|
|
503
|
-
<th class="hdr-desc">Description</th>
|
|
504
|
-
</tr>
|
|
505
|
-
|
|
506
|
-
<tr class="code-arg">
|
|
507
|
-
<td>
|
|
508
|
-
<strong class="code-arg-name">verb</strong>
|
|
509
|
-
</td>
|
|
510
|
-
<td class="code-arg-types">
|
|
511
|
-
|
|
512
|
-
<code>string</code>
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
</td>
|
|
516
|
-
<td class="code-arg-desc">
|
|
517
|
-
<!--
|
|
518
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
519
|
-
Function and Parameters of constructor or function.
|
|
520
|
-
(Excludes Type alias).
|
|
521
|
-
-->
|
|
522
|
-
|
|
523
|
-
<div class="code-desc">
|
|
524
|
-
<p></p>
|
|
525
|
-
<p><p>The HTTP verb.</p>
|
|
526
|
-
</p>
|
|
527
|
-
</div>
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
</td>
|
|
534
|
-
</tr>
|
|
535
|
-
|
|
536
|
-
<tr class="code-arg">
|
|
537
|
-
<td>
|
|
538
|
-
<strong class="code-arg-name">path</strong>
|
|
539
|
-
</td>
|
|
540
|
-
<td class="code-arg-types">
|
|
541
|
-
|
|
542
|
-
<code>string</code>
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
</td>
|
|
546
|
-
<td class="code-arg-desc">
|
|
547
|
-
<!--
|
|
548
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
549
|
-
Function and Parameters of constructor or function.
|
|
550
|
-
(Excludes Type alias).
|
|
551
|
-
-->
|
|
552
|
-
|
|
553
|
-
<div class="code-desc">
|
|
554
|
-
<p></p>
|
|
555
|
-
<p><p>The path relative to basePath.</p>
|
|
556
|
-
</p>
|
|
557
|
-
</div>
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
</td>
|
|
564
|
-
</tr>
|
|
565
|
-
|
|
566
|
-
<tr class="code-arg">
|
|
567
|
-
<td>
|
|
568
|
-
<strong class="code-arg-name">operationName</strong>
|
|
569
|
-
</td>
|
|
570
|
-
<td class="code-arg-types">
|
|
571
|
-
|
|
572
|
-
<code>string</code>
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
</td>
|
|
576
|
-
<td class="code-arg-desc">
|
|
577
|
-
<!--
|
|
578
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
579
|
-
Function and Parameters of constructor or function.
|
|
580
|
-
(Excludes Type alias).
|
|
581
|
-
-->
|
|
582
|
-
|
|
583
|
-
<div class="code-desc">
|
|
584
|
-
<p></p>
|
|
585
|
-
<p><p>The name of the controller method implementing
|
|
586
|
-
this operation (<code>x-operation-name</code> field).</p>
|
|
587
|
-
</p>
|
|
588
|
-
</div>
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
</td>
|
|
595
|
-
</tr>
|
|
596
|
-
|
|
597
|
-
</table>
|
|
598
|
-
|
|
599
|
-
</section>
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
<section class="code-doc ">
|
|
604
|
-
<a name="OperationSpecBuilder"></a>
|
|
605
|
-
<h3 class="code-ref">Class: operationspecbuilder = new OperationSpecBuilder()</h3>
|
|
606
|
-
<!--
|
|
607
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
608
|
-
Function and Parameters of constructor or function.
|
|
609
|
-
(Excludes Type alias).
|
|
610
|
-
-->
|
|
611
|
-
|
|
612
|
-
<div class="code-desc">
|
|
613
|
-
<p><p>A builder for creating OperationObject specifications.</p>
|
|
614
|
-
</p>
|
|
615
|
-
<p></p>
|
|
616
|
-
</div>
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
</section>
|
|
623
|
-
|
|
624
|
-
<section class="code-doc ">
|
|
625
|
-
<a name="108"></a>
|
|
626
|
-
|
|
627
|
-
<h4 class="code-ref">constructor() : OperationSpecBuilder</h4>
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
<!--
|
|
631
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
632
|
-
Function and Parameters of constructor or function.
|
|
633
|
-
(Excludes Type alias).
|
|
634
|
-
-->
|
|
635
|
-
|
|
636
|
-
<div class="code-desc">
|
|
637
|
-
<p><p>A builder for creating OperationObject specifications.</p>
|
|
638
|
-
</p>
|
|
639
|
-
<p></p>
|
|
640
|
-
</div>
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
</section>
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
<section class="code-doc ">
|
|
651
|
-
<a name="120"></a>
|
|
652
|
-
|
|
653
|
-
<h4 class="code-ref">withOperationName(name: string) : this</h4>
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
<!--
|
|
657
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
658
|
-
Function and Parameters of constructor or function.
|
|
659
|
-
(Excludes Type alias).
|
|
660
|
-
-->
|
|
661
|
-
|
|
662
|
-
<div class="code-desc">
|
|
663
|
-
<p><p>Define the operation name (controller method name).</p>
|
|
664
|
-
</p>
|
|
665
|
-
<p></p>
|
|
666
|
-
</div>
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
<div class="code-arguments-hdr">Arguments</div>
|
|
674
|
-
<table class="params code-arguments">
|
|
675
|
-
<tr>
|
|
676
|
-
<th class="hdr-name">Name</th>
|
|
677
|
-
<th class="hdr-type">Type</th>
|
|
678
|
-
<th class="hdr-desc">Description</th>
|
|
679
|
-
</tr>
|
|
680
|
-
|
|
681
|
-
<tr class="code-arg">
|
|
682
|
-
<td>
|
|
683
|
-
<strong class="code-arg-name">name</strong>
|
|
684
|
-
</td>
|
|
685
|
-
<td class="code-arg-types">
|
|
686
|
-
|
|
687
|
-
<code>string</code>
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
</td>
|
|
691
|
-
<td class="code-arg-desc">
|
|
692
|
-
<!--
|
|
693
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
694
|
-
Function and Parameters of constructor or function.
|
|
695
|
-
(Excludes Type alias).
|
|
696
|
-
-->
|
|
697
|
-
|
|
698
|
-
<div class="code-desc">
|
|
699
|
-
<p></p>
|
|
700
|
-
<p><p>The name of the controller method implementing this operation.</p>
|
|
701
|
-
</p>
|
|
702
|
-
</div>
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
</td>
|
|
709
|
-
</tr>
|
|
710
|
-
|
|
711
|
-
</table>
|
|
712
|
-
|
|
713
|
-
</section>
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
<section class="code-doc ">
|
|
718
|
-
<a name="117"></a>
|
|
719
|
-
|
|
720
|
-
<h4 class="code-ref">withParameter(parameterSpec: <a href="#ParameterObject">ParameterObject</a>) : this</h4>
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
<!--
|
|
724
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
725
|
-
Function and Parameters of constructor or function.
|
|
726
|
-
(Excludes Type alias).
|
|
727
|
-
-->
|
|
728
|
-
|
|
729
|
-
<div class="code-desc">
|
|
730
|
-
<p><p>Describe a parameter accepted by the operation.
|
|
731
|
-
Note that parameters are positional in OpenAPI Spec, therefore
|
|
732
|
-
the first call of <code>withParameter</code> defines the first parameter,
|
|
733
|
-
the second call defines the second parameter, etc.</p>
|
|
734
|
-
</p>
|
|
735
|
-
<p></p>
|
|
736
|
-
</div>
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
<div class="code-arguments-hdr">Arguments</div>
|
|
744
|
-
<table class="params code-arguments">
|
|
745
|
-
<tr>
|
|
746
|
-
<th class="hdr-name">Name</th>
|
|
747
|
-
<th class="hdr-type">Type</th>
|
|
748
|
-
<th class="hdr-desc">Description</th>
|
|
749
|
-
</tr>
|
|
750
|
-
|
|
751
|
-
<tr class="code-arg">
|
|
752
|
-
<td>
|
|
753
|
-
<strong class="code-arg-name">parameterSpec</strong>
|
|
754
|
-
</td>
|
|
755
|
-
<td class="code-arg-types">
|
|
756
|
-
|
|
757
|
-
<code><a href="#ParameterObject">ParameterObject</a></code>
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
</td>
|
|
761
|
-
<td class="code-arg-desc">
|
|
762
|
-
<!--
|
|
763
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
764
|
-
Function and Parameters of constructor or function.
|
|
765
|
-
(Excludes Type alias).
|
|
766
|
-
-->
|
|
767
|
-
|
|
768
|
-
<div class="code-desc">
|
|
769
|
-
<p></p>
|
|
770
|
-
<p></p>
|
|
771
|
-
</div>
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
</td>
|
|
778
|
-
</tr>
|
|
779
|
-
|
|
780
|
-
</table>
|
|
781
|
-
|
|
782
|
-
</section>
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
<section class="code-doc ">
|
|
787
|
-
<a name="110"></a>
|
|
788
|
-
|
|
789
|
-
<h4 class="code-ref">withResponse(status: undefined, responseSpec: <a href="#ResponseObject">ResponseObject</a>) : this</h4>
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
<!--
|
|
793
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
794
|
-
Function and Parameters of constructor or function.
|
|
795
|
-
(Excludes Type alias).
|
|
796
|
-
-->
|
|
797
|
-
|
|
798
|
-
<div class="code-desc">
|
|
799
|
-
<p><p>Describe a response for a given HTTP status code.</p>
|
|
800
|
-
</p>
|
|
801
|
-
<p></p>
|
|
802
|
-
</div>
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
<div class="code-arguments-hdr">Arguments</div>
|
|
810
|
-
<table class="params code-arguments">
|
|
811
|
-
<tr>
|
|
812
|
-
<th class="hdr-name">Name</th>
|
|
813
|
-
<th class="hdr-type">Type</th>
|
|
814
|
-
<th class="hdr-desc">Description</th>
|
|
815
|
-
</tr>
|
|
816
|
-
|
|
817
|
-
<tr class="code-arg">
|
|
818
|
-
<td>
|
|
819
|
-
<strong class="code-arg-name">status</strong>
|
|
820
|
-
</td>
|
|
821
|
-
<td class="code-arg-types">
|
|
822
|
-
|
|
823
|
-
<code></code>
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
</td>
|
|
827
|
-
<td class="code-arg-desc">
|
|
828
|
-
<!--
|
|
829
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
830
|
-
Function and Parameters of constructor or function.
|
|
831
|
-
(Excludes Type alias).
|
|
832
|
-
-->
|
|
833
|
-
|
|
834
|
-
<div class="code-desc">
|
|
835
|
-
<p></p>
|
|
836
|
-
<p><p>HTTP status code or string "default"</p>
|
|
837
|
-
</p>
|
|
838
|
-
</div>
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
</td>
|
|
845
|
-
</tr>
|
|
846
|
-
|
|
847
|
-
<tr class="code-arg">
|
|
848
|
-
<td>
|
|
849
|
-
<strong class="code-arg-name">responseSpec</strong>
|
|
850
|
-
</td>
|
|
851
|
-
<td class="code-arg-types">
|
|
852
|
-
|
|
853
|
-
<code><a href="#ResponseObject">ResponseObject</a></code>
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
</td>
|
|
857
|
-
<td class="code-arg-desc">
|
|
858
|
-
<!--
|
|
859
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
860
|
-
Function and Parameters of constructor or function.
|
|
861
|
-
(Excludes Type alias).
|
|
862
|
-
-->
|
|
863
|
-
|
|
864
|
-
<div class="code-desc">
|
|
865
|
-
<p></p>
|
|
866
|
-
<p><p>Specification of the response</p>
|
|
867
|
-
</p>
|
|
868
|
-
</div>
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
</td>
|
|
875
|
-
</tr>
|
|
876
|
-
|
|
877
|
-
</table>
|
|
878
|
-
|
|
879
|
-
</section>
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
|
|
883
|
-
<section class="code-doc ">
|
|
884
|
-
<a name="114"></a>
|
|
885
|
-
|
|
886
|
-
<h4 class="code-ref">withStringResponse(status: undefined) : this</h4>
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
<!--
|
|
890
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
891
|
-
Function and Parameters of constructor or function.
|
|
892
|
-
(Excludes Type alias).
|
|
893
|
-
-->
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
<div class="code-arguments-hdr">Arguments</div>
|
|
901
|
-
<table class="params code-arguments">
|
|
902
|
-
<tr>
|
|
903
|
-
<th class="hdr-name">Name</th>
|
|
904
|
-
<th class="hdr-type">Type</th>
|
|
905
|
-
<th class="hdr-desc">Description</th>
|
|
906
|
-
</tr>
|
|
907
|
-
|
|
908
|
-
<tr class="code-arg">
|
|
909
|
-
<td>
|
|
910
|
-
<strong class="code-arg-name">status</strong>
|
|
911
|
-
</td>
|
|
912
|
-
<td class="code-arg-types">
|
|
913
|
-
|
|
914
|
-
<code></code>
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
</td>
|
|
918
|
-
<td class="code-arg-desc">
|
|
919
|
-
<!--
|
|
920
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
921
|
-
Function and Parameters of constructor or function.
|
|
922
|
-
(Excludes Type alias).
|
|
923
|
-
-->
|
|
924
|
-
|
|
925
|
-
<div class="code-desc">
|
|
926
|
-
<p><p>A builder for creating OperationObject specifications.</p>
|
|
927
|
-
</p>
|
|
928
|
-
<p></p>
|
|
929
|
-
</div>
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
</td>
|
|
936
|
-
</tr>
|
|
937
|
-
|
|
938
|
-
</table>
|
|
939
|
-
|
|
940
|
-
</section>
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
<section class="code-doc ">
|
|
945
|
-
<a name="Extendable"></a>
|
|
946
|
-
<h3 class="code-ref">Interface: Extendable</h3>
|
|
947
|
-
<!--
|
|
948
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
949
|
-
Function and Parameters of constructor or function.
|
|
950
|
-
(Excludes Type alias).
|
|
951
|
-
-->
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
</section>
|
|
958
|
-
|
|
959
|
-
<section class="code-doc ">
|
|
960
|
-
<a name="130"></a>
|
|
961
|
-
|
|
962
|
-
<h4 class="code-ref">anOpenApiSpec() : OpenApiSpecBuilder</h4>
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
<!--
|
|
966
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
967
|
-
Function and Parameters of constructor or function.
|
|
968
|
-
(Excludes Type alias).
|
|
969
|
-
-->
|
|
970
|
-
|
|
971
|
-
<div class="code-desc">
|
|
972
|
-
<p><p>Create a new instance of OpenApiSpecBuilder.</p>
|
|
973
|
-
</p>
|
|
974
|
-
<p></p>
|
|
975
|
-
</div>
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
</section>
|
|
983
|
-
|
|
984
|
-
<section class="code-doc ">
|
|
985
|
-
<a name="132"></a>
|
|
986
|
-
|
|
987
|
-
<h4 class="code-ref">anOperationSpec() : OperationSpecBuilder</h4>
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
<!--
|
|
991
|
-
Used for displaying comments in Class, Interface, Properties Constructor,
|
|
992
|
-
Function and Parameters of constructor or function.
|
|
993
|
-
(Excludes Type alias).
|
|
994
|
-
-->
|
|
995
|
-
|
|
996
|
-
<div class="code-desc">
|
|
997
|
-
<p><p>Create a new instance of OperationSpecBuilder.</p>
|
|
998
|
-
</p>
|
|
999
|
-
<p></p>
|
|
1000
|
-
</div>
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
</section>
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
</div>
|
|
1012
|
-
<div class="intentionally-left-blank"></div>
|
|
1013
|
-
</div>
|
|
1014
|
-
</div>
|
|
1015
|
-
<script src="js/vendor/jquery-1.10.1.min.js"></script>
|
|
1016
|
-
<script src="js/vendor/jquery.scrollTo-1.4.3.1.js"></script>
|
|
1017
|
-
<script src="js/vendor/bootstrap.min.js"></script>
|
|
1018
|
-
<script src="js/main.js"></script>
|
|
1019
|
-
</body>
|
|
1020
|
-
</html>
|
|
1021
|
-
|