fork of hey-api/openapi-ts because I need some additional things
Merge pull request #2086 from hey-api/fix/parser-input-filters-parameters-responses
fix(parser): extend input filters to handle reusable parameters and responses
+887
-62
+5
.changeset/real-fireants-drop.md
+5
.changeset/real-fireants-drop.md
+5
.changeset/two-files-call.md
+5
.changeset/two-files-call.md
+85
-9
docs/openapi-ts/configuration.md
+85
-9
docs/openapi-ts/configuration.md
···
197
197
198
198
### Operations
199
199
200
-
Set `include` to match operations to be included or `exclude` to match operations to be excluded. When both rules match the same operation, `exclude` takes precedence over `include`.
200
+
Set `include` to match operations to be included or `exclude` to match operations to be excluded. Both exact keys and regular expressions are supported. When both rules match the same operation, `exclude` takes precedence over `include`.
201
201
202
202
::: code-group
203
203
···
206
206
input: {
207
207
filters: {
208
208
operations: {
209
-
include: ['GET /api/v1/foo'], // [!code ++]
209
+
include: ['GET /api/v1/foo', '/^[A-Z]+ /api/v1//'], // [!code ++]
210
210
},
211
211
},
212
212
path: 'https://get.heyapi.dev/hey-api/backend',
···
221
221
input: {
222
222
filters: {
223
223
operations: {
224
-
exclude: ['GET /api/v1/foo'], // [!code ++]
224
+
exclude: ['GET /api/v1/foo', '/^[A-Z]+ /api/v1//'], // [!code ++]
225
225
},
226
226
},
227
227
path: 'https://get.heyapi.dev/hey-api/backend',
···
290
290
291
291
### Schemas
292
292
293
-
Set `include` to match schemas to be included or `exclude` to match schemas to be excluded. When both rules match the same schema, `exclude` takes precedence over `include`.
293
+
Set `include` to match schemas to be included or `exclude` to match schemas to be excluded. Both exact keys and regular expressions are supported. When both rules match the same schema, `exclude` takes precedence over `include`.
294
294
295
295
::: code-group
296
296
···
299
299
input: {
300
300
filters: {
301
301
schemas: {
302
-
include: ['Foo'], // [!code ++]
302
+
include: ['Foo', '/^Bar/'], // [!code ++]
303
303
},
304
304
},
305
305
path: 'https://get.heyapi.dev/hey-api/backend',
···
314
314
input: {
315
315
filters: {
316
316
schemas: {
317
-
exclude: ['Foo'], // [!code ++]
317
+
exclude: ['Foo', '/^Bar/'], // [!code ++]
318
+
},
319
+
},
320
+
path: 'https://get.heyapi.dev/hey-api/backend',
321
+
},
322
+
output: 'src/client',
323
+
plugins: ['@hey-api/client-fetch'],
324
+
};
325
+
```
326
+
327
+
:::
328
+
329
+
### Parameters
330
+
331
+
Set `include` to match parameters to be included or `exclude` to match parameters to be excluded. Both exact keys and regular expressions are supported. When both rules match the same parameter, `exclude` takes precedence over `include`.
332
+
333
+
::: code-group
334
+
335
+
```js [include]
336
+
export default {
337
+
input: {
338
+
filters: {
339
+
parameters: {
340
+
include: ['QueryParameter', '/^MyQueryParameter/'], // [!code ++]
341
+
},
342
+
},
343
+
path: 'https://get.heyapi.dev/hey-api/backend',
344
+
},
345
+
output: 'src/client',
346
+
plugins: ['@hey-api/client-fetch'],
347
+
};
348
+
```
349
+
350
+
```js [exclude]
351
+
export default {
352
+
input: {
353
+
filters: {
354
+
parameters: {
355
+
exclude: ['QueryParameter', '/^MyQueryParameter/'], // [!code ++]
318
356
},
319
357
},
320
358
path: 'https://get.heyapi.dev/hey-api/backend',
···
328
366
329
367
### Request Bodies
330
368
331
-
Set `include` to match request bodies to be included or `exclude` to match request bodies to be excluded. When both rules match the same request body, `exclude` takes precedence over `include`.
369
+
Set `include` to match request bodies to be included or `exclude` to match request bodies to be excluded. Both exact keys and regular expressions are supported. When both rules match the same request body, `exclude` takes precedence over `include`.
332
370
333
371
::: code-group
334
372
···
337
375
input: {
338
376
filters: {
339
377
requestBodies: {
340
-
include: ['Payload'], // [!code ++]
378
+
include: ['Payload', '/^SpecialPayload/'], // [!code ++]
341
379
},
342
380
},
343
381
path: 'https://get.heyapi.dev/hey-api/backend',
···
352
390
input: {
353
391
filters: {
354
392
requestBodies: {
355
-
exclude: ['Payload'], // [!code ++]
393
+
exclude: ['Payload', '/^SpecialPayload/'], // [!code ++]
394
+
},
395
+
},
396
+
path: 'https://get.heyapi.dev/hey-api/backend',
397
+
},
398
+
output: 'src/client',
399
+
plugins: ['@hey-api/client-fetch'],
400
+
};
401
+
```
402
+
403
+
:::
404
+
405
+
### Responses
406
+
407
+
Set `include` to match responses to be included or `exclude` to match responses to be excluded. Both exact keys and regular expressions are supported. When both rules match the same response, `exclude` takes precedence over `include`.
408
+
409
+
::: code-group
410
+
411
+
```js [include]
412
+
export default {
413
+
input: {
414
+
filters: {
415
+
responses: {
416
+
include: ['Foo', '/^Bar/'], // [!code ++]
417
+
},
418
+
},
419
+
path: 'https://get.heyapi.dev/hey-api/backend',
420
+
},
421
+
output: 'src/client',
422
+
plugins: ['@hey-api/client-fetch'],
423
+
};
424
+
```
425
+
426
+
```js [exclude]
427
+
export default {
428
+
input: {
429
+
filters: {
430
+
responses: {
431
+
exclude: ['Foo', '/^Bar/'], // [!code ++]
356
432
},
357
433
},
358
434
path: 'https://get.heyapi.dev/hey-api/backend',
+10
-7
packages/openapi-ts-tests/test/openapi-ts.config.ts
+10
-7
packages/openapi-ts-tests/test/openapi-ts.config.ts
···
23
23
// },
24
24
filters: {
25
25
// deprecated: false,
26
-
// operations: {
27
-
// include: ['POST /foo'],
28
-
// },
26
+
operations: {
27
+
include: [
28
+
// 'PUT /foo',
29
+
'/^[A-Z]+ /v1//',
30
+
],
31
+
},
29
32
// orphans: false,
30
33
// preserveOrder: true,
31
34
// tags: {
···
41
44
// openapi: '3.1.0',
42
45
// paths: {},
43
46
// },
44
-
path: path.resolve(__dirname, 'spec', '3.1.x', 'validators.json'),
47
+
path: path.resolve(__dirname, 'spec', '3.1.x', 'parser-filters.yaml'),
45
48
// path: 'http://localhost:4000/',
46
49
// path: 'https://get.heyapi.dev/',
47
50
// path: 'https://get.heyapi.dev/hey-api/backend?branch=main&version=1.0.0',
···
85
88
// type: 'json',
86
89
},
87
90
{
88
-
asClass: true,
91
+
// asClass: true,
89
92
// auth: false,
90
93
client: false,
91
94
// include...
···
125
128
{
126
129
// comments: false,
127
130
// exportFromIndex: true,
128
-
name: 'valibot',
131
+
// name: 'valibot',
129
132
},
130
133
{
131
134
// comments: false,
132
135
// exportFromIndex: true,
133
-
name: 'zod',
136
+
// name: 'zod',
134
137
},
135
138
],
136
139
// useOptions: false,
+12
-2
packages/openapi-ts-tests/test/spec/3.1.x/parser-filters.yaml
+12
-2
packages/openapi-ts-tests/test/spec/3.1.x/parser-filters.yaml
···
3
3
title: OpenAPI 3.1.1 parser filters example
4
4
version: 1
5
5
paths:
6
-
/foo:
6
+
/v1/foo:
7
7
post:
8
8
deprecated: true
9
9
tags:
10
10
- foo
11
11
- bar
12
+
parameters:
13
+
- $ref: '#/components/parameters/Foo'
12
14
requestBody:
13
15
$ref: '#/components/requestBodies/Foo'
14
16
responses:
···
30
32
schema:
31
33
$ref: '#/components/schemas/Baz'
32
34
description: OK
33
-
/bar:
35
+
/v2/bar:
34
36
post:
35
37
requestBody:
36
38
content:
···
46
48
$ref: '#/components/schemas/Bar'
47
49
description: OK
48
50
components:
51
+
parameters:
52
+
Foo:
53
+
name: foo
54
+
in: query
55
+
description: Query parameter
56
+
required: false
57
+
schema:
58
+
type: string
49
59
requestBodies:
50
60
Foo:
51
61
required: true
+2
packages/openapi-ts/src/openApi/2.0.x/parser/filter.ts
+2
packages/openapi-ts/src/openApi/2.0.x/parser/filter.ts
+1
-1
packages/openapi-ts/src/openApi/2.0.x/parser/index.ts
+1
-1
packages/openapi-ts/src/openApi/2.0.x/parser/index.ts
···
26
26
export const parseV2_0_X = (context: IR.Context<OpenApiV2_0_X>) => {
27
27
if (hasFilters(context.config.input.filters)) {
28
28
const graph = createGraph(context.spec);
29
-
const filters = createFilters(context.config.input.filters);
29
+
const filters = createFilters(context.config.input.filters, context.spec);
30
30
const sets = createFilteredDependencies({ filters, graph });
31
31
filterSpec({
32
32
...sets,
+52
packages/openapi-ts/src/openApi/3.0.x/parser/filter.ts
+52
packages/openapi-ts/src/openApi/3.0.x/parser/filter.ts
···
7
7
*/
8
8
export const filterSpec = ({
9
9
operations,
10
+
parameters,
10
11
preserveOrder,
11
12
requestBodies,
13
+
responses,
12
14
schemas,
13
15
spec,
14
16
}: {
15
17
operations: Set<string>;
18
+
parameters: Set<string>;
16
19
preserveOrder: boolean;
17
20
requestBodies: Set<string>;
21
+
responses: Set<string>;
18
22
schemas: Set<string>;
19
23
spec: OpenApiV3_0_X;
20
24
}) => {
21
25
if (spec.components) {
26
+
if (spec.components.parameters) {
27
+
const filtered: typeof spec.components.parameters = {};
28
+
29
+
if (preserveOrder) {
30
+
for (const [name, source] of Object.entries(
31
+
spec.components.parameters,
32
+
)) {
33
+
if (parameters.has(addNamespace('parameter', name))) {
34
+
filtered[name] = source;
35
+
}
36
+
}
37
+
} else {
38
+
for (const key of parameters) {
39
+
const { name } = removeNamespace(key);
40
+
const source = spec.components.parameters[name];
41
+
if (source) {
42
+
filtered[name] = source;
43
+
}
44
+
}
45
+
}
46
+
47
+
spec.components.parameters = filtered;
48
+
}
49
+
22
50
if (spec.components.requestBodies) {
23
51
const filtered: typeof spec.components.requestBodies = {};
24
52
···
41
69
}
42
70
43
71
spec.components.requestBodies = filtered;
72
+
}
73
+
74
+
if (spec.components.responses) {
75
+
const filtered: typeof spec.components.responses = {};
76
+
77
+
if (preserveOrder) {
78
+
for (const [name, source] of Object.entries(
79
+
spec.components.responses,
80
+
)) {
81
+
if (responses.has(addNamespace('response', name))) {
82
+
filtered[name] = source;
83
+
}
84
+
}
85
+
} else {
86
+
for (const key of responses) {
87
+
const { name } = removeNamespace(key);
88
+
const source = spec.components.responses[name];
89
+
if (source) {
90
+
filtered[name] = source;
91
+
}
92
+
}
93
+
}
94
+
95
+
spec.components.responses = filtered;
44
96
}
45
97
46
98
if (spec.components.schemas) {
+1
-1
packages/openapi-ts/src/openApi/3.0.x/parser/index.ts
+1
-1
packages/openapi-ts/src/openApi/3.0.x/parser/index.ts
···
25
25
export const parseV3_0_X = (context: IR.Context<OpenApiV3_0_X>) => {
26
26
if (hasFilters(context.config.input.filters)) {
27
27
const graph = createGraph(context.spec);
28
-
const filters = createFilters(context.config.input.filters);
28
+
const filters = createFilters(context.config.input.filters, context.spec);
29
29
const sets = createFilteredDependencies({ filters, graph });
30
30
filterSpec({
31
31
...sets,
+52
packages/openapi-ts/src/openApi/3.1.x/parser/filter.ts
+52
packages/openapi-ts/src/openApi/3.1.x/parser/filter.ts
···
7
7
*/
8
8
export const filterSpec = ({
9
9
operations,
10
+
parameters,
10
11
preserveOrder,
11
12
requestBodies,
13
+
responses,
12
14
schemas,
13
15
spec,
14
16
}: {
15
17
operations: Set<string>;
18
+
parameters: Set<string>;
16
19
preserveOrder: boolean;
17
20
requestBodies: Set<string>;
21
+
responses: Set<string>;
18
22
schemas: Set<string>;
19
23
spec: OpenApiV3_1_X;
20
24
}) => {
21
25
if (spec.components) {
26
+
if (spec.components.parameters) {
27
+
const filtered: typeof spec.components.parameters = {};
28
+
29
+
if (preserveOrder) {
30
+
for (const [name, source] of Object.entries(
31
+
spec.components.parameters,
32
+
)) {
33
+
if (parameters.has(addNamespace('parameter', name))) {
34
+
filtered[name] = source;
35
+
}
36
+
}
37
+
} else {
38
+
for (const key of parameters) {
39
+
const { name } = removeNamespace(key);
40
+
const source = spec.components.parameters[name];
41
+
if (source) {
42
+
filtered[name] = source;
43
+
}
44
+
}
45
+
}
46
+
47
+
spec.components.parameters = filtered;
48
+
}
49
+
22
50
if (spec.components.requestBodies) {
23
51
const filtered: typeof spec.components.requestBodies = {};
24
52
···
41
69
}
42
70
43
71
spec.components.requestBodies = filtered;
72
+
}
73
+
74
+
if (spec.components.responses) {
75
+
const filtered: typeof spec.components.responses = {};
76
+
77
+
if (preserveOrder) {
78
+
for (const [name, source] of Object.entries(
79
+
spec.components.responses,
80
+
)) {
81
+
if (responses.has(addNamespace('response', name))) {
82
+
filtered[name] = source;
83
+
}
84
+
}
85
+
} else {
86
+
for (const key of responses) {
87
+
const { name } = removeNamespace(key);
88
+
const source = spec.components.responses[name];
89
+
if (source) {
90
+
filtered[name] = source;
91
+
}
92
+
}
93
+
}
94
+
95
+
spec.components.responses = filtered;
44
96
}
45
97
46
98
if (spec.components.schemas) {
+1
-1
packages/openapi-ts/src/openApi/3.1.x/parser/index.ts
+1
-1
packages/openapi-ts/src/openApi/3.1.x/parser/index.ts
···
25
25
export const parseV3_1_X = (context: IR.Context<OpenApiV3_1_X>) => {
26
26
if (hasFilters(context.config.input.filters)) {
27
27
const graph = createGraph(context.spec);
28
-
const filters = createFilters(context.config.input.filters);
28
+
const filters = createFilters(context.config.input.filters, context.spec);
29
29
const sets = createFilteredDependencies({ filters, graph });
30
30
filterSpec({
31
31
...sets,
+36
packages/openapi-ts/src/types/config.d.ts
+36
packages/openapi-ts/src/types/config.d.ts
···
79
79
* @default false
80
80
*/
81
81
orphans?: boolean;
82
+
parameters?: {
83
+
/**
84
+
* Prevent parameters matching the `exclude` filters from being processed.
85
+
*
86
+
* In case of conflicts, `exclude` takes precedence over `include`.
87
+
*
88
+
* @example ['QueryParam']
89
+
*/
90
+
exclude?: ReadonlyArray<string>;
91
+
/**
92
+
* Process only parameters matching the `include` filters.
93
+
*
94
+
* In case of conflicts, `exclude` takes precedence over `include`.
95
+
*
96
+
* @example ['QueryParam']
97
+
*/
98
+
include?: ReadonlyArray<string>;
99
+
};
82
100
/**
83
101
* Should we preserve the key order when overwriting your input? This
84
102
* option is disabled by default to improve performance.
···
97
115
exclude?: ReadonlyArray<string>;
98
116
/**
99
117
* Process only request bodies matching the `include` filters.
118
+
*
119
+
* In case of conflicts, `exclude` takes precedence over `include`.
120
+
*
121
+
* @example ['Foo']
122
+
*/
123
+
include?: ReadonlyArray<string>;
124
+
};
125
+
responses?: {
126
+
/**
127
+
* Prevent responses matching the `exclude` filters from being processed.
128
+
*
129
+
* In case of conflicts, `exclude` takes precedence over `include`.
130
+
*
131
+
* @example ['Foo']
132
+
*/
133
+
exclude?: ReadonlyArray<string>;
134
+
/**
135
+
* Process only responses matching the `include` filters.
100
136
*
101
137
* In case of conflicts, `exclude` takes precedence over `include`.
102
138
*