Skip to content

Commit d1cd340

Browse files
Merge pull request #175 from hmrc/DLS-6064_4
DLS-6064_4 include description on error response model
2 parents d11f381 + 0d9772d commit d1cd340

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

resources/public/api/conf/2.0/application.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -577,10 +577,15 @@ components:
577577
title: errorResponse
578578
required:
579579
- code
580+
- message
580581
type: object
581582
properties:
582583
code:
583584
type: string
585+
description: The error code
586+
message:
587+
type: string
588+
description: The error message
584589
BankDetails:
585590
title: BankDetails
586591
required:
@@ -801,8 +806,10 @@ components:
801806
properties:
802807
code:
803808
type: string
809+
description: FORBIDDEN
804810
message:
805811
type: string
812+
description: Missing NINO
806813
IndividualsHelpToSaveAccountResponse404:
807814
title: IndividualsHelpToSaveAccountResponse404
808815
required:
@@ -812,8 +819,10 @@ components:
812819
properties:
813820
code:
814821
type: string
822+
description: NOT FOUND
815823
message:
816824
type: string
825+
description: Account doesn't exist
817826
IndividualsHelpToSaveAccountResponse400:
818827
title: IndividualsHelpToSaveAccountResponse400
819828
required:
@@ -823,8 +832,10 @@ components:
823832
properties:
824833
code:
825834
type: string
835+
description: BAD_NINO
826836
message:
827837
type: string
838+
description: NINO doesn't match the expected regex
828839
IndividualsHelpToSaveAccountResponse409:
829840
title: IndividualsHelpToSaveAccountResponse409
830841
required:
@@ -834,8 +845,10 @@ components:
834845
properties:
835846
code:
836847
type: string
848+
description: ACCOUNT_ALREADY_EXISTS
837849
message:
838850
type: string
851+
description: Account create request received for account that already exists
839852
IndividualsHelpToSaveEligibilitySuccessResponse:
840853
title: IndividualsHelpToSaveEligibilitySuccessResponse
841854
required:

0 commit comments

Comments
 (0)