Skip to content

Commit 60ca881

Browse files
KaveeshaPiuminiKaveeshaPiumini
authored
Merge pull request #2469 from KaveeshaPiumini/i18n-service-errors
Refactor error message structure to use I18nMessage schema for improved internationalization support
2 parents fbd9a12 + 057f867 commit 60ca881

17 files changed

Lines changed: 5074 additions & 1573 deletions

‎api/application.yaml‎

Lines changed: 105 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,12 @@ paths:
6767
summary: Invalid limit parameter
6868
value:
6969
code: "APP-1001"
70-
message: "Invalid pagination parameter"
71-
description: "The limit parameter must be a positive integer"
70+
message:
71+
key: "error.applicationservice.invalid_limit_parameter"
72+
defaultValue: "Invalid pagination parameter"
73+
description:
74+
key: "error.applicationservice.invalid_limit_parameter_description"
75+
defaultValue: "The limit parameter must be a positive integer"
7276
"500":
7377
description: Internal server error
7478
content:
@@ -77,8 +81,12 @@ paths:
7781
$ref: '#/components/schemas/Error'
7882
example:
7983
code: "APP-5001"
80-
message: "Internal server error"
81-
description: "An unexpected error occurred while processing the request"
84+
message:
85+
key: "error.internal_server_error"
86+
defaultValue: "Internal server error"
87+
description:
88+
key: "error.internal_server_error_description"
89+
defaultValue: "An unexpected error occurred while processing the request"
8290

8391
post:
8492
tags:
@@ -226,20 +234,32 @@ paths:
226234
summary: Invalid request format
227235
value:
228236
code: "APP-1001"
229-
message: "Invalid request format"
230-
description: "The request body is malformed or contains invalid data"
237+
message:
238+
key: "error.applicationservice.invalid_request_format"
239+
defaultValue: "Invalid request format"
240+
description:
241+
key: "error.applicationservice.invalid_request_format_description"
242+
defaultValue: "The request body is malformed or contains invalid data"
231243
invalid-redirect-uri:
232244
summary: Invalid redirect URI
233245
value:
234246
code: "APP-1002"
235-
message: "Invalid redirect URI"
236-
description: "One or more redirect URIs are not valid"
247+
message:
248+
key: "error.applicationservice.invalid_redirect_uri"
249+
defaultValue: "Invalid redirect URI"
250+
description:
251+
key: "error.applicationservice.invalid_redirect_uri_description"
252+
defaultValue: "One or more redirect URIs are not valid"
237253
invalid-grant-type:
238254
summary: Invalid grant type
239255
value:
240256
code: "APP-1003"
241-
message: "Invalid grant type"
242-
description: "One or more grant types are not supported"
257+
message:
258+
key: "error.applicationservice.invalid_grant_type"
259+
defaultValue: "Invalid grant type"
260+
description:
261+
key: "error.applicationservice.invalid_grant_type_description"
262+
defaultValue: "One or more grant types are not supported"
243263
"500":
244264
description: Internal server error
245265
content:
@@ -248,8 +268,12 @@ paths:
248268
$ref: '#/components/schemas/Error'
249269
example:
250270
code: "APP-5001"
251-
message: "Internal server error"
252-
description: "An unexpected error occurred while processing the request"
271+
message:
272+
key: "error.internal_server_error"
273+
defaultValue: "Internal server error"
274+
description:
275+
key: "error.internal_server_error_description"
276+
defaultValue: "An unexpected error occurred while processing the request"
253277

254278
/applications/{id}:
255279
get:
@@ -340,8 +364,12 @@ paths:
340364
$ref: '#/components/schemas/Error'
341365
example:
342366
code: "APP-1001"
343-
message: "Invalid request format"
344-
description: "The request contains invalid data"
367+
message:
368+
key: "error.applicationservice.invalid_request_format"
369+
defaultValue: "Invalid request format"
370+
description:
371+
key: "error.applicationservice.invalid_request_format_description"
372+
defaultValue: "The request contains invalid data"
345373
"404":
346374
description: Application not found
347375
content:
@@ -350,8 +378,12 @@ paths:
350378
$ref: '#/components/schemas/Error'
351379
example:
352380
code: "APP-1004"
353-
message: "Application not found"
354-
description: "The application with the specified ID does not exist"
381+
message:
382+
key: "error.applicationservice.application_not_found"
383+
defaultValue: "Application not found"
384+
description:
385+
key: "error.applicationservice.application_not_found_description"
386+
defaultValue: "The application with the specified ID does not exist"
355387
"500":
356388
description: Internal server error
357389
content:
@@ -360,8 +392,12 @@ paths:
360392
$ref: '#/components/schemas/Error'
361393
example:
362394
code: "APP-5001"
363-
message: "Internal server error"
364-
description: "An unexpected error occurred while processing the request"
395+
message:
396+
key: "error.internal_server_error"
397+
defaultValue: "Internal server error"
398+
description:
399+
key: "error.internal_server_error_description"
400+
defaultValue: "An unexpected error occurred while processing the request"
365401

366402
put:
367403
tags:
@@ -521,14 +557,22 @@ paths:
521557
summary: Invalid request format
522558
value:
523559
code: "APP-1001"
524-
message: "Invalid request format"
525-
description: "The request body is malformed or contains invalid data"
560+
message:
561+
key: "error.applicationservice.invalid_request_format"
562+
defaultValue: "Invalid request format"
563+
description:
564+
key: "error.applicationservice.invalid_request_format_description"
565+
defaultValue: "The request body is malformed or contains invalid data"
526566
invalid-redirect-uri:
527567
summary: Invalid redirect URI
528568
value:
529569
code: "APP-1002"
530-
message: "Invalid redirect URI"
531-
description: "One or more redirect URIs are not valid"
570+
message:
571+
key: "error.applicationservice.invalid_redirect_uri"
572+
defaultValue: "Invalid redirect URI"
573+
description:
574+
key: "error.applicationservice.invalid_redirect_uri_description"
575+
defaultValue: "One or more redirect URIs are not valid"
532576
"404":
533577
description: Application not found
534578
content:
@@ -537,8 +581,12 @@ paths:
537581
$ref: '#/components/schemas/Error'
538582
example:
539583
code: "APP-1004"
540-
message: "Application not found"
541-
description: "The application with the specified ID does not exist"
584+
message:
585+
key: "error.applicationservice.application_not_found"
586+
defaultValue: "Application not found"
587+
description:
588+
key: "error.applicationservice.application_not_found_description"
589+
defaultValue: "The application with the specified ID does not exist"
542590
"500":
543591
description: Internal server error
544592
content:
@@ -547,8 +595,12 @@ paths:
547595
$ref: '#/components/schemas/Error'
548596
example:
549597
code: "APP-5001"
550-
message: "Internal server error"
551-
description: "An unexpected error occurred while processing the request"
598+
message:
599+
key: "error.internal_server_error"
600+
defaultValue: "Internal server error"
601+
description:
602+
key: "error.internal_server_error_description"
603+
defaultValue: "An unexpected error occurred while processing the request"
552604

553605
delete:
554606
tags:
@@ -575,8 +627,12 @@ paths:
575627
$ref: '#/components/schemas/Error'
576628
example:
577629
code: "APP-1001"
578-
message: "Invalid request format"
579-
description: "The request contains invalid data"
630+
message:
631+
key: "error.applicationservice.invalid_request_format"
632+
defaultValue: "Invalid request format"
633+
description:
634+
key: "error.applicationservice.invalid_request_format_description"
635+
defaultValue: "The request contains invalid data"
580636
"500":
581637
description: Internal server error
582638
content:
@@ -585,8 +641,12 @@ paths:
585641
$ref: '#/components/schemas/Error'
586642
example:
587643
code: "APP-5001"
588-
message: "Internal server error"
589-
description: "An unexpected error occurred while processing the request"
644+
message:
645+
key: "error.internal_server_error"
646+
defaultValue: "Internal server error"
647+
description:
648+
key: "error.internal_server_error_description"
649+
defaultValue: "An unexpected error occurred while processing the request"
590650

591651
components:
592652
securitySchemes:
@@ -1261,10 +1321,20 @@ components:
12611321
description: The error code.
12621322
example: "APP-1001"
12631323
message:
1264-
type: string
1265-
description: The error message.
1266-
example: "Invalid request format"
1324+
$ref: '#/components/schemas/I18nMessage'
12671325
description:
1326+
$ref: '#/components/schemas/I18nMessage'
1327+
1328+
I18nMessage:
1329+
type: object
1330+
description: Internationalized message with translation key and default value.
1331+
required:
1332+
- key
1333+
- defaultValue
1334+
properties:
1335+
key:
1336+
type: string
1337+
description: Translation key for fetching localized message.
1338+
defaultValue:
12681339
type: string
1269-
description: A detailed description of the error.
1270-
example: "The request body is malformed or contains invalid data"
1340+
description: Default message in English (fallback).

0 commit comments

Comments
 (0)