feat(specs): add recommend batch rules endpoint

Author: raed667

specs/common/schemas/Rule.yml

@@ -6,3 +6,17 @@ context:
     For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`.
     A rule context must only contain alphanumeric characters.
   example: mobile
+
+timeRange:
+  type: object
+  additionalProperties: false
+  properties:
+    from:
+      type: integer
+      description: When the rule should start to be active, in Unix epoch time.
+    until:
+      type: integer
+      description: When the rule should stop to be active, in Unix epoch time.
+  required:
+    - from
+    - until

specs/recommend/common/schemas/RecommendRule.yml

@@ -19,11 +19,16 @@ RecommendRule:
     description:
       type: string
       description: Description of the rule's purpose. This can be helpful for display in the Algolia dashboard.
-      example: 'Display a promotional banner'
+      example: 'Boost on-sale items'
     enabled:
       type: boolean
       default: true
       description: Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time.
+    validity:
+      type: array
+      description: Time periods when the rule is active.
+      items:
+        $ref: '../../../common/schemas/Rule.yml#/timeRange'
 
 Condition:
   type: object

specs/recommend/paths/batchRecommendRules.yml

@@ -0,0 +1,41 @@
+post:
+  tags:
+    - rules
+  operationId: batchRecommendRules
+  x-use-read-transporter: false
+  x-cacheable: false
+  x-acl:
+    - editSettings
+  summary: Create or update a batch of Recommend Rules
+  description: |
+    Create or update a batch of Recommend Rules
+
+    Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectID` already exists.
+    You may also specify `true` for `clearExistingRules`, in which case the batch will atomically replace all the existing Recommend Rules.
+
+    Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a [source item](/doc/guides/algolia-recommend/overview/#recommend-models) instead of a query. The main differences are the following:
+    - Conditions `pattern` and `anchoring` are unavailable.
+    - Condition `filters` triggers if the source item matches the specified filters.
+    - Condition `filters` accepts numeric filters.
+    - Consequence `params` only covers filtering parameters.
+    - Consequence `automaticFacetFilters` doesn't require a facet value placeholder (it tries to match the data source item's attributes instead).
+  parameters:
+    - $ref: '../../common/parameters.yml#/IndexName'
+    - $ref: '../common/parameters.yml#/Models'
+  requestBody:
+    content:
+      application/json:
+        schema:
+          title: rules
+          type: array
+          # required: true
+          description: Recommend rules.
+          additionalProperties: false
+          items:
+            $ref: '../common/schemas/RecommendRule.yml'
+
+  responses:
+    '200':
+      $ref: '../../common/responses/UpdatedAt.yml'
+    '400':
+      $ref: '../../common/responses/BadRequest.yml'

specs/recommend/spec.yml

@@ -131,6 +131,9 @@ paths:
 
   /1/indexes/{indexName}/{model}/recommend/rules/search:
     $ref: 'paths/searchRecommendRules.yml'
+  
+  /1/indexes/{indexName}/{model}/recommend/rules/batch:
+    $ref: 'paths/batchRecommendRules.yml'
 
   # ###############
   # ### Helpers ###

specs/search/paths/rules/common/schemas.yml

@@ -30,7 +30,7 @@ rule:
       type: array
       description: Time periods when the rule is active.
       items:
-        $ref: '#/timeRange'
+        $ref: '../../../../common/schemas/Rule.yml#/timeRange'
   required:
     - objectID
 
@@ -289,20 +289,6 @@ automaticFacetFilter:
   required:
     - facet
 
-timeRange:
-  type: object
-  additionalProperties: false
-  properties:
-    from:
-      type: integer
-      description: When the rule should start to be active, in Unix epoch time.
-    until:
-      type: integer
-      description: When the rule should stop to be active, in Unix epoch time.
-  required:
-    - from
-    - until
-
 updatedRuleResponse:
   type: object
   additionalProperties: false