fork of hey-api/openapi-ts because I need some additional things
Merge pull request #3301 from hey-api/copilot/fix-type-discriminator-values
Fix discriminator values in writable type variants
+443
-7
+5
.changeset/quiet-hats-switch.md
+5
.changeset/quiet-hats-switch.md
+7
packages/openapi-ts-tests/main/test/3.1.x.test.ts
+7
packages/openapi-ts-tests/main/test/3.1.x.test.ts
···
229
229
},
230
230
{
231
231
config: createConfig({
232
+
input: 'discriminator-one-of-read-write.yaml',
233
+
output: 'discriminator-one-of-read-write',
234
+
}),
235
+
description: 'handles discriminator with oneOf and read/write transforms',
236
+
},
237
+
{
238
+
config: createConfig({
232
239
input: 'duplicate-null.json',
233
240
output: 'duplicate-null',
234
241
}),
+3
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/discriminator-one-of-read-write/index.ts
+3
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/discriminator-one-of-read-write/index.ts
···
1
+
// This file is auto-generated by @hey-api/openapi-ts
2
+
3
+
export type { AnimalPayload, AnimalPayloadWritable, CatPayload, CatPayloadWritable, ClientOptions, CreatePetRequest, CreatePetRequestWritable, CreatePetResponse, CreatePetResponseWritable, DogPayload, DogPayloadWritable, PostPetsData, PostPetsResponse, PostPetsResponses } from './types.gen';
+93
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/discriminator-one-of-read-write/types.gen.ts
+93
packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/discriminator-one-of-read-write/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 AnimalPayload = {
8
+
typeDiscriminator: string;
9
+
};
10
+
11
+
export type DogPayload = Omit<AnimalPayload, 'typeDiscriminator'> & {
12
+
breed: string;
13
+
canFetch: boolean;
14
+
readonly displayBreed: string;
15
+
typeDiscriminator: 'dog';
16
+
};
17
+
18
+
export type CatPayload = Omit<AnimalPayload, 'typeDiscriminator'> & {
19
+
breed: string;
20
+
livesRemaining: number;
21
+
readonly displayBreed: string;
22
+
typeDiscriminator: 'cat';
23
+
};
24
+
25
+
export type CreatePetRequest = {
26
+
name: string;
27
+
animal: ({
28
+
typeDiscriminator: 'dog';
29
+
} & DogPayload) | ({
30
+
typeDiscriminator: 'cat';
31
+
} & CatPayload);
32
+
};
33
+
34
+
export type CreatePetResponse = {
35
+
id: string;
36
+
name: string;
37
+
animal: ({
38
+
typeDiscriminator: 'dog';
39
+
} & DogPayload) | ({
40
+
typeDiscriminator: 'cat';
41
+
} & CatPayload);
42
+
};
43
+
44
+
export type DogPayloadWritable = Omit<AnimalPayloadWritable, 'typeDiscriminator'> & {
45
+
breed: string;
46
+
canFetch: boolean;
47
+
typeDiscriminator: 'dog';
48
+
};
49
+
50
+
export type CatPayloadWritable = Omit<AnimalPayloadWritable, 'typeDiscriminator'> & {
51
+
breed: string;
52
+
livesRemaining: number;
53
+
typeDiscriminator: 'cat';
54
+
};
55
+
56
+
export type CreatePetRequestWritable = {
57
+
name: string;
58
+
animal: ({
59
+
typeDiscriminator: 'dog';
60
+
} & DogPayloadWritable) | ({
61
+
typeDiscriminator: 'cat';
62
+
} & CatPayloadWritable);
63
+
};
64
+
65
+
export type CreatePetResponseWritable = {
66
+
id: string;
67
+
name: string;
68
+
animal: ({
69
+
typeDiscriminator: 'dog';
70
+
} & DogPayloadWritable) | ({
71
+
typeDiscriminator: 'cat';
72
+
} & CatPayloadWritable);
73
+
};
74
+
75
+
export type AnimalPayloadWritable = {
76
+
typeDiscriminator: string;
77
+
};
78
+
79
+
export type PostPetsData = {
80
+
body: CreatePetRequestWritable;
81
+
path?: never;
82
+
query?: never;
83
+
url: '/pets';
84
+
};
85
+
86
+
export type PostPetsResponses = {
87
+
/**
88
+
* OK
89
+
*/
90
+
200: CreatePetResponse;
91
+
};
92
+
93
+
export type PostPetsResponse = PostPetsResponses[keyof PostPetsResponses];
+107
specs/3.1.x/discriminator-one-of-read-write.yaml
+107
specs/3.1.x/discriminator-one-of-read-write.yaml
···
1
+
openapi: 3.1.0
2
+
info:
3
+
title: OpenAPI 3.1.0 discriminator one of with read/write example
4
+
version: 1
5
+
paths:
6
+
/pets:
7
+
post:
8
+
requestBody:
9
+
content:
10
+
application/json:
11
+
schema:
12
+
$ref: '#/components/schemas/CreatePetRequest'
13
+
required: true
14
+
responses:
15
+
'200':
16
+
content:
17
+
application/json:
18
+
schema:
19
+
$ref: '#/components/schemas/CreatePetResponse'
20
+
description: OK
21
+
components:
22
+
schemas:
23
+
AnimalPayload:
24
+
type: object
25
+
required:
26
+
- typeDiscriminator
27
+
properties:
28
+
typeDiscriminator:
29
+
type: string
30
+
discriminator:
31
+
propertyName: typeDiscriminator
32
+
mapping:
33
+
dog: '#/components/schemas/DogPayload'
34
+
cat: '#/components/schemas/CatPayload'
35
+
36
+
DogPayload:
37
+
allOf:
38
+
- $ref: '#/components/schemas/AnimalPayload'
39
+
- type: object
40
+
required:
41
+
- breed
42
+
- canFetch
43
+
- displayBreed
44
+
properties:
45
+
breed:
46
+
type: string
47
+
canFetch:
48
+
type: boolean
49
+
displayBreed:
50
+
type: string
51
+
readOnly: true
52
+
53
+
CatPayload:
54
+
allOf:
55
+
- $ref: '#/components/schemas/AnimalPayload'
56
+
- type: object
57
+
required:
58
+
- breed
59
+
- livesRemaining
60
+
- displayBreed
61
+
properties:
62
+
breed:
63
+
type: string
64
+
livesRemaining:
65
+
type: integer
66
+
displayBreed:
67
+
type: string
68
+
readOnly: true
69
+
70
+
CreatePetRequest:
71
+
type: object
72
+
required:
73
+
- name
74
+
- animal
75
+
properties:
76
+
name:
77
+
type: string
78
+
animal:
79
+
oneOf:
80
+
- $ref: '#/components/schemas/DogPayload'
81
+
- $ref: '#/components/schemas/CatPayload'
82
+
discriminator:
83
+
propertyName: typeDiscriminator
84
+
mapping:
85
+
dog: '#/components/schemas/DogPayload'
86
+
cat: '#/components/schemas/CatPayload'
87
+
88
+
CreatePetResponse:
89
+
type: object
90
+
required:
91
+
- id
92
+
- name
93
+
- animal
94
+
properties:
95
+
id:
96
+
type: string
97
+
name:
98
+
type: string
99
+
animal:
100
+
oneOf:
101
+
- $ref: '#/components/schemas/DogPayload'
102
+
- $ref: '#/components/schemas/CatPayload'
103
+
discriminator:
104
+
propertyName: typeDiscriminator
105
+
mapping:
106
+
dog: '#/components/schemas/DogPayload'
107
+
cat: '#/components/schemas/CatPayload'