30
30
31
31
### CommonApiToTypescriptGeneratorSource
32
32
33
- Ƭ ** CommonApiToTypescriptGeneratorSource** : \{ ` path ` : ` string ` ; ` type ` : `` "file" `` } \| \{ ` type ` : `` "url" `` ; ` url ` : ` string ` }
33
+ Ƭ ** CommonApiToTypescriptGeneratorSource** : \{ ` path ` : ` string ` ; ` type ` : `` "file" `` } \| \{ ` type ` : `` "url" `` ; ` url ` : ` string ` } \| \{ ` object ` : ` unknown ` ; ` type ` : `` "object" `` } \| \{ ` data ` : ` string ` ; ` type ` : `` "string" `` }
34
34
35
35
Source of the API to generate TypeScript types from. Can be a file or a URL. Supports both YAML and JSON.
36
36
44
44
45
45
### OpenApiDocumentPatchAllSchemas
46
46
47
- Ƭ ** OpenApiDocumentPatchAllSchemas** : (` schemas ` : \{ ` [schemaName: string] ` : [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) ; }) => \{ ` [schemaName: string] ` : [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) ; }
47
+ Ƭ ** OpenApiDocumentPatchAllSchemas** : (` schemas ` : \{ ` [schemaName: string] ` : [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) ; }) => \{ ` [schemaName: string] ` : [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) ; } \| ` Promise ` \<\{ ` [schemaName: string] ` : [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) ; } \>
48
48
49
49
#### Type declaration
50
50
51
- ▸ (` schemas ` ): ` Object `
51
+ ▸ (` schemas ` ): \{ ` [schemaName: string] ` : [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) ; } \| ` Promise ` \<\{ ` [schemaName: string] ` : [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) ; } \>
52
52
53
53
Callback to patch all schemas.
54
54
@@ -60,17 +60,17 @@ Callback to patch all schemas.
60
60
61
61
##### Returns
62
62
63
- ` Object `
63
+ \{ ` [schemaName: string] ` : [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) ; } \| ` Promise ` \<\{ ` [schemaName: string] ` : [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) ; } \>
64
64
65
65
___
66
66
67
67
### OpenApiDocumentPatchDocument
68
68
69
- Ƭ ** OpenApiDocumentPatchDocument** : (` document ` : [ ` OpenApiDocument ` ] ( ../interfaces/openapi.OpenApiDocument.md ) ) => [ ` OpenApiDocument ` ] ( ../interfaces/openapi.OpenApiDocument.md )
69
+ Ƭ ** OpenApiDocumentPatchDocument** : (` document ` : [ ` OpenApiDocument ` ] ( ../interfaces/openapi.OpenApiDocument.md ) ) => [ ` OpenApiDocument ` ] ( ../interfaces/openapi.OpenApiDocument.md ) \| ` Promise ` \< [ ` OpenApiDocument ` ] ( ../interfaces/openapi.OpenApiDocument.md ) \>
70
70
71
71
#### Type declaration
72
72
73
- ▸ (` document ` ): [ ` OpenApiDocument ` ] ( ../interfaces/openapi.OpenApiDocument.md )
73
+ ▸ (` document ` ): [ ` OpenApiDocument ` ] ( ../interfaces/openapi.OpenApiDocument.md ) \| ` Promise ` \< [ ` OpenApiDocument ` ] ( ../interfaces/openapi.OpenApiDocument.md ) \>
74
74
75
75
Callback to patch the whole OpenAPI document. Applies after all other patches.
76
76
@@ -82,17 +82,17 @@ Callback to patch the whole OpenAPI document. Applies after all other patches.
82
82
83
83
##### Returns
84
84
85
- [ ` OpenApiDocument ` ] ( ../interfaces/openapi.OpenApiDocument.md )
85
+ [ ` OpenApiDocument ` ] ( ../interfaces/openapi.OpenApiDocument.md ) \| ` Promise ` \< [ ` OpenApiDocument ` ] ( ../interfaces/openapi.OpenApiDocument.md ) \>
86
86
87
87
___
88
88
89
89
### OpenApiDocumentPatchOperation
90
90
91
- Ƭ ** OpenApiDocumentPatchOperation** : (` operation ` : [ ` OpenApiOperation ` ] ( ../interfaces/openapi.OpenApiOperation.md ) , ` path ` : ` string ` , ` httpMethod ` : [ ` OpenApiHttpMethod ` ] ( openapi.md#openapihttpmethod ) ) => [ ` OpenApiOperation ` ] ( ../interfaces/openapi.OpenApiOperation.md )
91
+ Ƭ ** OpenApiDocumentPatchOperation** : (` operation ` : [ ` OpenApiOperation ` ] ( ../interfaces/openapi.OpenApiOperation.md ) , ` path ` : ` string ` , ` httpMethod ` : [ ` OpenApiHttpMethod ` ] ( openapi.md#openapihttpmethod ) ) => [ ` OpenApiOperation ` ] ( ../interfaces/openapi.OpenApiOperation.md ) \| ` Promise ` \< [ ` OpenApiOperation ` ] ( ../interfaces/openapi.OpenApiOperation.md ) \>
92
92
93
93
#### Type declaration
94
94
95
- ▸ (` operation ` , ` path ` , ` httpMethod ` ): [ ` OpenApiOperation ` ] ( ../interfaces/openapi.OpenApiOperation.md )
95
+ ▸ (` operation ` , ` path ` , ` httpMethod ` ): [ ` OpenApiOperation ` ] ( ../interfaces/openapi.OpenApiOperation.md ) \| ` Promise ` \< [ ` OpenApiOperation ` ] ( ../interfaces/openapi.OpenApiOperation.md ) \>
96
96
97
97
Callback to patch an operation.
98
98
@@ -106,17 +106,17 @@ Callback to patch an operation.
106
106
107
107
##### Returns
108
108
109
- [ ` OpenApiOperation ` ] ( ../interfaces/openapi.OpenApiOperation.md )
109
+ [ ` OpenApiOperation ` ] ( ../interfaces/openapi.OpenApiOperation.md ) \| ` Promise ` \< [ ` OpenApiOperation ` ] ( ../interfaces/openapi.OpenApiOperation.md ) \>
110
110
111
111
___
112
112
113
113
### OpenApiDocumentPatchPathItem
114
114
115
- Ƭ ** OpenApiDocumentPatchPathItem** : (` pathItem ` : [ ` OpenApiPathItem ` ] ( openapi.md#openapipathitem ) , ` path ` : ` string ` ) => [ ` OpenApiPathItem ` ] ( openapi.md#openapipathitem )
115
+ Ƭ ** OpenApiDocumentPatchPathItem** : (` pathItem ` : [ ` OpenApiPathItem ` ] ( openapi.md#openapipathitem ) , ` path ` : ` string ` ) => [ ` OpenApiPathItem ` ] ( openapi.md#openapipathitem ) \| ` Promise ` \< [ ` OpenApiPathItem ` ] ( openapi.md#openapipathitem ) \>
116
116
117
117
#### Type declaration
118
118
119
- ▸ (` pathItem ` , ` path ` ): [ ` OpenApiPathItem ` ] ( openapi.md#openapipathitem )
119
+ ▸ (` pathItem ` , ` path ` ): [ ` OpenApiPathItem ` ] ( openapi.md#openapipathitem ) \| ` Promise ` \< [ ` OpenApiPathItem ` ] ( openapi.md#openapipathitem ) \>
120
120
121
121
Callback to patch a path item.
122
122
@@ -129,17 +129,17 @@ Callback to patch a path item.
129
129
130
130
##### Returns
131
131
132
- [ ` OpenApiPathItem ` ] ( openapi.md#openapipathitem )
132
+ [ ` OpenApiPathItem ` ] ( openapi.md#openapipathitem ) \| ` Promise ` \< [ ` OpenApiPathItem ` ] ( openapi.md#openapipathitem ) \>
133
133
134
134
___
135
135
136
136
### OpenApiDocumentPatchSchema
137
137
138
- Ƭ ** OpenApiDocumentPatchSchema** : (` schema ` : [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) , ` schemaName ` : ` string ` ) => [ ` OpenApiSchema ` ] ( openapi.md#openapischema )
138
+ Ƭ ** OpenApiDocumentPatchSchema** : (` schema ` : [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) , ` schemaName ` : ` string ` ) => [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) \| ` Promise ` \< [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) \>
139
139
140
140
#### Type declaration
141
141
142
- ▸ (` schema ` , ` schemaName ` ): [ ` OpenApiSchema ` ] ( openapi.md#openapischema )
142
+ ▸ (` schema ` , ` schemaName ` ): [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) \| ` Promise ` \< [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) \>
143
143
144
144
Callback to patch a schema.
145
145
@@ -152,17 +152,17 @@ Callback to patch a schema.
152
152
153
153
##### Returns
154
154
155
- [ ` OpenApiSchema ` ] ( openapi.md#openapischema )
155
+ [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) \| ` Promise ` \< [ ` OpenApiSchema ` ] ( openapi.md#openapischema ) \>
156
156
157
157
___
158
158
159
159
### OpenApiDocumentPatchTags
160
160
161
- Ƭ ** OpenApiDocumentPatchTags** : (` tags ` : [ ` OpenApiTag ` ] ( ../interfaces/openapi.OpenApiTag.md ) [ ] ) => [ ` OpenApiTag ` ] ( ../interfaces/openapi.OpenApiTag.md ) [ ]
161
+ Ƭ ** OpenApiDocumentPatchTags** : (` tags ` : [ ` OpenApiTag ` ] ( ../interfaces/openapi.OpenApiTag.md ) [ ] ) => [ ` OpenApiTag ` ] ( ../interfaces/openapi.OpenApiTag.md ) [ ] \| ` Promise ` \< [ ` OpenApiTag ` ] ( ../interfaces/openapi.OpenApiTag.md ) [ ] \>
162
162
163
163
#### Type declaration
164
164
165
- ▸ (` tags ` ): [ ` OpenApiTag ` ] ( ../interfaces/openapi.OpenApiTag.md ) [ ]
165
+ ▸ (` tags ` ): [ ` OpenApiTag ` ] ( ../interfaces/openapi.OpenApiTag.md ) [ ] \| ` Promise ` \< [ ` OpenApiTag ` ] ( ../interfaces/openapi.OpenApiTag.md ) [ ] \>
166
166
167
167
Callback to patch tags.
168
168
@@ -174,4 +174,4 @@ Callback to patch tags.
174
174
175
175
##### Returns
176
176
177
- [ ` OpenApiTag ` ] ( ../interfaces/openapi.OpenApiTag.md ) [ ]
177
+ [ ` OpenApiTag ` ] ( ../interfaces/openapi.OpenApiTag.md ) [ ] \| ` Promise ` \< [ ` OpenApiTag ` ] ( ../interfaces/openapi.OpenApiTag.md ) [ ] \>
0 commit comments