This repository was archived by the owner on Mar 20, 2026. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 12
Expand file tree
/
Copy pathOpenApiV3.ts
More file actions
256 lines (251 loc) · 6.94 KB
/
OpenApiV3.ts
File metadata and controls
256 lines (251 loc) · 6.94 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
export namespace OpenApiV3 {
export interface IDocument {
openapi: `3.0.${number}`;
servers?: IDocument.IServer[];
info: IDocument.IInfo;
components?: IComponents;
paths: Record<string, Record<string, IRoute>>;
security?: Record<string, string[]>[];
tags?: IDocument.ITag[];
}
export namespace IDocument {
export interface IServer {
/** @format uri */ url: string;
description?: string;
variables?: Record<string, IServer.IVariable>;
}
export namespace IServer {
export interface IVariable {
default: string;
enum?: string[];
description?: string;
}
}
export interface IInfo {
title: string;
description?: string;
termsOfService?: string;
contact?: IContact;
license?: ILicense;
version: string;
}
export interface ITag {
name: string;
description?: string;
}
export interface IContact {
name?: string;
/** @format uri */ url?: string;
/** @format email */ email?: string;
}
export interface ILicense {
name: string;
/** @format email */ url?: string;
}
}
export interface IRoute {
parameters?: Array<
| IRoute.IParameter
| IJsonSchema.IReference<`#/components/headers/${string}`>
| IJsonSchema.IReference<`#/components/parameters/${string}`>
>;
requestBody?:
| IRoute.IRequestBody
| IJsonSchema.IReference<`#/components/requestBodies/${string}`>;
responses?: Record<
string,
| IRoute.IResponse
| IJsonSchema.IReference<`#/components/responses/${string}`>
>;
summary?: string;
description?: string;
security?: Record<string, string[]>;
tags?: string[];
}
export namespace IRoute {
export interface IParameter {
name?: string;
in: "path" | "query" | "header" | "cookie";
schema: IJsonSchema;
required?: boolean;
description?: string;
}
export interface IRequestBody {
description?: string;
required?: boolean;
content?: Record<string, IMediaType>;
}
export interface IResponse {
content?: Record<string, IMediaType>;
description?: string;
}
export interface IMediaType {
schema: IJsonSchema;
}
}
export interface IComponents {
schemas?: Record<string, IJsonSchema>;
responses?: Record<string, IRoute.IResponse>;
parameters?: Record<string, IRoute.IParameter>;
requestBodies?: Record<string, IRoute.IRequestBody>;
securitySchemes?: Record<string, ISecurityScheme>;
headers?: Record<string, IRoute.IParameter>;
}
export type IJsonSchema =
| IJsonSchema.IBoolean
| IJsonSchema.IInteger
| IJsonSchema.INumber
| IJsonSchema.IString
| IJsonSchema.IArray
| IJsonSchema.IObject
| IJsonSchema.IReference
| IJsonSchema.IUnknown
| IJsonSchema.INullOnly
| IJsonSchema.IAllOf
| IJsonSchema.IAnyOf
| IJsonSchema.IOneOf;
export namespace IJsonSchema {
export interface IBoolean extends __ISignificant<"boolean"> {
default?: boolean;
enum?: boolean[];
}
export interface IInteger extends __ISignificant<"integer"> {
/** @type int */ default?: number;
/** @type int */ enum?: number[];
/** @type int */ minimum?: number;
/** @type int */ maximum?: number;
/** @type int */ exclusiveMinimum?: boolean;
/** @type int */ exclusiveMaximum?: boolean;
/** @type uint */ multipleOf?: number;
}
export interface INumber extends __ISignificant<"number"> {
default?: number;
enum?: number[];
minimum?: number;
maximum?: number;
exclusiveMinimum?: boolean;
exclusiveMaximum?: boolean;
multipleOf?: number;
}
export interface IString extends __ISignificant<"string"> {
contentMediaType?: string;
default?: string;
enum?: string[];
format?:
| "binary"
| "byte"
| "password"
| "regex"
| "uuid"
| "email"
| "hostname"
| "idn-email"
| "idn-hostname"
| "iri"
| "iri-reference"
| "ipv4"
| "ipv6"
| "uri"
| "uri-reference"
| "uri-template"
| "url"
| "date-time"
| "date"
| "time"
| "duration"
| "json-pointer"
| "relative-json-pointer"
| (string & {});
pattern?: string;
/** @type uint */ minLength?: number;
/** @type uint */ maxLength?: number;
}
export interface IArray extends __ISignificant<"array"> {
item: IJsonSchema;
uniqueItems?: boolean;
/** @type uint */ minItems?: number;
/** @type uint */ maxItems?: number;
}
export interface IObject extends __ISignificant<"object"> {
properties: Record<string, IJsonSchema>;
required?: string[];
additionalProperties?: boolean | IJsonSchema;
}
export interface IReference<Key = string> extends __IAttribute {
$ref: Key;
}
export interface IUnknown extends __IAttribute {
type?: undefined;
}
export interface INullOnly extends __IAttribute {
type: "null";
}
export interface IAllOf extends __IAttribute {
allOf: IJsonSchema[];
}
export interface IAnyOf extends __IAttribute {
anyOf: IJsonSchema[];
}
export interface IOneOf extends __IAttribute {
oneOf: IJsonSchema[];
}
export interface __ISignificant<Type extends string> extends __IAttribute {
type: Type;
nullable?: boolean;
}
export interface __IAttribute {
title?: string;
description?: string;
deprecated?: boolean;
}
}
export type ISecurityScheme =
| ISecurityScheme.IApiKey
| ISecurityScheme.IHttpBasic
| ISecurityScheme.IHttpBearer
| ISecurityScheme.IOAuth2
| ISecurityScheme.IOpenId;
export namespace ISecurityScheme {
export interface IApiKey {
type: "apiKey";
in?: "header" | "query" | "cookie";
name?: string;
description?: string;
}
export interface IHttpBasic {
type: "http";
schema: "basic";
description?: string;
}
export interface IHttpBearer {
type: "http";
schema: "bearer";
bearerFormat?: string;
description?: string;
}
export interface IOAuth2 {
type: "oauth2";
flows: IOAuth2.IFlowSet;
description?: string;
}
export interface IOpenId {
type: "openIdConnect";
/** @format uri */ openIdConnectUrl: string;
description?: string;
}
export namespace IOAuth2 {
export interface IFlowSet {
authorizationCode?: IFlow;
implicit?: Omit<IFlow, "tokenUrl">;
password?: Omit<IFlow, "authorizationUrl">;
clientCredentials?: Omit<IFlow, "authorizationUrl">;
}
export interface IFlow {
authorizationUrl: string;
/** @format uri */ tokenUrl?: string;
/** @format uri */ refreshUrl?: string;
scopes?: Record<string, string>;
}
}
}
}