Skip to content

Commit a115a96

Browse files
committed
docs: update export models / services docs
1 parent 6832872 commit a115a96

File tree

2 files changed

+21
-5
lines changed

2 files changed

+21
-5
lines changed

docs/interfaces/index.CommonOpenApiClientGeneratorConfigPostprocess.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,5 @@ Configuration for postprocessing the generated files.
1818

1919
`Optional` **eslint**: `boolean`
2020

21-
If true, runs ESLint on the generated files.
21+
If true, runs ESLint on the generated files. ESlint should be installed in the project and the configuration
22+
should be present. This postprocess step can take a long time for large schemas.

docs/interfaces/openapi_client.OpenApiClientGeneratorConfigClient.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Configuration for generating the client.
1212

1313
- [baseUrl](openapi_client.OpenApiClientGeneratorConfigClient.md#baseurl)
1414
- [errorClassName](openapi_client.OpenApiClientGeneratorConfigClient.md#errorclassname)
15+
- [exportErrorClass](openapi_client.OpenApiClientGeneratorConfigClient.md#exporterrorclass)
1516
- [exportModels](openapi_client.OpenApiClientGeneratorConfigClient.md#exportmodels)
1617
- [exportServices](openapi_client.OpenApiClientGeneratorConfigClient.md#exportservices)
1718
- [filename](openapi_client.OpenApiClientGeneratorConfigClient.md#filename)
@@ -40,30 +41,44 @@ Name of the class for http and other errors. Example: `MyApiClientError`.
4041

4142
___
4243

44+
### exportErrorClass
45+
46+
`Optional` **exportErrorClass**: `boolean`
47+
48+
Whether to export the error class from the client file.
49+
50+
**`Default`**
51+
52+
```ts
53+
true
54+
```
55+
56+
___
57+
4358
### exportModels
4459

45-
`Optional` **exportModels**: `boolean`
60+
`Optional` **exportModels**: ``"all"`` \| ``"none"`` \| \{ `models`: `string`[] }
4661

4762
Whether to export models from the client file.
4863

4964
**`Default`**
5065

5166
```ts
52-
false
67+
'none'
5368
```
5469

5570
___
5671

5772
### exportServices
5873

59-
`Optional` **exportServices**: `boolean`
74+
`Optional` **exportServices**: ``"all"`` \| ``"none"`` \| \{ `services`: `string`[] }
6075

6176
Whether to export services from the client file.
6277

6378
**`Default`**
6479

6580
```ts
66-
false
81+
'none'
6782
```
6883

6984
___

0 commit comments

Comments
 (0)