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

Co-authored-by: Ben Greenbank <[email protected]>

Author: algolia-bot

docs/bundled/advanced-personalization.yml

@@ -265,8 +265,6 @@ paths:
                 $ref: '#/components/schemas/configurationObject'
         '401':
           $ref: '#/components/responses/Unauthorized'
-        '404':
-          $ref: '#/components/responses/ConfigurationNotFound'
         '500':
           $ref: '#/components/responses/InternalServerError'
     put:
@@ -399,10 +397,10 @@ paths:
                     type: string
                 required:
                   - users
-        '400':
-          $ref: '#/components/responses/BadRequest-2'
         '401':
           $ref: '#/components/responses/Unauthorized'
+        '422':
+          $ref: '#/components/responses/GenericUnprocessableEntity'
         '500':
           $ref: '#/components/responses/InternalServerError'
   /2/users/{userID}:
@@ -426,11 +424,11 @@ paths:
               schema:
                 $ref: '#/components/schemas/user'
         '400':
-          $ref: '#/components/responses/BadRequest-2'
+          $ref: '#/components/responses/BadUserID'
         '401':
           $ref: '#/components/responses/Unauthorized'
         '404':
-          $ref: '#/components/responses/UserNotFound'
+          $ref: '#/components/responses/GenericNotFound'
         '422':
           $ref: '#/components/responses/InvalidUserID'
         '500':
@@ -467,11 +465,9 @@ paths:
                   deletedAt:
                     type: string
         '400':
-          $ref: '#/components/responses/BadRequest-2'
+          $ref: '#/components/responses/BadUserID'
         '401':
           $ref: '#/components/responses/Unauthorized'
-        '404':
-          $ref: '#/components/responses/UserNotFound'
         '422':
           $ref: '#/components/responses/InvalidUserID'
         '500':
@@ -736,6 +732,8 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/errorCodes'
+        lastUpdatedAt:
+          type: string
     configurationObject:
       type: object
       properties:
@@ -787,15 +785,57 @@ components:
         - personalzationReRanking
         - profileType
         - status
-    BaseResponse:
+    unauthorized:
+      type: integer
+      description: HTTP status code for an authorization error.
+      enum:
+        - 401
+    ErrorMessages_unauthorized:
+      type: string
+      description: Details about the response, such as error messages.
+      enum:
+        - Unauthorized
+    ErrorResponses_unauthorized:
       type: object
       properties:
         status:
-          type: integer
-          description: HTTP status code.
+          $ref: '#/components/schemas/unauthorized'
         message:
-          type: string
-          description: Details about the response, such as error messages.
+          $ref: '#/components/schemas/ErrorMessages_unauthorized'
+    internalServerError:
+      type: integer
+      description: HTTP status code for an internal server error.
+      enum:
+        - 500
+    ErrorMessages_internalServerError:
+      type: string
+      description: Details about the response, such as error messages.
+      enum:
+        - Internal Server Error
+    ErrorResponses_internalServerError:
+      type: object
+      properties:
+        status:
+          $ref: '#/components/schemas/internalServerError'
+        message:
+          $ref: '#/components/schemas/ErrorMessages_internalServerError'
+    badRequest:
+      type: integer
+      description: HTTP status code for a bad request error.
+      enum:
+        - 400
+    ErrorMessages_badRequest:
+      type: string
+      description: Details about the response, such as error messages.
+      enum:
+        - Invalid request body
+    ErrorResponses_badRequest:
+      type: object
+      properties:
+        status:
+          $ref: '#/components/schemas/badRequest'
+        message:
+          $ref: '#/components/schemas/ErrorMessages_badRequest'
     user:
       type: object
       properties:
@@ -834,6 +874,70 @@ components:
         - userID
         - affinities
         - lastUpdatedAt
+    unprocessableEntity:
+      type: integer
+      description: HTTP status code for an unprocessable entity error.
+      enum:
+        - 422
+    genericUnprocessableEntity:
+      type: string
+      description: Details about the response, such as error messages.
+      enum:
+        - Unprocessable Entity
+    ErrorResponses_genericUnprocessableEntity:
+      type: object
+      properties:
+        status:
+          $ref: '#/components/schemas/unprocessableEntity'
+        message:
+          $ref: '#/components/schemas/genericUnprocessableEntity'
+    badUserID:
+      type: string
+      description: Details about the response, such as error messages.
+      enum:
+        - Invalid userID format
+    ErrorResponses_badUserID:
+      type: object
+      properties:
+        status:
+          $ref: '#/components/schemas/badRequest'
+        message:
+          $ref: '#/components/schemas/badUserID'
+    notFound:
+      type: integer
+      description: HTTP status code for a not found error.
+      enum:
+        - 404
+    genericNotFound:
+      type: string
+      description: Details about the response, such as error messages.
+      enum:
+        - Not Found
+    ErrorResponses_genericNotFound:
+      type: object
+      properties:
+        status:
+          $ref: '#/components/schemas/notFound'
+        message:
+          $ref: '#/components/schemas/genericNotFound'
+    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
+    ErrorResponses_invalidUserID:
+      type: object
+      properties:
+        status:
+          $ref: '#/components/schemas/unprocessableEntity'
+        message:
+          $ref: '#/components/schemas/invalidUserID'
   responses:
     BadRequest:
       description: Bad request or request arguments.
@@ -864,37 +968,43 @@ components:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/BaseResponse'
-    ConfigurationNotFound:
-      description: Configuration not found.
-      content:
-        application/json:
-          schema:
-            $ref: '#/components/schemas/BaseResponse'
+            $ref: '#/components/schemas/ErrorResponses_unauthorized'
     InternalServerError:
       description: Internal server error.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/BaseResponse'
+            $ref: '#/components/schemas/ErrorResponses_internalServerError'
     BadRequest-2:
       description: Bad request.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/BaseResponse'
-    UserNotFound:
-      description: User not found.
+            $ref: '#/components/schemas/ErrorResponses_badRequest'
+    GenericUnprocessableEntity:
+      description: Unprocessable entity.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/ErrorResponses_genericUnprocessableEntity'
+    BadUserID:
+      description: Bad user ID.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/ErrorResponses_badUserID'
+    GenericNotFound:
+      description: Not found.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/BaseResponse'
+            $ref: '#/components/schemas/ErrorResponses_genericNotFound'
     InvalidUserID:
       description: Invalid user ID format.
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/BaseResponse'
+            $ref: '#/components/schemas/ErrorResponses_invalidUserID'
 x-tagGroups:
   - name: Advanced Personalization
     tags:

specs/advanced-personalization/common/responses/BadRequest.yml

@@ -3,4 +3,3 @@ content:
   application/json:
     schema:
       $ref: '../schemas/ErrorResponses.yml#/badRequest'
-

specs/advanced-personalization/common/schemas/ErrorMessages.yml

@@ -32,5 +32,3 @@ internalServerError:
   type: string
   description: Details about the response, such as error messages.
   enum: [Internal Server Error]
-
-

specs/advanced-personalization/common/schemas/ErrorResponses.yml

@@ -12,7 +12,7 @@ badUserID:
     status:
       $ref: './ErrorCodes.yml#/badRequest'
     message:
-       $ref: './ErrorMessages.yml#/badUserID'
+      $ref: './ErrorMessages.yml#/badUserID'
 
 unauthorized:
   type: object