Skip to content

Commit e5c876c

Browse files
committed
docs: add patch async functions docs
1 parent 048470a commit e5c876c

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/modules/index.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030

3131
### CommonApiToTypescriptGeneratorSource
3232

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"`` }
3434

3535
Source of the API to generate TypeScript types from. Can be a file or a URL. Supports both YAML and JSON.
3636

@@ -44,11 +44,11 @@ ___
4444

4545
### OpenApiDocumentPatchAllSchemas
4646

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); }\>
4848

4949
#### Type declaration
5050

51-
▸ (`schemas`): `Object`
51+
▸ (`schemas`): \{ `[schemaName: string]`: [`OpenApiSchema`](openapi.md#openapischema); } \| `Promise`\<\{ `[schemaName: string]`: [`OpenApiSchema`](openapi.md#openapischema); }\>
5252

5353
Callback to patch all schemas.
5454

@@ -60,17 +60,17 @@ Callback to patch all schemas.
6060

6161
##### Returns
6262

63-
`Object`
63+
\{ `[schemaName: string]`: [`OpenApiSchema`](openapi.md#openapischema); } \| `Promise`\<\{ `[schemaName: string]`: [`OpenApiSchema`](openapi.md#openapischema); }\>
6464

6565
___
6666

6767
### OpenApiDocumentPatchDocument
6868

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)\>
7070

7171
#### Type declaration
7272

73-
▸ (`document`): [`OpenApiDocument`](../interfaces/openapi.OpenApiDocument.md)
73+
▸ (`document`): [`OpenApiDocument`](../interfaces/openapi.OpenApiDocument.md) \| `Promise`\<[`OpenApiDocument`](../interfaces/openapi.OpenApiDocument.md)\>
7474

7575
Callback to patch the whole OpenAPI document. Applies after all other patches.
7676

@@ -82,17 +82,17 @@ Callback to patch the whole OpenAPI document. Applies after all other patches.
8282

8383
##### Returns
8484

85-
[`OpenApiDocument`](../interfaces/openapi.OpenApiDocument.md)
85+
[`OpenApiDocument`](../interfaces/openapi.OpenApiDocument.md) \| `Promise`\<[`OpenApiDocument`](../interfaces/openapi.OpenApiDocument.md)\>
8686

8787
___
8888

8989
### OpenApiDocumentPatchOperation
9090

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)\>
9292

9393
#### Type declaration
9494

95-
▸ (`operation`, `path`, `httpMethod`): [`OpenApiOperation`](../interfaces/openapi.OpenApiOperation.md)
95+
▸ (`operation`, `path`, `httpMethod`): [`OpenApiOperation`](../interfaces/openapi.OpenApiOperation.md) \| `Promise`\<[`OpenApiOperation`](../interfaces/openapi.OpenApiOperation.md)\>
9696

9797
Callback to patch an operation.
9898

@@ -106,17 +106,17 @@ Callback to patch an operation.
106106

107107
##### Returns
108108

109-
[`OpenApiOperation`](../interfaces/openapi.OpenApiOperation.md)
109+
[`OpenApiOperation`](../interfaces/openapi.OpenApiOperation.md) \| `Promise`\<[`OpenApiOperation`](../interfaces/openapi.OpenApiOperation.md)\>
110110

111111
___
112112

113113
### OpenApiDocumentPatchPathItem
114114

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)\>
116116

117117
#### Type declaration
118118

119-
▸ (`pathItem`, `path`): [`OpenApiPathItem`](openapi.md#openapipathitem)
119+
▸ (`pathItem`, `path`): [`OpenApiPathItem`](openapi.md#openapipathitem) \| `Promise`\<[`OpenApiPathItem`](openapi.md#openapipathitem)\>
120120

121121
Callback to patch a path item.
122122

@@ -129,17 +129,17 @@ Callback to patch a path item.
129129

130130
##### Returns
131131

132-
[`OpenApiPathItem`](openapi.md#openapipathitem)
132+
[`OpenApiPathItem`](openapi.md#openapipathitem) \| `Promise`\<[`OpenApiPathItem`](openapi.md#openapipathitem)\>
133133

134134
___
135135

136136
### OpenApiDocumentPatchSchema
137137

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)\>
139139

140140
#### Type declaration
141141

142-
▸ (`schema`, `schemaName`): [`OpenApiSchema`](openapi.md#openapischema)
142+
▸ (`schema`, `schemaName`): [`OpenApiSchema`](openapi.md#openapischema) \| `Promise`\<[`OpenApiSchema`](openapi.md#openapischema)\>
143143

144144
Callback to patch a schema.
145145

@@ -152,17 +152,17 @@ Callback to patch a schema.
152152

153153
##### Returns
154154

155-
[`OpenApiSchema`](openapi.md#openapischema)
155+
[`OpenApiSchema`](openapi.md#openapischema) \| `Promise`\<[`OpenApiSchema`](openapi.md#openapischema)\>
156156

157157
___
158158

159159
### OpenApiDocumentPatchTags
160160

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)[]\>
162162

163163
#### Type declaration
164164

165-
▸ (`tags`): [`OpenApiTag`](../interfaces/openapi.OpenApiTag.md)[]
165+
▸ (`tags`): [`OpenApiTag`](../interfaces/openapi.OpenApiTag.md)[] \| `Promise`\<[`OpenApiTag`](../interfaces/openapi.OpenApiTag.md)[]\>
166166

167167
Callback to patch tags.
168168

@@ -174,4 +174,4 @@ Callback to patch tags.
174174

175175
##### Returns
176176

177-
[`OpenApiTag`](../interfaces/openapi.OpenApiTag.md)[]
177+
[`OpenApiTag`](../interfaces/openapi.OpenApiTag.md)[] \| `Promise`\<[`OpenApiTag`](../interfaces/openapi.OpenApiTag.md)[]\>

0 commit comments

Comments
 (0)