feat(specs): add user profile computation & amend existing user profile endpoints [PRED-3876] (#4944)

Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
Co-authored-by: Raed <raed.chammam@algolia.com>

Author: 3 people

specs/common/responses/Accepted.yml

@@ -0,0 +1,19 @@
+description: Accepted.
+content:
+  application/json:
+    schema:
+      title: acceptedResponse
+      type: object
+      additionalProperties: false
+      required:
+        - status
+        - message
+      properties:
+        status:
+          type: integer
+          example: 202
+          description: Status code.
+        message:
+          type: string
+          example: Accepted
+          description: Response message.

specs/common/responses/Conflict.yml

@@ -0,0 +1,19 @@
+description: Conflict.
+content:
+  application/json:
+    schema:
+      title: conflictResponse
+      type: object
+      additionalProperties: false
+      required:
+        - status
+        - message
+      properties:
+        status:
+          type: integer
+          example: 409
+          description: Status code.
+        message:
+          type: string
+          example: Conflict
+          description: Response message.

specs/common/responses/TooManyRequests.yml

@@ -0,0 +1,19 @@
+description: Too Many Requests.
+content:
+  application/json:
+    schema:
+      title: tooManyRequestsResponse
+      type: object
+      additionalProperties: false
+      required:
+        - status
+        - message
+      properties:
+        status:
+          type: integer
+          example: 421
+          description: Status code.
+        message:
+          type: string
+          example: Too Many Requests
+          description: Response message.

specs/realtime-personalization/common/enums.yml

@@ -2,5 +2,6 @@ strategy:
   type: string
   enum:
     - session
+    - historical
     - hybrid
   example: 'session'

specs/realtime-personalization/paths/computeUser.yml

@@ -0,0 +1,25 @@
+post:
+  tags:
+    - users
+  operationId: computeUser
+  x-acl:
+    - recommendation
+  summary: Compute the user's personalization profile
+  description: Sends a request to compute the user's personalization profile.
+  parameters:
+    - $ref: '../common/parameters.yml#/UserToken'
+  responses:
+    '202':
+      $ref: '../../common/responses/Accepted.yml'
+    '400':
+      $ref: '../../common/responses/BadRequest.yml'
+    '402':
+      $ref: '../../common/responses/FeatureNotEnabled.yml'
+    '409':
+      $ref: '../../common/responses/Conflict.yml'
+    '421':
+      $ref: '../../common/responses/TooManyRequests.yml'
+    '422':
+      $ref: '../../common/responses/StatusUnprocessableEntity.yml'
+    '500':
+      $ref: '../../common/responses/InternalError.yml'

specs/realtime-personalization/paths/getUser.yml

@@ -19,7 +19,7 @@ get:
       $ref: '../../common/responses/BadRequest.yml'
     '402':
       $ref: '../../common/responses/FeatureNotEnabled.yml'
-    '403':
-      $ref: '../../common/responses/MethodNotAllowed.yml'
-    '404':
-      $ref: '../../common/responses/IndexNotFound.yml'
+    '421':
+      $ref: '../../common/responses/TooManyRequests.yml'
+    '500':
+      $ref: '../../common/responses/InternalError.yml'

specs/realtime-personalization/spec.yml

@@ -49,3 +49,6 @@ paths:
 
   /2/realtime/users/{userToken}:
     $ref: 'paths/getUser.yml'
+
+  /2/realtime/users/{userToken}/compute:
+    $ref: 'paths/computeUser.yml'