Skip to content
This repository was archived by the owner on Aug 28, 2024. It is now read-only.

Commit d2493fe

Browse files
authored
feat(openapi-parser): expose more types under the OpenAPI namespace (#162)
* feat: expose more types under the OpenAPI namespace * docs(changeset): feat: expose more types under the OpenAPI namespace * chore: code style
1 parent b78d593 commit d2493fe

File tree

2 files changed

+28
-6
lines changed

2 files changed

+28
-6
lines changed

.changeset/twenty-bears-applaud.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@scalar/openapi-parser': patch
3+
---
4+
5+
feat: expose more types under the OpenAPI namespace

packages/openapi-parser/src/types/openapi-types.ts

+23-6
Original file line numberDiff line numberDiff line change
@@ -24,24 +24,41 @@ export namespace OpenAPI {
2424
| OpenAPIV2.OperationObject<T>
2525
| OpenAPIV3.OperationObject<T>
2626
| OpenAPIV3_1.OperationObject<T>
27+
28+
export interface Request {
29+
body?: any
30+
headers?: object
31+
params?: object
32+
query?: object
33+
}
34+
35+
export type ResponseObject =
36+
| OpenAPIV2.ResponseObject
37+
| OpenAPIV3.ResponseObject
38+
| OpenAPIV3_1.ResponseObject
39+
2740
export type Parameter =
2841
| OpenAPIV3_1.ReferenceObject
2942
| OpenAPIV3_1.ParameterObject
3043
| OpenAPIV3.ReferenceObject
3144
| OpenAPIV3.ParameterObject
3245
| OpenAPIV2.ReferenceObject
3346
| OpenAPIV2.Parameter
47+
3448
export type Parameters =
3549
| (OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.ParameterObject)[]
3650
| (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[]
3751
| (OpenAPIV2.ReferenceObject | OpenAPIV2.Parameter)[]
3852

39-
export interface Request {
40-
body?: any
41-
headers?: object
42-
params?: object
43-
query?: object
44-
}
53+
export type ExampleObject =
54+
| OpenAPIV2.ExampleObject
55+
| OpenAPIV3.ExampleObject
56+
| OpenAPIV3_1.ExampleObject
57+
58+
export type SchemaObject =
59+
| OpenAPIV2.SchemaObject
60+
| OpenAPIV3.SchemaObject
61+
| OpenAPIV3_1.SchemaObject
4562
}
4663

4764
export namespace OpenAPIV3_1 {

0 commit comments

Comments
 (0)