fork of hey-api/openapi-ts because I need some additional things
Merge pull request #3307 from hey-api/docs/config-links
docs: fix config links
+30
-24
+6
.vscode/settings.json
+6
.vscode/settings.json
···
16
16
"**/*.map": true,
17
17
"**/*.mjs": true,
18
18
"**/*.mts": true,
19
+
"**/.vitepress/dist": true,
20
+
"**/.mypy_cache": true,
21
+
"**/__snapshots__": true,
22
+
"**/coverage": true,
23
+
"**/openapi-ts-tests/**/generated": true,
24
+
"**/openapi-ts-tests/**/.gen": true,
19
25
"**/*.tsbuildinfo": true
20
26
},
21
27
"typescript.preferences.autoImportFileExcludePatterns": ["dist/**"],
+1
-1
docs/openapi-ts/clients/angular.md
+1
-1
docs/openapi-ts/clients/angular.md
···
251
251
252
252
## API
253
253
254
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-angular/types.d.ts) interface.
254
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-angular/types.ts) interface.
255
255
256
256
<!--@include: ../../partials/examples.md-->
257
257
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/clients/angular/v19.md
+1
-1
docs/openapi-ts/clients/angular/v19.md
···
251
251
252
252
## API
253
253
254
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-angular/types.d.ts) interface.
254
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-angular/types.ts) interface.
255
255
256
256
<!--@include: ../../../partials/examples.md-->
257
257
<!--@include: ../../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/clients/axios.md
+1
-1
docs/openapi-ts/clients/axios.md
···
246
246
247
247
## API
248
248
249
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-axios/types.d.ts) interface.
249
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-axios/types.ts) interface.
250
250
251
251
<!--@include: ../../partials/examples.md-->
252
252
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/clients/fetch.md
+1
-1
docs/openapi-ts/clients/fetch.md
···
307
307
308
308
## API
309
309
310
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-fetch/types.d.ts) interface.
310
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-fetch/types.ts) interface.
311
311
312
312
<!--@include: ../../partials/examples.md-->
313
313
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/clients/ky.md
+1
-1
docs/openapi-ts/clients/ky.md
···
305
305
306
306
## API
307
307
308
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-ky/types.d.ts) interface.
308
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-ky/types.ts) interface.
309
309
310
310
<!--@include: ../../partials/examples.md-->
311
311
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/clients/next-js.md
+1
-1
docs/openapi-ts/clients/next-js.md
···
290
290
291
291
## API
292
292
293
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-next/types.d.ts) interface.
293
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-next/types.ts) interface.
294
294
295
295
<!--@include: ../../partials/examples.md-->
296
296
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/clients/nuxt.md
+1
-1
docs/openapi-ts/clients/nuxt.md
···
261
261
262
262
## API
263
263
264
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-nuxt/types.d.ts) interface.
264
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-nuxt/types.ts) interface.
265
265
266
266
<!--@include: ../../partials/examples.md-->
267
267
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/clients/ofetch.md
+1
-1
docs/openapi-ts/clients/ofetch.md
···
344
344
345
345
## API
346
346
347
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-ofetch/types.d.ts) interface.
347
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/client-ofetch/types.ts) interface.
348
348
349
349
<!--@include: ../../partials/examples.md-->
350
350
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/configuration.md
+1
-1
docs/openapi-ts/configuration.md
···
242
242
243
243
## API
244
244
245
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/config/types.d.ts) interface.
245
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/config/types.ts) interface.
246
246
247
247
<!--@include: ../partials/examples.md-->
248
248
<!--@include: ../partials/sponsors.md-->
+1
-1
docs/openapi-ts/plugins/angular.md
+1
-1
docs/openapi-ts/plugins/angular.md
···
116
116
117
117
## API
118
118
119
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@angular/common/types.d.ts) interface.
119
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@angular/common/types.ts) interface.
120
120
121
121
<!--@include: ../../partials/examples.md-->
122
122
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/plugins/angular/v19.md
+1
-1
docs/openapi-ts/plugins/angular/v19.md
···
116
116
117
117
## API
118
118
119
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@angular/common/types.d.ts) interface.
119
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@angular/common/types.ts) interface.
120
120
121
121
<!--@include: ../../partials/examples.md-->
122
122
<!--@include: ../../partials/sponsors.md-->
+2
-2
docs/openapi-ts/plugins/custom.md
+2
-2
docs/openapi-ts/plugins/custom.md
···
30
30
31
31
## TypeScript
32
32
33
-
`index.ts` references two files, so we need to create them. `types.d.ts` contains the TypeScript interface for your plugin options. It must have the reserved `name` and `output` fields, everything else will become user-configurable options.
33
+
`index.ts` references two files, so we need to create them. `types.ts` contains the TypeScript interface for your plugin options. It must have the reserved `name` and `output` fields, everything else will become user-configurable options.
34
34
35
35
::: code-group
36
36
37
-
```ts [types.d.ts]
37
+
```ts [types.ts]
38
38
import type { DefinePlugin } from '@hey-api/openapi-ts';
39
39
40
40
export type UserConfig = {
+1
-1
docs/openapi-ts/plugins/fastify.md
+1
-1
docs/openapi-ts/plugins/fastify.md
···
97
97
98
98
## API
99
99
100
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/fastify/types.d.ts) interface.
100
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/fastify/types.ts) interface.
101
101
102
102
<!--@include: ../../partials/examples.md-->
103
103
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/plugins/pinia-colada.md
+1
-1
docs/openapi-ts/plugins/pinia-colada.md
···
262
262
263
263
## API
264
264
265
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@pinia/colada/types.d.ts) interface.
265
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@pinia/colada/types.ts) interface.
266
266
267
267
<!--@include: ../../partials/examples.md-->
268
268
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/plugins/schemas.md
+1
-1
docs/openapi-ts/plugins/schemas.md
···
92
92
93
93
## API
94
94
95
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/schemas/types.d.ts) interface.
95
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/schemas/types.ts) interface.
96
96
97
97
<!--@include: ../../partials/examples.md-->
98
98
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/plugins/sdk.md
+1
-1
docs/openapi-ts/plugins/sdk.md
···
544
544
545
545
## API
546
546
547
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/sdk/types.d.ts) interface.
547
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/sdk/types.ts) interface.
548
548
549
549
<!--@include: ../../partials/examples.md-->
550
550
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/plugins/tanstack-query.md
+1
-1
docs/openapi-ts/plugins/tanstack-query.md
···
608
608
609
609
## API
610
610
611
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@tanstack/react-query/types.d.ts) interface.
611
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@tanstack/react-query/types.ts) interface.
612
612
613
613
<!--@include: ../../partials/examples.md-->
614
614
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/plugins/transformers.md
+1
-1
docs/openapi-ts/plugins/transformers.md
···
151
151
152
152
## API
153
153
154
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/transformers/types.d.ts) interface.
154
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/transformers/types.ts) interface.
155
155
156
156
<!--@include: ../partials/sponsors.md-->
+1
-1
docs/openapi-ts/plugins/typescript.md
+1
-1
docs/openapi-ts/plugins/typescript.md
···
132
132
133
133
## API
134
134
135
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/typescript/types.d.ts) interface.
135
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/@hey-api/typescript/types.ts) interface.
136
136
137
137
<!--@include: ../../partials/examples.md-->
138
138
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/plugins/valibot.md
+1
-1
docs/openapi-ts/plugins/valibot.md
···
213
213
214
214
## API
215
215
216
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/valibot/types.d.ts) interface.
216
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/valibot/types.ts) interface.
217
217
218
218
<!--@include: ../../partials/examples.md-->
219
219
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/plugins/zod.md
+1
-1
docs/openapi-ts/plugins/zod.md
···
305
305
306
306
## API
307
307
308
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/zod/types.d.ts) interface.
308
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/zod/types.ts) interface.
309
309
310
310
<!--@include: ../../partials/examples.md-->
311
311
<!--@include: ../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/plugins/zod/mini.md
+1
-1
docs/openapi-ts/plugins/zod/mini.md
···
318
318
319
319
## API
320
320
321
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/zod/types.d.ts) interface.
321
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/zod/types.ts) interface.
322
322
323
323
<!--@include: ../../../partials/examples.md-->
324
324
<!--@include: ../../../partials/sponsors.md-->
+1
-1
docs/openapi-ts/plugins/zod/v3.md
+1
-1
docs/openapi-ts/plugins/zod/v3.md
···
316
316
317
317
## API
318
318
319
-
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/zod/types.d.ts) interface.
319
+
You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/zod/types.ts) interface.
320
320
321
321
<!--@include: ../../../partials/examples.md-->
322
322
<!--@include: ../../../partials/sponsors.md-->