Skip to content

Commit f16877d

Browse files
committed
Add OpenAPI TypeScript definitions
1 parent 1a14c7a commit f16877d

28 files changed

+243
-37
lines changed

src/callback.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import { PathItem } from './pathItem';
2+
import { Reference } from './reference';
3+
4+
export interface Callback {
5+
[expression: string]: PathItem | Reference;
6+
}

src/components.ts

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
import { Callback } from './callback';
2+
import { Example } from './example';
3+
import { Header } from './header';
4+
import { Link } from './link';
5+
import { Parameter } from './parameter';
6+
import { PathItem } from './pathItem';
7+
import { Reference } from './reference';
8+
import { RequestBody } from './requestBody';
9+
import { Response } from './response';
10+
import { Schema } from './schema';
11+
import { SecurityScheme } from './securityScheme';
12+
13+
export interface Components {
14+
callbacks?: { [key: string]: Callback | Reference },
15+
examples?: { [key: string]: Example | Reference },
16+
headers?: { [key: string]: Header | Reference },
17+
links?: { [key: string]: Link | Reference },
18+
parameters?: { [key: string]: Parameter | Reference },
19+
pathItems?: { [key: string]: PathItem | Reference },
20+
requestBodies?: { [key: string]: RequestBody | Reference },
21+
responses?: { [key: string]: Response | Reference },
22+
schemas?: { [key: string]: Schema },
23+
securitySchemes?: { [key: string]: SecurityScheme | Reference }
24+
}

src/contact.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
export interface Contact {
2-
name?: string,
32
email?: string,
3+
name?: string,
44
url?: string,
55
}

src/discriminator.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
export interface Discriminator {
2+
mapping?: { [discriminatorValue: string]: string },
3+
propertyName: string
4+
}

src/encoding.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import { Header } from './header';
2+
import { Reference } from './reference';
3+
4+
export interface Encoding {
5+
allowReserved?: boolean,
6+
contentType?: string,
7+
explode?: boolean,
8+
headers?: { [headerName: string]: Header | Reference },
9+
style?: string
10+
}

src/example.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
interface CommonExample {
2-
summary?: string,
32
description?: string,
3+
summary?: string
44
}
55

66
export interface ExampleWithValue extends CommonExample {

src/header.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import { HeaderParameter } from './parameter';
2+
3+
export type Header = Omit<HeaderParameter, 'in' | 'name'>;

src/info.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import { Contact } from './contact';
2+
import { License } from './license';
3+
4+
export interface Info {
5+
contact?: Contact,
6+
description?: string,
7+
license?: License,
8+
summary?: string,
9+
termsOfService?: string,
10+
title: string,
11+
version: string,
12+
}

src/license.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
export interface License {
2-
name: string,
32
identifier?: string,
3+
name: string,
44
url?: string,
55
}

src/link.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import {Server} from "./server";
1+
import { Server } from './server';
22

33
interface CommonLink {
4+
description?: string,
45
parameters?: { [name: string]: string | any; };
56
requestBody?: string | any,
6-
description?: string,
77
server?: Server
88
}
99

0 commit comments

Comments
 (0)