Skip to content

Commit 9aadd77

Browse files
bodograumannbodograumann
authored
Add message and more context to RequiredError (#10530)
1 parent 22d98c1 commit 9aadd77

File tree

24 files changed

+130
-115
lines changed

24 files changed

+130
-115
lines changed

‎modules/openapi-generator/src/main/resources/typescript/api/api.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export class {{classname}}RequestFactory extends BaseAPIRequestFactory {
4848
{{#required}}
4949
// verify required parameter '{{paramName}}' is not null or undefined
5050
if ({{paramName}} === null || {{paramName}} === undefined) {
51-
throw new RequiredError('Required parameter {{paramName}} was null or undefined when calling {{nickname}}.');
51+
throw new RequiredError("{{classname}}", "{{nickname}}", "{{paramName}}");
5252
}
5353

5454
{{/required}}

‎modules/openapi-generator/src/main/resources/typescript/api/baseapi.mustache

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export class BaseAPIRequestFactory {
3838
*/
3939
export class RequiredError extends Error {
4040
name: "RequiredError" = "RequiredError";
41-
constructor(public field: string, msg?: string) {
42-
super(msg);
41+
constructor(public api: string, public method: string, public field: string) {
42+
super("Required parameter " + field + " was null or undefined when calling " + api + "." + method + ".");
4343
}
4444
}

‎samples/openapi3/client/petstore/typescript/builds/composed-schemas/apis/baseapi.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export class BaseAPIRequestFactory {
3131
*/
3232
export class RequiredError extends Error {
3333
name: "RequiredError" = "RequiredError";
34-
constructor(public field: string, msg?: string) {
35-
super(msg);
34+
constructor(public api: string, public method: string, public field: string) {
35+
super("Required parameter " + field + " was null or undefined when calling " + api + "." + method + ".");
3636
}
3737
}

‎samples/openapi3/client/petstore/typescript/builds/default/apis/PetApi.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
2626

2727
// verify required parameter 'pet' is not null or undefined
2828
if (pet === null || pet === undefined) {
29-
throw new RequiredError('Required parameter pet was null or undefined when calling addPet.');
29+
throw new RequiredError("PetApi", "addPet", "pet");
3030
}
3131

3232

@@ -71,7 +71,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
7171

7272
// verify required parameter 'petId' is not null or undefined
7373
if (petId === null || petId === undefined) {
74-
throw new RequiredError('Required parameter petId was null or undefined when calling deletePet.');
74+
throw new RequiredError("PetApi", "deletePet", "petId");
7575
}
7676

7777

@@ -108,7 +108,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
108108

109109
// verify required parameter 'status' is not null or undefined
110110
if (status === null || status === undefined) {
111-
throw new RequiredError('Required parameter status was null or undefined when calling findPetsByStatus.');
111+
throw new RequiredError("PetApi", "findPetsByStatus", "status");
112112
}
113113

114114

@@ -145,7 +145,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
145145

146146
// verify required parameter 'tags' is not null or undefined
147147
if (tags === null || tags === undefined) {
148-
throw new RequiredError('Required parameter tags was null or undefined when calling findPetsByTags.');
148+
throw new RequiredError("PetApi", "findPetsByTags", "tags");
149149
}
150150

151151

@@ -182,7 +182,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
182182

183183
// verify required parameter 'petId' is not null or undefined
184184
if (petId === null || petId === undefined) {
185-
throw new RequiredError('Required parameter petId was null or undefined when calling getPetById.');
185+
throw new RequiredError("PetApi", "getPetById", "petId");
186186
}
187187

188188

@@ -214,7 +214,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
214214

215215
// verify required parameter 'pet' is not null or undefined
216216
if (pet === null || pet === undefined) {
217-
throw new RequiredError('Required parameter pet was null or undefined when calling updatePet.');
217+
throw new RequiredError("PetApi", "updatePet", "pet");
218218
}
219219

220220

@@ -260,7 +260,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
260260

261261
// verify required parameter 'petId' is not null or undefined
262262
if (petId === null || petId === undefined) {
263-
throw new RequiredError('Required parameter petId was null or undefined when calling updatePetWithForm.');
263+
throw new RequiredError("PetApi", "updatePetWithForm", "petId");
264264
}
265265

266266

@@ -325,7 +325,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
325325

326326
// verify required parameter 'petId' is not null or undefined
327327
if (petId === null || petId === undefined) {
328-
throw new RequiredError('Required parameter petId was null or undefined when calling uploadFile.');
328+
throw new RequiredError("PetApi", "uploadFile", "petId");
329329
}
330330

331331

‎samples/openapi3/client/petstore/typescript/builds/default/apis/StoreApi.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export class StoreApiRequestFactory extends BaseAPIRequestFactory {
2626

2727
// verify required parameter 'orderId' is not null or undefined
2828
if (orderId === null || orderId === undefined) {
29-
throw new RequiredError('Required parameter orderId was null or undefined when calling deleteOrder.');
29+
throw new RequiredError("StoreApi", "deleteOrder", "orderId");
3030
}
3131

3232

@@ -78,7 +78,7 @@ export class StoreApiRequestFactory extends BaseAPIRequestFactory {
7878

7979
// verify required parameter 'orderId' is not null or undefined
8080
if (orderId === null || orderId === undefined) {
81-
throw new RequiredError('Required parameter orderId was null or undefined when calling getOrderById.');
81+
throw new RequiredError("StoreApi", "getOrderById", "orderId");
8282
}
8383

8484

@@ -104,7 +104,7 @@ export class StoreApiRequestFactory extends BaseAPIRequestFactory {
104104

105105
// verify required parameter 'order' is not null or undefined
106106
if (order === null || order === undefined) {
107-
throw new RequiredError('Required parameter order was null or undefined when calling placeOrder.');
107+
throw new RequiredError("StoreApi", "placeOrder", "order");
108108
}
109109

110110

‎samples/openapi3/client/petstore/typescript/builds/default/apis/UserApi.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
2626

2727
// verify required parameter 'user' is not null or undefined
2828
if (user === null || user === undefined) {
29-
throw new RequiredError('Required parameter user was null or undefined when calling createUser.');
29+
throw new RequiredError("UserApi", "createUser", "user");
3030
}
3131

3232

@@ -68,7 +68,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
6868

6969
// verify required parameter 'user' is not null or undefined
7070
if (user === null || user === undefined) {
71-
throw new RequiredError('Required parameter user was null or undefined when calling createUsersWithArrayInput.');
71+
throw new RequiredError("UserApi", "createUsersWithArrayInput", "user");
7272
}
7373

7474

@@ -110,7 +110,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
110110

111111
// verify required parameter 'user' is not null or undefined
112112
if (user === null || user === undefined) {
113-
throw new RequiredError('Required parameter user was null or undefined when calling createUsersWithListInput.');
113+
throw new RequiredError("UserApi", "createUsersWithListInput", "user");
114114
}
115115

116116

@@ -153,7 +153,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
153153

154154
// verify required parameter 'username' is not null or undefined
155155
if (username === null || username === undefined) {
156-
throw new RequiredError('Required parameter username was null or undefined when calling deleteUser.');
156+
throw new RequiredError("UserApi", "deleteUser", "username");
157157
}
158158

159159

@@ -185,7 +185,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
185185

186186
// verify required parameter 'username' is not null or undefined
187187
if (username === null || username === undefined) {
188-
throw new RequiredError('Required parameter username was null or undefined when calling getUserByName.');
188+
throw new RequiredError("UserApi", "getUserByName", "username");
189189
}
190190

191191

@@ -212,13 +212,13 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
212212

213213
// verify required parameter 'username' is not null or undefined
214214
if (username === null || username === undefined) {
215-
throw new RequiredError('Required parameter username was null or undefined when calling loginUser.');
215+
throw new RequiredError("UserApi", "loginUser", "username");
216216
}
217217

218218

219219
// verify required parameter 'password' is not null or undefined
220220
if (password === null || password === undefined) {
221-
throw new RequiredError('Required parameter password was null or undefined when calling loginUser.');
221+
throw new RequiredError("UserApi", "loginUser", "password");
222222
}
223223

224224

@@ -279,13 +279,13 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
279279

280280
// verify required parameter 'username' is not null or undefined
281281
if (username === null || username === undefined) {
282-
throw new RequiredError('Required parameter username was null or undefined when calling updateUser.');
282+
throw new RequiredError("UserApi", "updateUser", "username");
283283
}
284284

285285

286286
// verify required parameter 'user' is not null or undefined
287287
if (user === null || user === undefined) {
288-
throw new RequiredError('Required parameter user was null or undefined when calling updateUser.');
288+
throw new RequiredError("UserApi", "updateUser", "user");
289289
}
290290

291291

‎samples/openapi3/client/petstore/typescript/builds/default/apis/baseapi.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export class BaseAPIRequestFactory {
3131
*/
3232
export class RequiredError extends Error {
3333
name: "RequiredError" = "RequiredError";
34-
constructor(public field: string, msg?: string) {
35-
super(msg);
34+
constructor(public api: string, public method: string, public field: string) {
35+
super("Required parameter " + field + " was null or undefined when calling " + api + "." + method + ".");
3636
}
3737
}

‎samples/openapi3/client/petstore/typescript/builds/deno/apis/PetApi.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
2424

2525
// verify required parameter 'pet' is not null or undefined
2626
if (pet === null || pet === undefined) {
27-
throw new RequiredError('Required parameter pet was null or undefined when calling addPet.');
27+
throw new RequiredError("PetApi", "addPet", "pet");
2828
}
2929

3030

@@ -69,7 +69,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
6969

7070
// verify required parameter 'petId' is not null or undefined
7171
if (petId === null || petId === undefined) {
72-
throw new RequiredError('Required parameter petId was null or undefined when calling deletePet.');
72+
throw new RequiredError("PetApi", "deletePet", "petId");
7373
}
7474

7575

@@ -106,7 +106,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
106106

107107
// verify required parameter 'status' is not null or undefined
108108
if (status === null || status === undefined) {
109-
throw new RequiredError('Required parameter status was null or undefined when calling findPetsByStatus.');
109+
throw new RequiredError("PetApi", "findPetsByStatus", "status");
110110
}
111111

112112

@@ -143,7 +143,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
143143

144144
// verify required parameter 'tags' is not null or undefined
145145
if (tags === null || tags === undefined) {
146-
throw new RequiredError('Required parameter tags was null or undefined when calling findPetsByTags.');
146+
throw new RequiredError("PetApi", "findPetsByTags", "tags");
147147
}
148148

149149

@@ -180,7 +180,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
180180

181181
// verify required parameter 'petId' is not null or undefined
182182
if (petId === null || petId === undefined) {
183-
throw new RequiredError('Required parameter petId was null or undefined when calling getPetById.');
183+
throw new RequiredError("PetApi", "getPetById", "petId");
184184
}
185185

186186

@@ -212,7 +212,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
212212

213213
// verify required parameter 'pet' is not null or undefined
214214
if (pet === null || pet === undefined) {
215-
throw new RequiredError('Required parameter pet was null or undefined when calling updatePet.');
215+
throw new RequiredError("PetApi", "updatePet", "pet");
216216
}
217217

218218

@@ -258,7 +258,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
258258

259259
// verify required parameter 'petId' is not null or undefined
260260
if (petId === null || petId === undefined) {
261-
throw new RequiredError('Required parameter petId was null or undefined when calling updatePetWithForm.');
261+
throw new RequiredError("PetApi", "updatePetWithForm", "petId");
262262
}
263263

264264

@@ -323,7 +323,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory {
323323

324324
// verify required parameter 'petId' is not null or undefined
325325
if (petId === null || petId === undefined) {
326-
throw new RequiredError('Required parameter petId was null or undefined when calling uploadFile.');
326+
throw new RequiredError("PetApi", "uploadFile", "petId");
327327
}
328328

329329

‎samples/openapi3/client/petstore/typescript/builds/deno/apis/StoreApi.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export class StoreApiRequestFactory extends BaseAPIRequestFactory {
2424

2525
// verify required parameter 'orderId' is not null or undefined
2626
if (orderId === null || orderId === undefined) {
27-
throw new RequiredError('Required parameter orderId was null or undefined when calling deleteOrder.');
27+
throw new RequiredError("StoreApi", "deleteOrder", "orderId");
2828
}
2929

3030

@@ -76,7 +76,7 @@ export class StoreApiRequestFactory extends BaseAPIRequestFactory {
7676

7777
// verify required parameter 'orderId' is not null or undefined
7878
if (orderId === null || orderId === undefined) {
79-
throw new RequiredError('Required parameter orderId was null or undefined when calling getOrderById.');
79+
throw new RequiredError("StoreApi", "getOrderById", "orderId");
8080
}
8181

8282

@@ -102,7 +102,7 @@ export class StoreApiRequestFactory extends BaseAPIRequestFactory {
102102

103103
// verify required parameter 'order' is not null or undefined
104104
if (order === null || order === undefined) {
105-
throw new RequiredError('Required parameter order was null or undefined when calling placeOrder.');
105+
throw new RequiredError("StoreApi", "placeOrder", "order");
106106
}
107107

108108

‎samples/openapi3/client/petstore/typescript/builds/deno/apis/UserApi.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
2424

2525
// verify required parameter 'user' is not null or undefined
2626
if (user === null || user === undefined) {
27-
throw new RequiredError('Required parameter user was null or undefined when calling createUser.');
27+
throw new RequiredError("UserApi", "createUser", "user");
2828
}
2929

3030

@@ -66,7 +66,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
6666

6767
// verify required parameter 'user' is not null or undefined
6868
if (user === null || user === undefined) {
69-
throw new RequiredError('Required parameter user was null or undefined when calling createUsersWithArrayInput.');
69+
throw new RequiredError("UserApi", "createUsersWithArrayInput", "user");
7070
}
7171

7272

@@ -108,7 +108,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
108108

109109
// verify required parameter 'user' is not null or undefined
110110
if (user === null || user === undefined) {
111-
throw new RequiredError('Required parameter user was null or undefined when calling createUsersWithListInput.');
111+
throw new RequiredError("UserApi", "createUsersWithListInput", "user");
112112
}
113113

114114

@@ -151,7 +151,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
151151

152152
// verify required parameter 'username' is not null or undefined
153153
if (username === null || username === undefined) {
154-
throw new RequiredError('Required parameter username was null or undefined when calling deleteUser.');
154+
throw new RequiredError("UserApi", "deleteUser", "username");
155155
}
156156

157157

@@ -183,7 +183,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
183183

184184
// verify required parameter 'username' is not null or undefined
185185
if (username === null || username === undefined) {
186-
throw new RequiredError('Required parameter username was null or undefined when calling getUserByName.');
186+
throw new RequiredError("UserApi", "getUserByName", "username");
187187
}
188188

189189

@@ -210,13 +210,13 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
210210

211211
// verify required parameter 'username' is not null or undefined
212212
if (username === null || username === undefined) {
213-
throw new RequiredError('Required parameter username was null or undefined when calling loginUser.');
213+
throw new RequiredError("UserApi", "loginUser", "username");
214214
}
215215

216216

217217
// verify required parameter 'password' is not null or undefined
218218
if (password === null || password === undefined) {
219-
throw new RequiredError('Required parameter password was null or undefined when calling loginUser.');
219+
throw new RequiredError("UserApi", "loginUser", "password");
220220
}
221221

222222

@@ -277,13 +277,13 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory {
277277

278278
// verify required parameter 'username' is not null or undefined
279279
if (username === null || username === undefined) {
280-
throw new RequiredError('Required parameter username was null or undefined when calling updateUser.');
280+
throw new RequiredError("UserApi", "updateUser", "username");
281281
}
282282

283283

284284
// verify required parameter 'user' is not null or undefined
285285
if (user === null || user === undefined) {
286-
throw new RequiredError('Required parameter user was null or undefined when calling updateUser.');
286+
throw new RequiredError("UserApi", "updateUser", "user");
287287
}
288288

289289

0 commit comments

Comments
 (0)