fork of hey-api/openapi-ts because I need some additional things
Merge pull request #3385 from SipanP/fix/discriminator-non-string-type-support
fix(shared): support non-string discriminator property types
+792
-26
+5
.changeset/wicked-rings-march.md
+5
.changeset/wicked-rings-march.md
+7
packages/openapi-ts-tests/main/test/3.0.x.test.ts
+7
packages/openapi-ts-tests/main/test/3.0.x.test.ts
···
219
219
},
220
220
{
221
221
config: createConfig({
222
+
input: 'discriminator-non-string.yaml',
223
+
output: 'discriminator-non-string',
224
+
}),
225
+
description: 'handles non-string discriminator property types',
226
+
},
227
+
{
228
+
config: createConfig({
222
229
input: 'enum-escape.json',
223
230
output: 'enum-escape',
224
231
}),
+7
packages/openapi-ts-tests/main/test/3.1.x.test.ts
+7
packages/openapi-ts-tests/main/test/3.1.x.test.ts
···
238
238
},
239
239
{
240
240
config: createConfig({
241
+
input: 'discriminator-non-string.yaml',
242
+
output: 'discriminator-non-string',
243
+
}),
244
+
description: 'handles non-string discriminator property types',
245
+
},
246
+
{
247
+
config: createConfig({
241
248
input: 'discriminator-one-of-read-write.yaml',
242
249
output: 'discriminator-one-of-read-write',
243
250
}),
+3
packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/discriminator-non-string/index.ts
+3
packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/discriminator-non-string/index.ts
···
1
+
// This file is auto-generated by @hey-api/openapi-ts
2
+
3
+
export type { AutoConfig, BooleanAnyOf, BooleanOneOf, ClientOptions, CustomConfig, IntegerAllOfBase, IntegerAllOfChildA, IntegerAllOfChildB, IntegerOneOf, NumberOneOf, TypeOne, TypeTwo, VersionAlpha, VersionBeta } from './types.gen';
+73
packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/discriminator-non-string/types.gen.ts
+73
packages/openapi-ts-tests/main/test/__snapshots__/3.0.x/discriminator-non-string/types.gen.ts
···
1
+
// This file is auto-generated by @hey-api/openapi-ts
2
+
3
+
export type ClientOptions = {
4
+
baseUrl: `${string}://${string}` | (string & {});
5
+
};
6
+
7
+
export type BooleanOneOf = ({
8
+
use_custom: false;
9
+
} & AutoConfig) | ({
10
+
use_custom: true;
11
+
} & CustomConfig);
12
+
13
+
export type AutoConfig = {
14
+
use_custom: boolean;
15
+
auto_setting: string;
16
+
};
17
+
18
+
export type CustomConfig = {
19
+
use_custom: boolean;
20
+
custom_value: number;
21
+
};
22
+
23
+
export type BooleanAnyOf = ({
24
+
use_custom?: false;
25
+
} & AutoConfig) | ({
26
+
use_custom?: true;
27
+
} & CustomConfig);
28
+
29
+
export type IntegerOneOf = ({
30
+
type_id: 1;
31
+
} & TypeOne) | ({
32
+
type_id: 2;
33
+
} & TypeTwo);
34
+
35
+
export type TypeOne = {
36
+
type_id: number;
37
+
one_data: string;
38
+
};
39
+
40
+
export type TypeTwo = {
41
+
type_id: number;
42
+
two_data: string;
43
+
};
44
+
45
+
export type NumberOneOf = ({
46
+
version: 1;
47
+
} & VersionAlpha) | ({
48
+
version: 2.5;
49
+
} & VersionBeta);
50
+
51
+
export type VersionAlpha = {
52
+
version: number;
53
+
alpha_field: string;
54
+
};
55
+
56
+
export type VersionBeta = {
57
+
version: number;
58
+
beta_field: string;
59
+
};
60
+
61
+
export type IntegerAllOfBase = {
62
+
kind: number;
63
+
};
64
+
65
+
export type IntegerAllOfChildA = Omit<IntegerAllOfBase, 'kind'> & {
66
+
child_a_field: string;
67
+
kind: 1;
68
+
};
69
+
70
+
export type IntegerAllOfChildB = Omit<IntegerAllOfBase, 'kind'> & {
71
+
child_b_field: string;
72
+
kind: 2;
73
+
};
+3
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/discriminator-non-string/index.ts
+3
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/discriminator-non-string/index.ts
···
1
+
// This file is auto-generated by @hey-api/openapi-ts
2
+
3
+
export type { AutoConfig, BooleanAnyOf, BooleanOneOf, ClientOptions, CustomConfig, IntegerAllOfBase, IntegerAllOfChildA, IntegerAllOfChildB, IntegerOneOf, NullableIntegerOneOf, NullableVariantX, NullableVariantY, NumberOneOf, TypeOne, TypeTwo, VersionAlpha, VersionBeta } from './types.gen';
+89
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/discriminator-non-string/types.gen.ts
+89
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/discriminator-non-string/types.gen.ts
···
1
+
// This file is auto-generated by @hey-api/openapi-ts
2
+
3
+
export type ClientOptions = {
4
+
baseUrl: `${string}://${string}` | (string & {});
5
+
};
6
+
7
+
export type BooleanOneOf = ({
8
+
use_custom: false;
9
+
} & AutoConfig) | ({
10
+
use_custom: true;
11
+
} & CustomConfig);
12
+
13
+
export type AutoConfig = {
14
+
use_custom: false;
15
+
auto_setting: string;
16
+
};
17
+
18
+
export type CustomConfig = {
19
+
use_custom: true;
20
+
custom_value: number;
21
+
};
22
+
23
+
export type BooleanAnyOf = ({
24
+
use_custom?: false;
25
+
} & AutoConfig) | ({
26
+
use_custom?: true;
27
+
} & CustomConfig);
28
+
29
+
export type IntegerOneOf = ({
30
+
type_id: 1;
31
+
} & TypeOne) | ({
32
+
type_id: 2;
33
+
} & TypeTwo);
34
+
35
+
export type TypeOne = {
36
+
type_id: 1;
37
+
one_data: string;
38
+
};
39
+
40
+
export type TypeTwo = {
41
+
type_id: 2;
42
+
two_data: string;
43
+
};
44
+
45
+
export type NumberOneOf = ({
46
+
version: 1;
47
+
} & VersionAlpha) | ({
48
+
version: 2.5;
49
+
} & VersionBeta);
50
+
51
+
export type VersionAlpha = {
52
+
version: 1;
53
+
alpha_field: string;
54
+
};
55
+
56
+
export type VersionBeta = {
57
+
version: 2.5;
58
+
beta_field: string;
59
+
};
60
+
61
+
export type IntegerAllOfBase = {
62
+
kind: number;
63
+
};
64
+
65
+
export type IntegerAllOfChildA = Omit<IntegerAllOfBase, 'kind'> & {
66
+
child_a_field: string;
67
+
kind: 1;
68
+
};
69
+
70
+
export type IntegerAllOfChildB = Omit<IntegerAllOfBase, 'kind'> & {
71
+
child_b_field: string;
72
+
kind: 2;
73
+
};
74
+
75
+
export type NullableIntegerOneOf = ({
76
+
tag: 10;
77
+
} & NullableVariantX) | ({
78
+
tag: 20;
79
+
} & NullableVariantY);
80
+
81
+
export type NullableVariantX = {
82
+
tag: 10 | null;
83
+
x_data: string;
84
+
};
85
+
86
+
export type NullableVariantY = {
87
+
tag: 20 | null;
88
+
y_data: string;
89
+
};
+155
specs/3.0.x/discriminator-non-string.yaml
+155
specs/3.0.x/discriminator-non-string.yaml
···
1
+
openapi: 3.0.3
2
+
info:
3
+
title: Non-string discriminator test
4
+
version: 1
5
+
components:
6
+
schemas:
7
+
# --- Boolean discriminator (oneOf) ---
8
+
BooleanOneOf:
9
+
oneOf:
10
+
- $ref: '#/components/schemas/AutoConfig'
11
+
- $ref: '#/components/schemas/CustomConfig'
12
+
discriminator:
13
+
propertyName: use_custom
14
+
mapping:
15
+
'False': '#/components/schemas/AutoConfig'
16
+
'True': '#/components/schemas/CustomConfig'
17
+
18
+
AutoConfig:
19
+
type: object
20
+
required:
21
+
- use_custom
22
+
- auto_setting
23
+
properties:
24
+
use_custom:
25
+
type: boolean
26
+
const: false
27
+
auto_setting:
28
+
type: string
29
+
30
+
CustomConfig:
31
+
type: object
32
+
required:
33
+
- use_custom
34
+
- custom_value
35
+
properties:
36
+
use_custom:
37
+
type: boolean
38
+
const: true
39
+
custom_value:
40
+
type: integer
41
+
42
+
# --- Boolean discriminator (anyOf) ---
43
+
BooleanAnyOf:
44
+
anyOf:
45
+
- $ref: '#/components/schemas/AutoConfig'
46
+
- $ref: '#/components/schemas/CustomConfig'
47
+
discriminator:
48
+
propertyName: use_custom
49
+
mapping:
50
+
'False': '#/components/schemas/AutoConfig'
51
+
'True': '#/components/schemas/CustomConfig'
52
+
53
+
# --- Integer discriminator (oneOf) ---
54
+
IntegerOneOf:
55
+
oneOf:
56
+
- $ref: '#/components/schemas/TypeOne'
57
+
- $ref: '#/components/schemas/TypeTwo'
58
+
discriminator:
59
+
propertyName: type_id
60
+
mapping:
61
+
'1': '#/components/schemas/TypeOne'
62
+
'2': '#/components/schemas/TypeTwo'
63
+
64
+
TypeOne:
65
+
type: object
66
+
required:
67
+
- type_id
68
+
- one_data
69
+
properties:
70
+
type_id:
71
+
type: integer
72
+
const: 1
73
+
one_data:
74
+
type: string
75
+
76
+
TypeTwo:
77
+
type: object
78
+
required:
79
+
- type_id
80
+
- two_data
81
+
properties:
82
+
type_id:
83
+
type: integer
84
+
const: 2
85
+
two_data:
86
+
type: string
87
+
88
+
# --- Number (float) discriminator (oneOf) ---
89
+
NumberOneOf:
90
+
oneOf:
91
+
- $ref: '#/components/schemas/VersionAlpha'
92
+
- $ref: '#/components/schemas/VersionBeta'
93
+
discriminator:
94
+
propertyName: version
95
+
mapping:
96
+
'1.0': '#/components/schemas/VersionAlpha'
97
+
'2.5': '#/components/schemas/VersionBeta'
98
+
99
+
VersionAlpha:
100
+
type: object
101
+
required:
102
+
- version
103
+
- alpha_field
104
+
properties:
105
+
version:
106
+
type: number
107
+
const: 1.0
108
+
alpha_field:
109
+
type: string
110
+
111
+
VersionBeta:
112
+
type: object
113
+
required:
114
+
- version
115
+
- beta_field
116
+
properties:
117
+
version:
118
+
type: number
119
+
const: 2.5
120
+
beta_field:
121
+
type: string
122
+
123
+
# --- Integer discriminator (allOf) ---
124
+
IntegerAllOfBase:
125
+
type: object
126
+
required:
127
+
- kind
128
+
properties:
129
+
kind:
130
+
type: integer
131
+
discriminator:
132
+
propertyName: kind
133
+
mapping:
134
+
'1': '#/components/schemas/IntegerAllOfChildA'
135
+
'2': '#/components/schemas/IntegerAllOfChildB'
136
+
137
+
IntegerAllOfChildA:
138
+
allOf:
139
+
- $ref: '#/components/schemas/IntegerAllOfBase'
140
+
- type: object
141
+
required:
142
+
- child_a_field
143
+
properties:
144
+
child_a_field:
145
+
type: string
146
+
147
+
IntegerAllOfChildB:
148
+
allOf:
149
+
- $ref: '#/components/schemas/IntegerAllOfBase'
150
+
- type: object
151
+
required:
152
+
- child_b_field
153
+
properties:
154
+
child_b_field:
155
+
type: string
+194
specs/3.1.x/discriminator-non-string.yaml
+194
specs/3.1.x/discriminator-non-string.yaml
···
1
+
openapi: 3.1.0
2
+
info:
3
+
title: Non-string discriminator test
4
+
version: 1
5
+
components:
6
+
schemas:
7
+
# --- Boolean discriminator (oneOf) ---
8
+
BooleanOneOf:
9
+
oneOf:
10
+
- $ref: '#/components/schemas/AutoConfig'
11
+
- $ref: '#/components/schemas/CustomConfig'
12
+
discriminator:
13
+
propertyName: use_custom
14
+
mapping:
15
+
'False': '#/components/schemas/AutoConfig'
16
+
'True': '#/components/schemas/CustomConfig'
17
+
18
+
AutoConfig:
19
+
type: object
20
+
required:
21
+
- use_custom
22
+
- auto_setting
23
+
properties:
24
+
use_custom:
25
+
type: boolean
26
+
const: false
27
+
auto_setting:
28
+
type: string
29
+
30
+
CustomConfig:
31
+
type: object
32
+
required:
33
+
- use_custom
34
+
- custom_value
35
+
properties:
36
+
use_custom:
37
+
type: boolean
38
+
const: true
39
+
custom_value:
40
+
type: integer
41
+
42
+
# --- Boolean discriminator (anyOf) ---
43
+
BooleanAnyOf:
44
+
anyOf:
45
+
- $ref: '#/components/schemas/AutoConfig'
46
+
- $ref: '#/components/schemas/CustomConfig'
47
+
discriminator:
48
+
propertyName: use_custom
49
+
mapping:
50
+
'False': '#/components/schemas/AutoConfig'
51
+
'True': '#/components/schemas/CustomConfig'
52
+
53
+
# --- Integer discriminator (oneOf) ---
54
+
IntegerOneOf:
55
+
oneOf:
56
+
- $ref: '#/components/schemas/TypeOne'
57
+
- $ref: '#/components/schemas/TypeTwo'
58
+
discriminator:
59
+
propertyName: type_id
60
+
mapping:
61
+
'1': '#/components/schemas/TypeOne'
62
+
'2': '#/components/schemas/TypeTwo'
63
+
64
+
TypeOne:
65
+
type: object
66
+
required:
67
+
- type_id
68
+
- one_data
69
+
properties:
70
+
type_id:
71
+
type: integer
72
+
const: 1
73
+
one_data:
74
+
type: string
75
+
76
+
TypeTwo:
77
+
type: object
78
+
required:
79
+
- type_id
80
+
- two_data
81
+
properties:
82
+
type_id:
83
+
type: integer
84
+
const: 2
85
+
two_data:
86
+
type: string
87
+
88
+
# --- Number (float) discriminator (oneOf) ---
89
+
NumberOneOf:
90
+
oneOf:
91
+
- $ref: '#/components/schemas/VersionAlpha'
92
+
- $ref: '#/components/schemas/VersionBeta'
93
+
discriminator:
94
+
propertyName: version
95
+
mapping:
96
+
'1.0': '#/components/schemas/VersionAlpha'
97
+
'2.5': '#/components/schemas/VersionBeta'
98
+
99
+
VersionAlpha:
100
+
type: object
101
+
required:
102
+
- version
103
+
- alpha_field
104
+
properties:
105
+
version:
106
+
type: number
107
+
const: 1.0
108
+
alpha_field:
109
+
type: string
110
+
111
+
VersionBeta:
112
+
type: object
113
+
required:
114
+
- version
115
+
- beta_field
116
+
properties:
117
+
version:
118
+
type: number
119
+
const: 2.5
120
+
beta_field:
121
+
type: string
122
+
123
+
# --- Integer discriminator (allOf) ---
124
+
IntegerAllOfBase:
125
+
type: object
126
+
required:
127
+
- kind
128
+
properties:
129
+
kind:
130
+
type: integer
131
+
discriminator:
132
+
propertyName: kind
133
+
mapping:
134
+
'1': '#/components/schemas/IntegerAllOfChildA'
135
+
'2': '#/components/schemas/IntegerAllOfChildB'
136
+
137
+
IntegerAllOfChildA:
138
+
allOf:
139
+
- $ref: '#/components/schemas/IntegerAllOfBase'
140
+
- type: object
141
+
required:
142
+
- child_a_field
143
+
properties:
144
+
child_a_field:
145
+
type: string
146
+
147
+
IntegerAllOfChildB:
148
+
allOf:
149
+
- $ref: '#/components/schemas/IntegerAllOfBase'
150
+
- type: object
151
+
required:
152
+
- child_b_field
153
+
properties:
154
+
child_b_field:
155
+
type: string
156
+
157
+
# --- 3.1.x-specific: discriminator property with type array (e.g. nullable integer) ---
158
+
NullableIntegerOneOf:
159
+
oneOf:
160
+
- $ref: '#/components/schemas/NullableVariantX'
161
+
- $ref: '#/components/schemas/NullableVariantY'
162
+
discriminator:
163
+
propertyName: tag
164
+
mapping:
165
+
'10': '#/components/schemas/NullableVariantX'
166
+
'20': '#/components/schemas/NullableVariantY'
167
+
168
+
NullableVariantX:
169
+
type: object
170
+
required:
171
+
- tag
172
+
- x_data
173
+
properties:
174
+
tag:
175
+
type:
176
+
- integer
177
+
- 'null'
178
+
const: 10
179
+
x_data:
180
+
type: string
181
+
182
+
NullableVariantY:
183
+
type: object
184
+
required:
185
+
- tag
186
+
- y_data
187
+
properties:
188
+
tag:
189
+
type:
190
+
- integer
191
+
- 'null'
192
+
const: 20
193
+
y_data:
194
+
type: string