@atlassian/atlassian-openapi 1.0.3
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/README.md +15 -0
- package/lib/index.d.ts +4 -0
- package/lib/index.js +16 -0
- package/lib/lookup.d.ts +50 -0
- package/lib/lookup.js +108 -0
- package/lib/operation-grouping.d.ts +28 -0
- package/lib/operation-grouping.js +183 -0
- package/lib/swagger.d.ts +837 -0
- package/lib/swagger.js +2 -0
- package/lib/test-functions.d.ts +2 -0
- package/lib/test-functions.js +15 -0
- package/lib/type-checks.d.ts +33 -0
- package/lib/type-checks.js +380 -0
- package/package.json +48 -0
package/lib/swagger.d.ts
ADDED
@@ -0,0 +1,837 @@
|
|
1
|
+
export declare namespace Swagger {
|
2
|
+
/**
|
3
|
+
* This file was automatically generated by json-schema-to-typescript.
|
4
|
+
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
|
5
|
+
* and run json-schema-to-typescript to regenerate this file.
|
6
|
+
*/
|
7
|
+
type ParameterOrRef = Parameter | Reference;
|
8
|
+
/**
|
9
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
10
|
+
* via the `definition` "Parameter".
|
11
|
+
*/
|
12
|
+
type Parameter = ParameterWithSchema | ParameterWithContent;
|
13
|
+
/**
|
14
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
15
|
+
* via the `definition` "ParameterWithSchema".
|
16
|
+
*/
|
17
|
+
type ParameterWithSchema = ParameterWithSchemaWithExample | ParameterWithSchemaWithExamples;
|
18
|
+
/**
|
19
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
20
|
+
* via the `definition` "ParameterWithSchemaWithExample".
|
21
|
+
*/
|
22
|
+
type ParameterWithSchemaWithExample = ParameterWithSchemaWithExampleInPath | ParameterWithSchemaWithExampleInQuery | ParameterWithSchemaWithExampleInHeader | ParameterWithSchemaWithExampleInCookie;
|
23
|
+
/**
|
24
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
25
|
+
* via the `definition` "ParameterWithSchemaWithExamples".
|
26
|
+
*/
|
27
|
+
type ParameterWithSchemaWithExamples = ParameterWithSchemaWithExamplesInPath | ParameterWithSchemaWithExamplesInQuery | ParameterWithSchemaWithExamplesInHeader | ParameterWithSchemaWithExamplesInCookie;
|
28
|
+
/**
|
29
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
30
|
+
* via the `definition` "ParameterWithContent".
|
31
|
+
*/
|
32
|
+
type ParameterWithContent = ParameterWithContentInPath | ParameterWithContentNotInPath;
|
33
|
+
/**
|
34
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
35
|
+
* via the `definition` "MediaType".
|
36
|
+
*/
|
37
|
+
type MediaType = MediaTypeWithExample | MediaTypeWithExamples;
|
38
|
+
/**
|
39
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
40
|
+
* via the `definition` "Header".
|
41
|
+
*/
|
42
|
+
type Header = HeaderWithSchema | HeaderWithContent;
|
43
|
+
/**
|
44
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
45
|
+
* via the `definition` "HeaderWithSchema".
|
46
|
+
*/
|
47
|
+
type HeaderWithSchema = HeaderWithSchemaWithExample | HeaderWithSchemaWithExamples;
|
48
|
+
/**
|
49
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
50
|
+
* via the `definition` "Link".
|
51
|
+
*/
|
52
|
+
type Link = LinkWithOperationRef | LinkWithOperationId;
|
53
|
+
/**
|
54
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
55
|
+
* via the `definition` "SecurityScheme".
|
56
|
+
*/
|
57
|
+
type SecurityScheme = ApiKeySecurityScheme | HttpSecurityScheme | OAuth2SecurityScheme | OpenIdConnectSecurityScheme;
|
58
|
+
/**
|
59
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
60
|
+
* via the `definition` "HTTPSecurityScheme".
|
61
|
+
*/
|
62
|
+
type HttpSecurityScheme = NonBearerHttpSecurityScheme | BearerHttpSecurityScheme;
|
63
|
+
interface SwaggerV3 {
|
64
|
+
openapi: string;
|
65
|
+
info: Info;
|
66
|
+
externalDocs?: ExternalDocumentation;
|
67
|
+
servers?: Server[];
|
68
|
+
/**
|
69
|
+
* A declaration of which security mechanisms can be used across the API. The list of values includes alternative
|
70
|
+
* security requirement objects that can be used. Only one of the security requirement objects need to be satisfied
|
71
|
+
* to authorize a request. Individual operations can override this definition.
|
72
|
+
*/
|
73
|
+
security?: SecurityRequirement[];
|
74
|
+
tags?: Tag[];
|
75
|
+
paths: Paths;
|
76
|
+
components?: Components;
|
77
|
+
"x-atlassian-narrative"?: AtlassianNarrative;
|
78
|
+
}
|
79
|
+
interface AtlassianNarrative {
|
80
|
+
documents: NarrativeDocument[];
|
81
|
+
}
|
82
|
+
interface NarrativeDocument {
|
83
|
+
title: string;
|
84
|
+
anchor: string;
|
85
|
+
body: string;
|
86
|
+
}
|
87
|
+
/**
|
88
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
89
|
+
* via the `definition` "Info".
|
90
|
+
*/
|
91
|
+
interface Info {
|
92
|
+
title: string;
|
93
|
+
description?: string;
|
94
|
+
termsOfService?: string;
|
95
|
+
contact?: Contact;
|
96
|
+
license?: License;
|
97
|
+
version: string;
|
98
|
+
}
|
99
|
+
/**
|
100
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
101
|
+
* via the `definition` "Contact".
|
102
|
+
*/
|
103
|
+
interface Contact {
|
104
|
+
name?: string;
|
105
|
+
url?: string;
|
106
|
+
email?: string;
|
107
|
+
}
|
108
|
+
/**
|
109
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
110
|
+
* via the `definition` "License".
|
111
|
+
*/
|
112
|
+
interface License {
|
113
|
+
name: string;
|
114
|
+
url?: string;
|
115
|
+
}
|
116
|
+
/**
|
117
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
118
|
+
* via the `definition` "ExternalDocumentation".
|
119
|
+
*/
|
120
|
+
interface ExternalDocumentation {
|
121
|
+
description?: string;
|
122
|
+
url: string;
|
123
|
+
}
|
124
|
+
/**
|
125
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
126
|
+
* via the `definition` "Server".
|
127
|
+
*/
|
128
|
+
interface Server {
|
129
|
+
url: string;
|
130
|
+
description?: string;
|
131
|
+
variables?: {
|
132
|
+
[k: string]: ServerVariable;
|
133
|
+
};
|
134
|
+
}
|
135
|
+
/**
|
136
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
137
|
+
* via the `definition` "ServerVariable".
|
138
|
+
*/
|
139
|
+
interface ServerVariable {
|
140
|
+
enum?: string[];
|
141
|
+
default: string;
|
142
|
+
description?: string;
|
143
|
+
}
|
144
|
+
/**
|
145
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
146
|
+
* via the `definition` "SecurityRequirement".
|
147
|
+
*
|
148
|
+
* If the security scheme is of type "oauth2" or "openIdConnect",
|
149
|
+
* then the value is a list of scope names required for the execution.
|
150
|
+
* For other security scheme types, the array MUST be empty.
|
151
|
+
*
|
152
|
+
* Lists the required security schemes to execute this operation. The name used for each property MUST correspond
|
153
|
+
* to a security scheme declared in the Security Schemes under the Components Object.
|
154
|
+
*
|
155
|
+
* Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a
|
156
|
+
* request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers
|
157
|
+
* are required to convey security information.
|
158
|
+
*
|
159
|
+
* When a list of Security Requirement Objects is defined on the Open API object or Operation Object, only
|
160
|
+
* one of Security Requirement Objects in the list needs to be satisfied to authorize the request.
|
161
|
+
*/
|
162
|
+
interface SecurityRequirement {
|
163
|
+
[k: string]: string[];
|
164
|
+
}
|
165
|
+
/**
|
166
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
167
|
+
* via the `definition` "Tag".
|
168
|
+
*/
|
169
|
+
interface Tag {
|
170
|
+
name: string;
|
171
|
+
description?: string;
|
172
|
+
externalDocs?: ExternalDocumentation;
|
173
|
+
}
|
174
|
+
/**
|
175
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
176
|
+
* via the `definition` "Paths".
|
177
|
+
*/
|
178
|
+
interface Paths {
|
179
|
+
[path: string]: PathItem;
|
180
|
+
}
|
181
|
+
type Method = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace";
|
182
|
+
/**
|
183
|
+
* This interface was referenced by `Paths`'s JSON-Schema definition
|
184
|
+
* via the `patternProperty` "^\/".
|
185
|
+
*
|
186
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
187
|
+
* via the `definition` "PathItem".
|
188
|
+
*/
|
189
|
+
interface PathItem {
|
190
|
+
$ref?: string;
|
191
|
+
summary?: string;
|
192
|
+
description?: string;
|
193
|
+
get?: Operation;
|
194
|
+
put?: Operation;
|
195
|
+
post?: Operation;
|
196
|
+
delete?: Operation;
|
197
|
+
options?: Operation;
|
198
|
+
head?: Operation;
|
199
|
+
patch?: Operation;
|
200
|
+
trace?: Operation;
|
201
|
+
servers?: Server[];
|
202
|
+
parameters?: ParameterOrRef[];
|
203
|
+
}
|
204
|
+
/**
|
205
|
+
* New OAuth2 scopes
|
206
|
+
* @see https://hello.atlassian.net/wiki/spaces/redfox/pages/1046875420/RFC+OAuth+scopes+deprecation+in+Jira+-+DAC
|
207
|
+
*/
|
208
|
+
interface OAuth2Scopes {
|
209
|
+
deprecated: boolean;
|
210
|
+
scopes: string[];
|
211
|
+
documentation?: string;
|
212
|
+
}
|
213
|
+
/**
|
214
|
+
* OAuth2 scopes with scope's state
|
215
|
+
* @see https://hello.atlassian.net/wiki/spaces/redfox/pages/1304762888/OpenAPI+-+DAC+contract
|
216
|
+
*/
|
217
|
+
interface OAuth2ScopesWithState {
|
218
|
+
state: OAuth2ScopesState;
|
219
|
+
scopes: string[];
|
220
|
+
scheme?: string;
|
221
|
+
documentation?: string;
|
222
|
+
}
|
223
|
+
type OAuth2ScopesState = "Current" | "Deprecated" | "Beta";
|
224
|
+
/**
|
225
|
+
* Data Security Policy for App Access
|
226
|
+
* @see https://hello.atlassian.net/wiki/spaces/ECOTRUST/pages/3047963369/DACI+-+Swagger+OpenAPI+custom+property+for+app+access
|
227
|
+
*/
|
228
|
+
interface DataSecurityPolicy {
|
229
|
+
"app-access-rule-exempt": boolean;
|
230
|
+
}
|
231
|
+
/**
|
232
|
+
* custom extension required to render scope title in dac based on scope type
|
233
|
+
*
|
234
|
+
* api-token - Authentication with API Tokens
|
235
|
+
*
|
236
|
+
* repository-access-token - Authentication with repository access token
|
237
|
+
*
|
238
|
+
* project-access-token - Authentication with project access token
|
239
|
+
*
|
240
|
+
* workspace-access-token - Authentication with workspace access token
|
241
|
+
*
|
242
|
+
* identity-oauth2 - Authentication with platform OAuth2
|
243
|
+
*
|
244
|
+
* forge-oauth2 - Authentication with platform OAuth2 for Forge apps
|
245
|
+
*
|
246
|
+
* @see https://hello.atlassian.net/wiki/spaces/BB/pages/4484370299/Add+API+Token+scopes+to+bitbucket+documentation
|
247
|
+
*/
|
248
|
+
type AuthTypes = "api-token" | "repository-access-token" | "project-access-token" | "workspace-access-token" | "identity-oauth2" | "forge-oauth2";
|
249
|
+
/**
|
250
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
251
|
+
* via the `definition` "Operation".
|
252
|
+
*/
|
253
|
+
interface Operation {
|
254
|
+
tags?: string[];
|
255
|
+
summary?: string;
|
256
|
+
description?: string;
|
257
|
+
externalDocs?: ExternalDocumentation;
|
258
|
+
operationId?: string;
|
259
|
+
parameters?: ParameterOrRef[];
|
260
|
+
requestBody?: RequestBody | Reference;
|
261
|
+
responses: Responses;
|
262
|
+
callbacks?: {
|
263
|
+
[k: string]: Callback | Reference;
|
264
|
+
};
|
265
|
+
deprecated?: boolean;
|
266
|
+
/**
|
267
|
+
* A declaration of which security mechanisms can be used for this operation. The list of values includes alternative
|
268
|
+
* security requirement objects that can be used. Only one of the security requirement objects need to be satisfied
|
269
|
+
* to authorize a request. This definition overrides any declared top-level security. To remove a top-level security
|
270
|
+
* declaration, an empty array can be used.
|
271
|
+
*/
|
272
|
+
security?: SecurityRequirement[];
|
273
|
+
servers?: Server[];
|
274
|
+
"x-experimental"?: boolean;
|
275
|
+
"x-preview"?: boolean;
|
276
|
+
"x-atlassian-connect-scope"?: string;
|
277
|
+
"x-atlassian-oauth2-scopes"?: OAuth2Scopes[] | OAuth2ScopesWithState[];
|
278
|
+
"x-atlassian-data-security-policy"?: DataSecurityPolicy[];
|
279
|
+
"x-atlassian-auth-types"?: AuthTypes[];
|
280
|
+
}
|
281
|
+
/**
|
282
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
283
|
+
* via the `definition` "ParameterWithSchemaWithExampleInPath".
|
284
|
+
*/
|
285
|
+
interface ParameterWithSchemaWithExampleInPath {
|
286
|
+
name: string;
|
287
|
+
in: "path";
|
288
|
+
description?: string;
|
289
|
+
required: true;
|
290
|
+
deprecated?: boolean;
|
291
|
+
allowEmptyValue?: boolean;
|
292
|
+
style?: "matrix" | "label" | "simple";
|
293
|
+
explode?: boolean;
|
294
|
+
allowReserved?: boolean;
|
295
|
+
schema: Schema | Reference;
|
296
|
+
example?: any;
|
297
|
+
}
|
298
|
+
type SchemaType = "array" | "boolean" | "integer" | "number" | "object" | "string";
|
299
|
+
/**
|
300
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
301
|
+
* via the `definition` "Schema".
|
302
|
+
*/
|
303
|
+
interface Schema {
|
304
|
+
title?: string;
|
305
|
+
multipleOf?: number;
|
306
|
+
maximum?: number;
|
307
|
+
exclusiveMaximum?: boolean;
|
308
|
+
minimum?: number;
|
309
|
+
exclusiveMinimum?: boolean;
|
310
|
+
maxLength?: number;
|
311
|
+
minLength?: number;
|
312
|
+
pattern?: string;
|
313
|
+
maxItems?: number;
|
314
|
+
minItems?: number;
|
315
|
+
uniqueItems?: boolean;
|
316
|
+
maxProperties?: number;
|
317
|
+
minProperties?: number;
|
318
|
+
required?: string[];
|
319
|
+
enum?: any[];
|
320
|
+
type?: SchemaType;
|
321
|
+
not?: Schema | Reference;
|
322
|
+
allOf?: (Schema | Reference)[];
|
323
|
+
oneOf?: (Schema | Reference)[];
|
324
|
+
anyOf?: (Schema | Reference)[];
|
325
|
+
items?: Schema | Reference;
|
326
|
+
properties?: {
|
327
|
+
[k: string]: Schema | Reference;
|
328
|
+
};
|
329
|
+
additionalProperties?: Schema | Reference | boolean;
|
330
|
+
description?: string;
|
331
|
+
format?: string;
|
332
|
+
default?: any;
|
333
|
+
nullable?: boolean;
|
334
|
+
discriminator?: Discriminator;
|
335
|
+
readOnly?: boolean;
|
336
|
+
writeOnly?: boolean;
|
337
|
+
example?: any;
|
338
|
+
externalDocs?: ExternalDocumentation;
|
339
|
+
deprecated?: boolean;
|
340
|
+
xml?: Xml;
|
341
|
+
}
|
342
|
+
/**
|
343
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
344
|
+
* via the `definition` "Reference".
|
345
|
+
*/
|
346
|
+
interface Reference {
|
347
|
+
$ref: string;
|
348
|
+
[k: string]: any;
|
349
|
+
}
|
350
|
+
/**
|
351
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
352
|
+
* via the `definition` "Discriminator".
|
353
|
+
*/
|
354
|
+
interface Discriminator {
|
355
|
+
propertyName: string;
|
356
|
+
mapping?: {
|
357
|
+
[k: string]: string;
|
358
|
+
};
|
359
|
+
[k: string]: any;
|
360
|
+
}
|
361
|
+
/**
|
362
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
363
|
+
* via the `definition` "XML".
|
364
|
+
*/
|
365
|
+
interface Xml {
|
366
|
+
name?: string;
|
367
|
+
namespace?: string;
|
368
|
+
prefix?: string;
|
369
|
+
attribute?: boolean;
|
370
|
+
wrapped?: boolean;
|
371
|
+
}
|
372
|
+
/**
|
373
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
374
|
+
* via the `definition` "ParameterWithSchemaWithExampleInQuery".
|
375
|
+
*/
|
376
|
+
interface ParameterWithSchemaWithExampleInQuery {
|
377
|
+
name: string;
|
378
|
+
in: "query";
|
379
|
+
description?: string;
|
380
|
+
required?: boolean;
|
381
|
+
deprecated?: boolean;
|
382
|
+
allowEmptyValue?: boolean;
|
383
|
+
style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";
|
384
|
+
explode?: boolean;
|
385
|
+
allowReserved?: boolean;
|
386
|
+
schema: Schema | Reference;
|
387
|
+
example?: any;
|
388
|
+
"x-showInExample"?: boolean;
|
389
|
+
}
|
390
|
+
/**
|
391
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
392
|
+
* via the `definition` "ParameterWithSchemaWithExampleInHeader".
|
393
|
+
*/
|
394
|
+
interface ParameterWithSchemaWithExampleInHeader {
|
395
|
+
name: string;
|
396
|
+
in: "header";
|
397
|
+
description?: string;
|
398
|
+
required?: boolean;
|
399
|
+
deprecated?: boolean;
|
400
|
+
allowEmptyValue?: boolean;
|
401
|
+
style?: "simple";
|
402
|
+
explode?: boolean;
|
403
|
+
allowReserved?: boolean;
|
404
|
+
schema: Schema | Reference;
|
405
|
+
example?: any;
|
406
|
+
}
|
407
|
+
/**
|
408
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
409
|
+
* via the `definition` "ParameterWithSchemaWithExampleInCookie".
|
410
|
+
*/
|
411
|
+
interface ParameterWithSchemaWithExampleInCookie {
|
412
|
+
name: string;
|
413
|
+
in: "cookie";
|
414
|
+
description?: string;
|
415
|
+
required?: boolean;
|
416
|
+
deprecated?: boolean;
|
417
|
+
allowEmptyValue?: boolean;
|
418
|
+
style?: "form";
|
419
|
+
explode?: boolean;
|
420
|
+
allowReserved?: boolean;
|
421
|
+
schema: Schema | Reference;
|
422
|
+
example?: any;
|
423
|
+
}
|
424
|
+
/**
|
425
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
426
|
+
* via the `definition` "ParameterWithSchemaWithExamplesInPath".
|
427
|
+
*/
|
428
|
+
interface ParameterWithSchemaWithExamplesInPath {
|
429
|
+
name: string;
|
430
|
+
in: "path";
|
431
|
+
description?: string;
|
432
|
+
required: true;
|
433
|
+
deprecated?: boolean;
|
434
|
+
allowEmptyValue?: boolean;
|
435
|
+
style?: "matrix" | "label" | "simple";
|
436
|
+
explode?: boolean;
|
437
|
+
allowReserved?: boolean;
|
438
|
+
schema: Schema | Reference;
|
439
|
+
examples: {
|
440
|
+
[k: string]: Example | Reference;
|
441
|
+
};
|
442
|
+
}
|
443
|
+
/**
|
444
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
445
|
+
* via the `definition` "Example".
|
446
|
+
*/
|
447
|
+
interface Example {
|
448
|
+
summary?: string;
|
449
|
+
description?: string;
|
450
|
+
value?: any;
|
451
|
+
externalValue?: string;
|
452
|
+
}
|
453
|
+
/**
|
454
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
455
|
+
* via the `definition` "ParameterWithSchemaWithExamplesInQuery".
|
456
|
+
*/
|
457
|
+
interface ParameterWithSchemaWithExamplesInQuery {
|
458
|
+
name: string;
|
459
|
+
in: "query";
|
460
|
+
description?: string;
|
461
|
+
required?: boolean;
|
462
|
+
deprecated?: boolean;
|
463
|
+
allowEmptyValue?: boolean;
|
464
|
+
style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";
|
465
|
+
explode?: boolean;
|
466
|
+
allowReserved?: boolean;
|
467
|
+
schema: Schema | Reference;
|
468
|
+
examples: {
|
469
|
+
[k: string]: Example | Reference;
|
470
|
+
};
|
471
|
+
"x-showInExample"?: boolean;
|
472
|
+
}
|
473
|
+
/**
|
474
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
475
|
+
* via the `definition` "ParameterWithSchemaWithExamplesInHeader".
|
476
|
+
*/
|
477
|
+
interface ParameterWithSchemaWithExamplesInHeader {
|
478
|
+
name: string;
|
479
|
+
in: "header";
|
480
|
+
description?: string;
|
481
|
+
required?: boolean;
|
482
|
+
deprecated?: boolean;
|
483
|
+
allowEmptyValue?: boolean;
|
484
|
+
style?: "simple";
|
485
|
+
explode?: boolean;
|
486
|
+
allowReserved?: boolean;
|
487
|
+
schema: Schema | Reference;
|
488
|
+
examples: {
|
489
|
+
[k: string]: Example | Reference;
|
490
|
+
};
|
491
|
+
}
|
492
|
+
/**
|
493
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
494
|
+
* via the `definition` "ParameterWithSchemaWithExamplesInCookie".
|
495
|
+
*/
|
496
|
+
interface ParameterWithSchemaWithExamplesInCookie {
|
497
|
+
name: string;
|
498
|
+
in: "cookie";
|
499
|
+
description?: string;
|
500
|
+
required?: boolean;
|
501
|
+
deprecated?: boolean;
|
502
|
+
allowEmptyValue?: boolean;
|
503
|
+
style?: "form";
|
504
|
+
explode?: boolean;
|
505
|
+
allowReserved?: boolean;
|
506
|
+
schema: Schema | Reference;
|
507
|
+
examples: {
|
508
|
+
[k: string]: Example | Reference;
|
509
|
+
};
|
510
|
+
}
|
511
|
+
/**
|
512
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
513
|
+
* via the `definition` "ParameterWithContentInPath".
|
514
|
+
*/
|
515
|
+
interface ParameterWithContentInPath {
|
516
|
+
name: string;
|
517
|
+
in: "path";
|
518
|
+
description?: string;
|
519
|
+
required?: true;
|
520
|
+
deprecated?: boolean;
|
521
|
+
allowEmptyValue?: boolean;
|
522
|
+
content: {
|
523
|
+
[k: string]: MediaType;
|
524
|
+
};
|
525
|
+
}
|
526
|
+
/**
|
527
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
528
|
+
* via the `definition` "MediaTypeWithExample".
|
529
|
+
*/
|
530
|
+
interface MediaTypeWithExample {
|
531
|
+
schema?: Schema | Reference;
|
532
|
+
example?: any;
|
533
|
+
encoding?: {
|
534
|
+
[k: string]: Encoding;
|
535
|
+
};
|
536
|
+
}
|
537
|
+
/**
|
538
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
539
|
+
* via the `definition` "Encoding".
|
540
|
+
*/
|
541
|
+
interface Encoding {
|
542
|
+
contentType?: string;
|
543
|
+
headers?: {
|
544
|
+
[k: string]: Header;
|
545
|
+
};
|
546
|
+
style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";
|
547
|
+
explode?: boolean;
|
548
|
+
allowReserved?: boolean;
|
549
|
+
}
|
550
|
+
/**
|
551
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
552
|
+
* via the `definition` "HeaderWithSchemaWithExample".
|
553
|
+
*/
|
554
|
+
interface HeaderWithSchemaWithExample {
|
555
|
+
description?: string;
|
556
|
+
required?: boolean;
|
557
|
+
deprecated?: boolean;
|
558
|
+
allowEmptyValue?: boolean;
|
559
|
+
style?: "simple";
|
560
|
+
explode?: boolean;
|
561
|
+
allowReserved?: boolean;
|
562
|
+
schema: Schema | Reference;
|
563
|
+
example?: any;
|
564
|
+
}
|
565
|
+
/**
|
566
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
567
|
+
* via the `definition` "HeaderWithSchemaWithExamples".
|
568
|
+
*/
|
569
|
+
interface HeaderWithSchemaWithExamples {
|
570
|
+
description?: string;
|
571
|
+
required?: boolean;
|
572
|
+
deprecated?: boolean;
|
573
|
+
allowEmptyValue?: boolean;
|
574
|
+
style?: "simple";
|
575
|
+
explode?: boolean;
|
576
|
+
allowReserved?: boolean;
|
577
|
+
schema: Schema | Reference;
|
578
|
+
examples: {
|
579
|
+
[k: string]: Example | Reference;
|
580
|
+
};
|
581
|
+
}
|
582
|
+
/**
|
583
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
584
|
+
* via the `definition` "HeaderWithContent".
|
585
|
+
*/
|
586
|
+
interface HeaderWithContent {
|
587
|
+
description?: string;
|
588
|
+
required?: boolean;
|
589
|
+
deprecated?: boolean;
|
590
|
+
allowEmptyValue?: boolean;
|
591
|
+
content: {
|
592
|
+
[k: string]: MediaType;
|
593
|
+
};
|
594
|
+
}
|
595
|
+
/**
|
596
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
597
|
+
* via the `definition` "MediaTypeWithExamples".
|
598
|
+
*/
|
599
|
+
interface MediaTypeWithExamples {
|
600
|
+
schema?: Schema | Reference;
|
601
|
+
examples: {
|
602
|
+
[k: string]: Example | Reference;
|
603
|
+
};
|
604
|
+
encoding?: {
|
605
|
+
[k: string]: Encoding;
|
606
|
+
};
|
607
|
+
}
|
608
|
+
/**
|
609
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
610
|
+
* via the `definition` "ParameterWithContentNotInPath".
|
611
|
+
*/
|
612
|
+
interface ParameterWithContentNotInPath {
|
613
|
+
name: string;
|
614
|
+
in: "query" | "header" | "cookie";
|
615
|
+
description?: string;
|
616
|
+
required?: boolean;
|
617
|
+
deprecated?: boolean;
|
618
|
+
allowEmptyValue?: boolean;
|
619
|
+
content: {
|
620
|
+
[k: string]: MediaType;
|
621
|
+
};
|
622
|
+
"x-showInExample"?: boolean;
|
623
|
+
}
|
624
|
+
/**
|
625
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
626
|
+
* via the `definition` "RequestBody".
|
627
|
+
*/
|
628
|
+
interface RequestBody {
|
629
|
+
description?: string;
|
630
|
+
content: {
|
631
|
+
[k: string]: MediaType;
|
632
|
+
};
|
633
|
+
required?: boolean;
|
634
|
+
}
|
635
|
+
/**
|
636
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
637
|
+
* via the `definition` "Responses".
|
638
|
+
*/
|
639
|
+
interface Responses {
|
640
|
+
[type: string]: Response | Reference;
|
641
|
+
}
|
642
|
+
/**
|
643
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
644
|
+
* via the `definition` "Response".
|
645
|
+
*/
|
646
|
+
interface Response {
|
647
|
+
description: string;
|
648
|
+
headers?: {
|
649
|
+
[k: string]: Header | Reference;
|
650
|
+
};
|
651
|
+
content?: {
|
652
|
+
[k: string]: MediaType;
|
653
|
+
};
|
654
|
+
links?: {
|
655
|
+
[k: string]: Link | Reference;
|
656
|
+
};
|
657
|
+
}
|
658
|
+
/**
|
659
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
660
|
+
* via the `definition` "LinkWithOperationRef".
|
661
|
+
*/
|
662
|
+
interface LinkWithOperationRef {
|
663
|
+
operationRef?: string;
|
664
|
+
parameters?: {
|
665
|
+
[k: string]: any;
|
666
|
+
};
|
667
|
+
requestBody?: any;
|
668
|
+
description?: string;
|
669
|
+
server?: Server;
|
670
|
+
}
|
671
|
+
/**
|
672
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
673
|
+
* via the `definition` "LinkWithOperationId".
|
674
|
+
*/
|
675
|
+
interface LinkWithOperationId {
|
676
|
+
operationId?: string;
|
677
|
+
parameters?: {
|
678
|
+
[k: string]: any;
|
679
|
+
};
|
680
|
+
requestBody?: any;
|
681
|
+
description?: string;
|
682
|
+
server?: Server;
|
683
|
+
}
|
684
|
+
/**
|
685
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
686
|
+
* via the `definition` "Callback".
|
687
|
+
*/
|
688
|
+
interface Callback {
|
689
|
+
[k: string]: PathItem;
|
690
|
+
}
|
691
|
+
/**
|
692
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
693
|
+
* via the `definition` "Components".
|
694
|
+
*/
|
695
|
+
interface Components {
|
696
|
+
schemas?: {
|
697
|
+
[k: string]: Schema | Reference;
|
698
|
+
};
|
699
|
+
responses?: {
|
700
|
+
[k: string]: Response | Reference;
|
701
|
+
};
|
702
|
+
parameters?: {
|
703
|
+
[k: string]: Parameter | Reference;
|
704
|
+
};
|
705
|
+
examples?: {
|
706
|
+
[k: string]: Example | Reference;
|
707
|
+
};
|
708
|
+
requestBodies?: {
|
709
|
+
[k: string]: RequestBody | Reference;
|
710
|
+
};
|
711
|
+
headers?: {
|
712
|
+
[k: string]: Header | Reference;
|
713
|
+
};
|
714
|
+
securitySchemes?: {
|
715
|
+
[k: string]: SecurityScheme | Reference;
|
716
|
+
};
|
717
|
+
links?: {
|
718
|
+
[k: string]: Link | Reference;
|
719
|
+
};
|
720
|
+
callbacks?: {
|
721
|
+
[k: string]: Callback | Reference;
|
722
|
+
};
|
723
|
+
}
|
724
|
+
/**
|
725
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
726
|
+
* via the `definition` "APIKeySecurityScheme".
|
727
|
+
*/
|
728
|
+
interface ApiKeySecurityScheme {
|
729
|
+
type: "apiKey";
|
730
|
+
name: string;
|
731
|
+
in: "header" | "query" | "cookie";
|
732
|
+
description?: string;
|
733
|
+
"x-bearer-type"?: XBearerType;
|
734
|
+
}
|
735
|
+
/**
|
736
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
737
|
+
* via the `definition` "NonBearerHTTPSecurityScheme".
|
738
|
+
*/
|
739
|
+
interface NonBearerHttpSecurityScheme {
|
740
|
+
scheme: string;
|
741
|
+
description?: string;
|
742
|
+
type: "http";
|
743
|
+
}
|
744
|
+
/**
|
745
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
746
|
+
* via the `definition` "BearerHTTPSecurityScheme".
|
747
|
+
*/
|
748
|
+
interface BearerHttpSecurityScheme {
|
749
|
+
scheme: "bearer";
|
750
|
+
bearerFormat?: string;
|
751
|
+
type: "http";
|
752
|
+
description?: string;
|
753
|
+
"x-bearer-type"?: XBearerType;
|
754
|
+
}
|
755
|
+
type XBearerType = XBearerTypeAsap | XBearerTypeSLAUTH;
|
756
|
+
interface XBearerTypeAsap {
|
757
|
+
type: "asap";
|
758
|
+
}
|
759
|
+
interface XBearerTypeSLAUTH {
|
760
|
+
type: "slauth";
|
761
|
+
audience: string;
|
762
|
+
defaultSlauthEnvironment?: string;
|
763
|
+
}
|
764
|
+
/**
|
765
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
766
|
+
* via the `definition` "OAuth2SecurityScheme".
|
767
|
+
*/
|
768
|
+
interface OAuth2SecurityScheme {
|
769
|
+
type: "oauth2";
|
770
|
+
flows: OAuthFlows;
|
771
|
+
description?: string;
|
772
|
+
}
|
773
|
+
/**
|
774
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
775
|
+
* via the `definition` "OAuthFlows".
|
776
|
+
*/
|
777
|
+
interface OAuthFlows {
|
778
|
+
implicit?: ImplicitOAuthFlow;
|
779
|
+
password?: PasswordOAuthFlow;
|
780
|
+
clientCredentials?: ClientCredentialsFlow;
|
781
|
+
authorizationCode?: AuthorizationCodeOAuthFlow;
|
782
|
+
}
|
783
|
+
/**
|
784
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
785
|
+
* via the `definition` "ImplicitOAuthFlow".
|
786
|
+
*/
|
787
|
+
interface ImplicitOAuthFlow {
|
788
|
+
authorizationUrl: string;
|
789
|
+
refreshUrl?: string;
|
790
|
+
scopes: {
|
791
|
+
[k: string]: string;
|
792
|
+
};
|
793
|
+
}
|
794
|
+
/**
|
795
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
796
|
+
* via the `definition` "PasswordOAuthFlow".
|
797
|
+
*/
|
798
|
+
interface PasswordOAuthFlow {
|
799
|
+
tokenUrl: string;
|
800
|
+
refreshUrl?: string;
|
801
|
+
scopes?: {
|
802
|
+
[k: string]: string;
|
803
|
+
};
|
804
|
+
}
|
805
|
+
/**
|
806
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
807
|
+
* via the `definition` "ClientCredentialsFlow".
|
808
|
+
*/
|
809
|
+
interface ClientCredentialsFlow {
|
810
|
+
tokenUrl: string;
|
811
|
+
refreshUrl?: string;
|
812
|
+
scopes?: {
|
813
|
+
[k: string]: string;
|
814
|
+
};
|
815
|
+
}
|
816
|
+
/**
|
817
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
818
|
+
* via the `definition` "AuthorizationCodeOAuthFlow".
|
819
|
+
*/
|
820
|
+
interface AuthorizationCodeOAuthFlow {
|
821
|
+
authorizationUrl: string;
|
822
|
+
tokenUrl: string;
|
823
|
+
refreshUrl?: string;
|
824
|
+
scopes?: {
|
825
|
+
[k: string]: string;
|
826
|
+
};
|
827
|
+
}
|
828
|
+
/**
|
829
|
+
* This interface was referenced by `SwaggerV3`'s JSON-Schema
|
830
|
+
* via the `definition` "OpenIdConnectSecurityScheme".
|
831
|
+
*/
|
832
|
+
interface OpenIdConnectSecurityScheme {
|
833
|
+
type: "openIdConnect";
|
834
|
+
openIdConnectUrl: string;
|
835
|
+
description?: string;
|
836
|
+
}
|
837
|
+
}
|