Skip to content

Commit 3585e82

Browse files
markeriksonmarkerikson
committed
Handle updated params formatting
1 parent 1f6c72e commit 3585e82

File tree

2 files changed

+80
-26
lines changed

2 files changed

+80
-26
lines changed

‎packages/rtk-query-codegen-openapi/test/__snapshots__/generateEndpoints.test.ts.snap

Lines changed: 75 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -965,7 +965,9 @@ const injectedRtkApi = api.injectEndpoints({
965965
>({
966966
query: (queryArg) => ({
967967
url: \`/pet/findByStatus\`,
968-
params: { status: queryArg.status },
968+
params: {
969+
status: queryArg.status,
970+
},
969971
}),
970972
}),
971973
findPetsByTags: build.query<
@@ -1123,7 +1125,8 @@ export type DeleteOrderApiArg = {
11231125
/** ID of the order that needs to be deleted */
11241126
orderId: number;
11251127
};
1126-
export type CreateUserApiResponse = unknown;
1128+
export type CreateUserApiResponse =
1129+
/** status default successful operation */ User;
11271130
export type CreateUserApiArg = {
11281131
/** Created user object */
11291132
user: User;
@@ -1170,6 +1173,7 @@ export type Pet = {
11701173
category?: Category | undefined;
11711174
photoUrls: string[];
11721175
tags?: Tag[] | undefined;
1176+
/** pet status in the store */
11731177
status?: ("available" | "pending" | "sold") | undefined;
11741178
};
11751179
export type ApiResponse = {
@@ -1182,6 +1186,7 @@ export type Order = {
11821186
petId?: number | undefined;
11831187
quantity?: number | undefined;
11841188
shipDate?: string | undefined;
1189+
/** Order Status */
11851190
status?: ("placed" | "approved" | "delivered") | undefined;
11861191
complete?: boolean | undefined;
11871192
};
@@ -1193,6 +1198,7 @@ export type User = {
11931198
email?: string | undefined;
11941199
password?: string | undefined;
11951200
phone?: string | undefined;
1201+
/** User Status */
11961202
userStatus?: number | undefined;
11971203
};
11981204
"
@@ -1240,22 +1246,28 @@ const injectedRtkApi = api.injectEndpoints({
12401246
query: (queryArg) => ({
12411247
url: \`/pet/\${queryArg.petId}\`,
12421248
method: "POST",
1243-
params: { name: queryArg.name },
1249+
params: {
1250+
name: queryArg.name,
1251+
},
12441252
}),
12451253
}),
12461254
deletePet: build.mutation<DeletePetApiResponse, DeletePetApiArg>({
12471255
query: (queryArg) => ({
12481256
url: \`/pet/\${queryArg.petId}\`,
12491257
method: "DELETE",
1250-
headers: { api_key: queryArg.apiKey },
1258+
headers: {
1259+
api_key: queryArg.apiKey,
1260+
},
12511261
}),
12521262
}),
12531263
uploadFile: build.mutation<UploadFileApiResponse, UploadFileApiArg>({
12541264
query: (queryArg) => ({
12551265
url: \`/pet/\${queryArg.petId}/uploadImage\`,
12561266
method: "POST",
12571267
body: queryArg.body,
1258-
params: { additionalMetadata: queryArg.additionalMetadata },
1268+
params: {
1269+
additionalMetadata: queryArg.additionalMetadata,
1270+
},
12591271
}),
12601272
}),
12611273
getInventory: build.query<GetInventoryApiResponse, GetInventoryApiArg>({
@@ -1297,7 +1309,9 @@ const injectedRtkApi = api.injectEndpoints({
12971309
loginUser: build.query<LoginUserApiResponse, LoginUserApiArg>({
12981310
query: (queryArg) => ({
12991311
url: \`/user/login\`,
1300-
params: { username: queryArg.username },
1312+
params: {
1313+
username: queryArg.username,
1314+
},
13011315
}),
13021316
}),
13031317
logoutUser: build.query<LogoutUserApiResponse, LogoutUserApiArg>({
@@ -1390,7 +1404,8 @@ export type DeleteOrderApiArg = {
13901404
/** ID of the order that needs to be deleted */
13911405
orderId: number;
13921406
};
1393-
export type CreateUserApiResponse = unknown;
1407+
export type CreateUserApiResponse =
1408+
/** status default successful operation */ User;
13941409
export type CreateUserApiArg = {
13951410
/** Created user object */
13961411
user: User;
@@ -1440,6 +1455,7 @@ export type Pet = {
14401455
category?: Category | undefined;
14411456
photoUrls: string[];
14421457
tags?: Tag[] | undefined;
1458+
/** pet status in the store */
14431459
status?: ("available" | "pending" | "sold") | undefined;
14441460
};
14451461
export type ApiResponse = {
@@ -1452,6 +1468,7 @@ export type Order = {
14521468
petId?: number | undefined;
14531469
quantity?: number | undefined;
14541470
shipDate?: string | undefined;
1471+
/** Order Status */
14551472
status?: ("placed" | "approved" | "delivered") | undefined;
14561473
complete?: boolean | undefined;
14571474
};
@@ -1463,6 +1480,7 @@ export type User = {
14631480
email?: string | undefined;
14641481
password?: string | undefined;
14651482
phone?: string | undefined;
1483+
/** User Status */
14661484
userStatus?: number | undefined;
14671485
};
14681486
"
@@ -1494,7 +1512,9 @@ const injectedRtkApi = api.injectEndpoints({
14941512
>({
14951513
query: (queryArg) => ({
14961514
url: \`/pet/findByStatus\`,
1497-
params: { status: queryArg.status },
1515+
params: {
1516+
status: queryArg.status,
1517+
},
14981518
}),
14991519
}),
15001520
findPetsByTags: build.query<
@@ -1503,7 +1523,9 @@ const injectedRtkApi = api.injectEndpoints({
15031523
>({
15041524
query: (queryArg) => ({
15051525
url: \`/pet/findByTags\`,
1506-
params: { tags: queryArg.tags },
1526+
params: {
1527+
tags: queryArg.tags,
1528+
},
15071529
}),
15081530
}),
15091531
getPetById: build.query<GetPetByIdApiResponse, GetPetByIdApiArg>({
@@ -1516,7 +1538,10 @@ const injectedRtkApi = api.injectEndpoints({
15161538
query: (queryArg) => ({
15171539
url: \`/pet/\${queryArg.petId}\`,
15181540
method: "POST",
1519-
params: { name: queryArg.name, status: queryArg.status },
1541+
params: {
1542+
name: queryArg.name,
1543+
status: queryArg.status,
1544+
},
15201545
}),
15211546
}),
15221547
deletePet: build.mutation<DeletePetApiResponse, DeletePetApiArg>({
@@ -1530,7 +1555,9 @@ const injectedRtkApi = api.injectEndpoints({
15301555
url: \`/pet/\${queryArg.petId}/uploadImage\`,
15311556
method: "POST",
15321557
body: queryArg.body,
1533-
params: { additionalMetadata: queryArg.additionalMetadata },
1558+
params: {
1559+
additionalMetadata: queryArg.additionalMetadata,
1560+
},
15341561
}),
15351562
}),
15361563
getInventory: build.query<GetInventoryApiResponse, GetInventoryApiArg>({
@@ -1572,7 +1599,10 @@ const injectedRtkApi = api.injectEndpoints({
15721599
loginUser: build.query<LoginUserApiResponse, LoginUserApiArg>({
15731600
query: (queryArg) => ({
15741601
url: \`/user/login\`,
1575-
params: { username: queryArg.username, password: queryArg.password },
1602+
params: {
1603+
username: queryArg.username,
1604+
password: queryArg.password,
1605+
},
15761606
}),
15771607
}),
15781608
logoutUser: build.query<LogoutUserApiResponse, LogoutUserApiArg>({
@@ -1672,7 +1702,8 @@ export type DeleteOrderApiArg = {
16721702
/** ID of the order that needs to be deleted */
16731703
orderId: number;
16741704
};
1675-
export type CreateUserApiResponse = unknown;
1705+
export type CreateUserApiResponse =
1706+
/** status default successful operation */ User;
16761707
export type CreateUserApiArg = {
16771708
/** Created user object */
16781709
user: User;
@@ -1724,6 +1755,7 @@ export type Pet = {
17241755
category?: Category | undefined;
17251756
photoUrls: string[];
17261757
tags?: Tag[] | undefined;
1758+
/** pet status in the store */
17271759
status?: ("available" | "pending" | "sold") | undefined;
17281760
};
17291761
export type ApiResponse = {
@@ -1736,6 +1768,7 @@ export type Order = {
17361768
petId?: number | undefined;
17371769
quantity?: number | undefined;
17381770
shipDate?: string | undefined;
1771+
/** Order Status */
17391772
status?: ("placed" | "approved" | "delivered") | undefined;
17401773
complete?: boolean | undefined;
17411774
};
@@ -1747,6 +1780,7 @@ export type User = {
17471780
email?: string | undefined;
17481781
password?: string | undefined;
17491782
phone?: string | undefined;
1783+
/** User Status */
17501784
userStatus?: number | undefined;
17511785
};
17521786
"
@@ -1794,22 +1828,28 @@ const injectedRtkApi = api.injectEndpoints({
17941828
query: (queryArg) => ({
17951829
url: \`/pet/\${queryArg.petId}\`,
17961830
method: "POST",
1797-
params: { name: queryArg.name },
1831+
params: {
1832+
name: queryArg.name,
1833+
},
17981834
}),
17991835
}),
18001836
deletePet: build.mutation<DeletePetApiResponse, DeletePetApiArg>({
18011837
query: (queryArg) => ({
18021838
url: \`/pet/\${queryArg.petId}\`,
18031839
method: "DELETE",
1804-
headers: { api_key: queryArg.apiKey },
1840+
headers: {
1841+
api_key: queryArg.apiKey,
1842+
},
18051843
}),
18061844
}),
18071845
uploadFile: build.mutation<UploadFileApiResponse, UploadFileApiArg>({
18081846
query: (queryArg) => ({
18091847
url: \`/pet/\${queryArg.petId}/uploadImage\`,
18101848
method: "POST",
18111849
body: queryArg.body,
1812-
params: { additionalMetadata: queryArg.additionalMetadata },
1850+
params: {
1851+
additionalMetadata: queryArg.additionalMetadata,
1852+
},
18131853
}),
18141854
}),
18151855
getInventory: build.query<GetInventoryApiResponse, GetInventoryApiArg>({
@@ -1851,7 +1891,9 @@ const injectedRtkApi = api.injectEndpoints({
18511891
loginUser: build.query<LoginUserApiResponse, LoginUserApiArg>({
18521892
query: (queryArg) => ({
18531893
url: \`/user/login\`,
1854-
params: { username: queryArg.username },
1894+
params: {
1895+
username: queryArg.username,
1896+
},
18551897
}),
18561898
}),
18571899
logoutUser: build.query<LogoutUserApiResponse, LogoutUserApiArg>({
@@ -1944,7 +1986,8 @@ export type DeleteOrderApiArg = {
19441986
/** ID of the order that needs to be deleted */
19451987
orderId: number;
19461988
};
1947-
export type CreateUserApiResponse = unknown;
1989+
export type CreateUserApiResponse =
1990+
/** status default successful operation */ User;
19481991
export type CreateUserApiArg = {
19491992
/** Created user object */
19501993
user: User;
@@ -1994,6 +2037,7 @@ export type Pet = {
19942037
category?: Category | undefined;
19952038
photoUrls: string[];
19962039
tags?: Tag[] | undefined;
2040+
/** pet status in the store */
19972041
status?: ("available" | "pending" | "sold") | undefined;
19982042
};
19992043
export type ApiResponse = {
@@ -2006,6 +2050,7 @@ export type Order = {
20062050
petId?: number | undefined;
20072051
quantity?: number | undefined;
20082052
shipDate?: string | undefined;
2053+
/** Order Status */
20092054
status?: ("placed" | "approved" | "delivered") | undefined;
20102055
complete?: boolean | undefined;
20112056
};
@@ -2017,6 +2062,7 @@ export type User = {
20172062
email?: string | undefined;
20182063
password?: string | undefined;
20192064
phone?: string | undefined;
2065+
/** User Status */
20202066
userStatus?: number | undefined;
20212067
};
20222068
"
@@ -2048,7 +2094,9 @@ const injectedRtkApi = api.injectEndpoints({
20482094
>({
20492095
query: (queryArg) => ({
20502096
url: \`/pet/findByStatus\`,
2051-
params: { status: queryArg.status },
2097+
params: {
2098+
status: queryArg.status,
2099+
},
20522100
}),
20532101
}),
20542102
findPetsByTags: build.query<
@@ -2067,7 +2115,9 @@ const injectedRtkApi = api.injectEndpoints({
20672115
query: (queryArg) => ({
20682116
url: \`/pet/\${queryArg.petId}\`,
20692117
method: "POST",
2070-
params: { status: queryArg.status },
2118+
params: {
2119+
status: queryArg.status,
2120+
},
20712121
}),
20722122
}),
20732123
deletePet: build.mutation<DeletePetApiResponse, DeletePetApiArg>({
@@ -2212,7 +2262,8 @@ export type DeleteOrderApiArg = {
22122262
/** ID of the order that needs to be deleted */
22132263
orderId: number;
22142264
};
2215-
export type CreateUserApiResponse = unknown;
2265+
export type CreateUserApiResponse =
2266+
/** status default successful operation */ User;
22162267
export type CreateUserApiArg = {
22172268
/** Created user object */
22182269
user: User;
@@ -2259,6 +2310,7 @@ export type Pet = {
22592310
category?: Category | undefined;
22602311
photoUrls: string[];
22612312
tags?: Tag[] | undefined;
2313+
/** pet status in the store */
22622314
status?: ("available" | "pending" | "sold") | undefined;
22632315
};
22642316
export type ApiResponse = {
@@ -2271,6 +2323,7 @@ export type Order = {
22712323
petId?: number | undefined;
22722324
quantity?: number | undefined;
22732325
shipDate?: string | undefined;
2326+
/** Order Status */
22742327
status?: ("placed" | "approved" | "delivered") | undefined;
22752328
complete?: boolean | undefined;
22762329
};
@@ -2282,6 +2335,7 @@ export type User = {
22822335
email?: string | undefined;
22832336
password?: string | undefined;
22842337
phone?: string | undefined;
2338+
/** User Status */
22852339
userStatus?: number | undefined;
22862340
};
22872341
"

‎packages/rtk-query-codegen-openapi/test/generateEndpoints.test.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ describe('endpoint overrides', () => {
9898
},
9999
],
100100
});
101-
expect(api).not.toMatch(/params: {.*queryArg\.\w+\b(?<!\bstatus)/);
101+
expect(api).not.toMatch(/params: {\n.*queryArg\.\w+\b(?<!\bstatus)/);
102102
expect(api).toMatchSnapshot('should only have the "status" parameter from the endpoints');
103103
});
104104

@@ -114,8 +114,8 @@ describe('endpoint overrides', () => {
114114
},
115115
],
116116
});
117-
expect(api).not.toMatch(/params: {.*queryArg\.[^\We]*\W/);
118-
expect(api).toMatch(/params: {.*queryArg\.[\we]*\W/);
117+
expect(api).not.toMatch(/params: {\n.*queryArg\.[^\We]*\W/);
118+
expect(api).toMatch(/params: {\n.*queryArg\.[\we]*\W/);
119119
expect(api).toMatchSnapshot('should only have the parameters with an "e"');
120120
});
121121

@@ -131,8 +131,8 @@ describe('endpoint overrides', () => {
131131
},
132132
],
133133
});
134-
expect(api).not.toMatch(/params: {.*queryArg\.[^\Wef]*\W/);
135-
expect(api).toMatch(/params: {.*queryArg\.[\wef]*\W/);
134+
expect(api).not.toMatch(/params: {\n.*queryArg\.[^\Wef]*\W/);
135+
expect(api).toMatch(/params: {\n.*queryArg\.[\wef]*\W/);
136136
expect(api).toMatchSnapshot('should only have the parameters with an "e" or "f"');
137137
});
138138

0 commit comments

Comments
 (0)