feat(specs): add new realtime key to config endpoints [PRED-3615] (#4481)

Co-authored-by: Pierre Millot <[email protected]>

Author: bengreenbank

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

@@ -0,0 +1,5 @@
+description: Feature not enabled.
+content:
+  application/json:
+    schema:
+      $ref: '../schemas/ErrorResponses.yml#/featureNotEnabled'

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

@@ -74,3 +74,16 @@ status:
         $ref: '../enums.yml#/errorCodes'
     lastUpdatedAt:
       type: string
+
+features:
+  type: object
+  properties:
+    realtime:
+      $ref: '#/realtime'
+
+realtime:
+  type: object
+  properties:
+    enabled:
+      type: boolean
+      description: Whether the realtime personalization feature is enabled.

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

@@ -38,4 +38,6 @@ configurationObject:
       $ref: './Configuration.yml#/profileType'
     status:
       $ref: './Configuration.yml#/status'
-  required: [indices, personalzationReRanking, profileType, status]
+    features:
+      $ref: './Configuration.yml#/features'
+  required: [indices, personalzationReRanking, profileType, status, features]

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

@@ -8,6 +8,11 @@ unauthorized:
   description: HTTP status code for an authorization error.
   enum: [401]
 
+paymentRequired:
+  type: integer
+  description: HTTP status code for a payment required error.
+  enum: [402]
+
 notFound:
   type: integer
   description: HTTP status code for a not found error.

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

@@ -13,6 +13,13 @@ unauthorized:
   description: Details about the response, such as error messages.
   enum: [Unauthorized]
 
+featureNotEnabled:
+  type: string
+  description: Details about the response, such as error messages.
+  enum:
+    - "Predictive profiles are not allowed for this app. Please contact support to upgrade your plan: https://support.algolia.com/"
+    - "Realtime Personalization is not allowed for this app. Please contact support to upgrade your plan: https://support.algolia.com/"
+
 genericNotFound:
   type: string
   description: Details about the response, such as error messages.

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

@@ -53,3 +53,11 @@ internalServerError:
       $ref: './ErrorCodes.yml#/internalServerError'
     message:
       $ref: './ErrorMessages.yml#/internalServerError'
+
+featureNotEnabled:
+  type: object
+  properties:
+    status:
+      $ref: './ErrorCodes.yml#/paymentRequired'
+    message:
+      $ref: './ErrorMessages.yml#/featureNotEnabled'

specs/advanced-personalization/paths/config.yml

@@ -67,7 +67,9 @@ put:
               $ref: '../common/schemas/Configuration.yml#/personalizationReRanking'
             profileType:
               $ref: '../common/schemas/Configuration.yml#/profileType'
-          required: [indices, personalizationReRanking, profileType]
+            features:
+              $ref: '../common/schemas/Configuration.yml#/features'
+          required: [indices, personalizationReRanking, profileType, features]
   responses:
     '200':
       description: OK
@@ -94,5 +96,7 @@ put:
       $ref: '../common/responses/BadRequest.yml'
     '401':
       $ref: '../common/responses/Unauthorized.yml'
+    '402':
+      $ref: '../common/responses/FeatureNotEnabled.yml'
     '500':
       $ref: '../common/responses/InternalServerError.yml'