feat(specs): detail perso error codes [PRED-3384] (#4413)

bengreenbank · web-flow · commit 00b9ca211573 · 2025-01-29T17:28:34.000+01:00
diff --git a/specs/advanced-personalization/common/responses/BadRequest.yml b/specs/advanced-personalization/common/responses/BadRequest.yml
@@ -2,4 +2,5 @@ description: Bad request.
 content:
   application/json:
     schema:
-      $ref: './BaseResponse.yml'
+      $ref: '../schemas/ErrorResponses.yml#/badRequest'
+
diff --git a/specs/advanced-personalization/common/responses/BadUserID.yml b/specs/advanced-personalization/common/responses/BadUserID.yml
@@ -0,0 +1,5 @@
+description: Bad user ID.
+content:
+  application/json:
+    schema:
+      $ref: '../schemas/ErrorResponses.yml#/badUserID'
diff --git a/specs/advanced-personalization/common/responses/BaseResponse.yml b/specs/advanced-personalization/common/responses/BaseResponse.yml
diff --git a/specs/advanced-personalization/common/responses/ConfigurationNotFound.yml b/specs/advanced-personalization/common/responses/ConfigurationNotFound.yml
diff --git a/specs/advanced-personalization/common/responses/GenericNotFound.yml b/specs/advanced-personalization/common/responses/GenericNotFound.yml
@@ -0,0 +1,5 @@
+description: Not found.
+content:
+  application/json:
+    schema:
+      $ref: '../schemas/ErrorResponses.yml#/genericNotFound'
diff --git a/specs/advanced-personalization/common/responses/GenericUnprocessableEntity.yml b/specs/advanced-personalization/common/responses/GenericUnprocessableEntity.yml
@@ -0,0 +1,5 @@
+description: Unprocessable entity.
+content:
+  application/json:
+    schema:
+      $ref: '../schemas/ErrorResponses.yml#/genericUnprocessableEntity'
diff --git a/specs/advanced-personalization/common/responses/InternalServerError.yml b/specs/advanced-personalization/common/responses/InternalServerError.yml
@@ -2,4 +2,4 @@ description: Internal server error.
 content:
   application/json:
     schema:
-      $ref: './BaseResponse.yml'
+      $ref: '../schemas/ErrorResponses.yml#/internalServerError'
diff --git a/specs/advanced-personalization/common/responses/InvalidUserID.yml b/specs/advanced-personalization/common/responses/InvalidUserID.yml
@@ -2,4 +2,4 @@ description: Invalid user ID format.
 content:
   application/json:
     schema:
-      $ref: './BaseResponse.yml'
+      $ref: '../schemas/ErrorResponses.yml#/invalidUserID'
diff --git a/specs/advanced-personalization/common/responses/Unauthorized.yml b/specs/advanced-personalization/common/responses/Unauthorized.yml
@@ -2,4 +2,4 @@ description: Not authorized to access this resource.
 content:
   application/json:
     schema:
-      $ref: './BaseResponse.yml'
+      $ref: '../schemas/ErrorResponses.yml#/unauthorized'
diff --git a/specs/advanced-personalization/common/responses/UserNotFound.yml b/specs/advanced-personalization/common/responses/UserNotFound.yml
diff --git a/specs/advanced-personalization/common/schemas/Configuration.yml b/specs/advanced-personalization/common/schemas/Configuration.yml
@@ -72,3 +72,5 @@ status:
       type: array
       items:
         $ref: '../enums.yml#/errorCodes'
+    lastUpdatedAt:
+      type: string
diff --git a/specs/advanced-personalization/common/schemas/ErrorCodes.yml b/specs/advanced-personalization/common/schemas/ErrorCodes.yml
@@ -0,0 +1,24 @@
+badRequest:
+  type: integer
+  description: HTTP status code for a bad request error.
+  enum: [400]
+
+unauthorized:
+  type: integer
+  description: HTTP status code for an authorization error.
+  enum: [401]
+
+notFound:
+  type: integer
+  description: HTTP status code for a not found error.
+  enum: [404]
+
+unprocessableEntity:
+  type: integer
+  description: HTTP status code for an unprocessable entity error.
+  enum: [422]
+
+internalServerError:
+  type: integer
+  description: HTTP status code for an internal server error.
+  enum: [500]
diff --git a/specs/advanced-personalization/common/schemas/ErrorMessages.yml b/specs/advanced-personalization/common/schemas/ErrorMessages.yml
@@ -0,0 +1,36 @@
+badRequest:
+  type: string
+  description: Details about the response, such as error messages.
+  enum: [Invalid request body]
+
+badUserID:
+  type: string
+  description: Details about the response, such as error messages.
+  enum: [Invalid userID format]
+
+unauthorized:
+  type: string
+  description: Details about the response, such as error messages.
+  enum: [Unauthorized]
+
+genericNotFound:
+  type: string
+  description: Details about the response, such as error messages.
+  enum: [Not Found]
+
+genericUnprocessableEntity:
+  type: string
+  description: Details about the response, such as error messages.
+  enum: [Unprocessable Entity]
+
+invalidUserID:
+  type: string
+  description: Details about the response, such as error messages.
+  enum: [UserID must contain only alphanumeric, equal, plus, slash, hyphen, or underscore characters, and be between 1 and 129 characters long]
+
+internalServerError:
+  type: string
+  description: Details about the response, such as error messages.
+  enum: [Internal Server Error]
+
+
diff --git a/specs/advanced-personalization/common/schemas/ErrorResponses.yml b/specs/advanced-personalization/common/schemas/ErrorResponses.yml
@@ -0,0 +1,55 @@
+badRequest:
+  type: object
+  properties:
+    status:
+      $ref: './ErrorCodes.yml#/badRequest'
+    message:
+      $ref: './ErrorMessages.yml#/badRequest'
+
+badUserID:
+  type: object
+  properties:
+    status:
+      $ref: './ErrorCodes.yml#/badRequest'
+    message:
+       $ref: './ErrorMessages.yml#/badUserID'
+
+unauthorized:
+  type: object
+  properties:
+    status:
+      $ref: './ErrorCodes.yml#/unauthorized'
+    message:
+      $ref: './ErrorMessages.yml#/unauthorized'
+
+genericNotFound:
+  type: object
+  properties:
+    status:
+      $ref: './ErrorCodes.yml#/notFound'
+    message:
+      $ref: './ErrorMessages.yml#/genericNotFound'
+
+genericUnprocessableEntity:
+  type: object
+  properties:
+    status:
+      $ref: './ErrorCodes.yml#/unprocessableEntity'
+    message:
+      $ref: './ErrorMessages.yml#/genericUnprocessableEntity'
+
+invalidUserID:
+  type: object
+  properties:
+    status:
+      $ref: './ErrorCodes.yml#/unprocessableEntity'
+    message:
+      $ref: './ErrorMessages.yml#/invalidUserID'
+
+internalServerError:
+  type: object
+  properties:
+    status:
+      $ref: './ErrorCodes.yml#/internalServerError'
+    message:
+      $ref: './ErrorMessages.yml#/internalServerError'
diff --git a/specs/advanced-personalization/paths/config.yml b/specs/advanced-personalization/paths/config.yml
@@ -17,8 +17,6 @@ get:
             $ref: '../common/schemas/ConfigurationObject.yml#/configurationObject'
     '401':
       $ref: '../common/responses/Unauthorized.yml'
-    '404':
-      $ref: '../common/responses/ConfigurationNotFound.yml'
     '500':
       $ref: '../common/responses/InternalServerError.yml'
 
diff --git a/specs/advanced-personalization/paths/user.yml b/specs/advanced-personalization/paths/user.yml
@@ -18,11 +18,11 @@ get:
           schema:
             $ref: '../common/schemas/User.yml#/user'
     '400':
-      $ref: '../common/responses/BadRequest.yml'
+      $ref: '../common/responses/BadUserID.yml'
     '401':
       $ref: '../common/responses/Unauthorized.yml'
     '404':
-      $ref: '../common/responses/UserNotFound.yml'
+      $ref: '../common/responses/GenericNotFound.yml'
     '422':
       $ref: '../common/responses/InvalidUserID.yml'
     '500':
@@ -60,11 +60,9 @@ delete:
               deletedAt:
                 type: string
     '400':
-      $ref: '../common/responses/BadRequest.yml'
+      $ref: '../common/responses/BadUserID.yml'
     '401':
       $ref: '../common/responses/Unauthorized.yml'
-    '404':
-      $ref: '../common/responses/UserNotFound.yml'
     '422':
       $ref: '../common/responses/InvalidUserID.yml'
     '500':
diff --git a/specs/advanced-personalization/paths/users.yml b/specs/advanced-personalization/paths/users.yml
@@ -34,9 +34,9 @@ get:
               nextPageToken:
                 type: string
             required: [users]
-    '400':
-      $ref: '../common/responses/BadRequest.yml'
     '401':
       $ref: '../common/responses/Unauthorized.yml'
+    '422':
+      $ref: '../common/responses/GenericUnprocessableEntity.yml'
     '500':
       $ref: '../common/responses/InternalServerError.yml'
