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

feat(openapi-parser): expose more types under the OpenAPI namespace #162

Merged
merged 3 commits into from
Jul 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/twenty-bears-applaud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@scalar/openapi-parser': patch
---

feat: expose more types under the OpenAPI namespace
29 changes: 23 additions & 6 deletions packages/openapi-parser/src/types/openapi-types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,24 +24,41 @@ export namespace OpenAPI {
| OpenAPIV2.OperationObject<T>
| OpenAPIV3.OperationObject<T>
| OpenAPIV3_1.OperationObject<T>

export interface Request {
body?: any
headers?: object
params?: object
query?: object
}

export type ResponseObject =
| OpenAPIV2.ResponseObject
| OpenAPIV3.ResponseObject
| OpenAPIV3_1.ResponseObject

export type Parameter =
| OpenAPIV3_1.ReferenceObject
| OpenAPIV3_1.ParameterObject
| OpenAPIV3.ReferenceObject
| OpenAPIV3.ParameterObject
| OpenAPIV2.ReferenceObject
| OpenAPIV2.Parameter

export type Parameters =
| (OpenAPIV3_1.ReferenceObject | OpenAPIV3_1.ParameterObject)[]
| (OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject)[]
| (OpenAPIV2.ReferenceObject | OpenAPIV2.Parameter)[]

export interface Request {
body?: any
headers?: object
params?: object
query?: object
}
export type ExampleObject =
| OpenAPIV2.ExampleObject
| OpenAPIV3.ExampleObject
| OpenAPIV3_1.ExampleObject

export type SchemaObject =
| OpenAPIV2.SchemaObject
| OpenAPIV3.SchemaObject
| OpenAPIV3_1.SchemaObject
}

export namespace OpenAPIV3_1 {
Expand Down