fix(specs): cleanup for composition API clients

specs/composition-full/common/schemas/batchCompositionAction.yml → specs/composition-full/common/schemas/BatchCompositionAction.yml

@@ -10,5 +10,5 @@ deleteCompositionAction:
 
 batchCompositionAction:
   oneOf:
-    - $ref: './listCompositionsResponse.yml#/composition'
+    - $ref: './Composition.yml#/composition'
     - $ref: '#/deleteCompositionAction'

specs/composition-full/common/schemas/Composition.yml

@@ -0,0 +1,20 @@
+composition:
+  type: object
+  additionalProperties: false
+  properties:
+    objectID:
+      $ref: '../../../common/parameters.yml#/objectID'
+    name:
+      type: string
+      description: Composition name.
+      example: 'my lovely crafted composition'
+    description:
+      type: string
+      description: Composition description.
+      example: 'my lovely crafted composition that is used for X purpose'
+    behavior:
+      $ref: './CompositionBehavior.yml#/compositionBehavior'
+  required:
+    - objectID
+    - behavior
+    - name

specs/composition-full/common/schemas/compositionRule.yml → specs/composition-full/common/schemas/CompositionRule.yml

@@ -18,7 +18,7 @@ compositionRule:
       additionalProperties: false
       properties:
         behavior:
-          $ref: './compositionBehavior.yml#/compositionBehavior'
+          $ref: './CompositionBehavior.yml#/compositionBehavior'
       required:
         - behavior
     description:
@@ -54,10 +54,6 @@ condition:
       example: '{facet:genre}'
     anchoring:
       $ref: '#/anchoring'
-    alternatives:
-      type: boolean
-      description: Whether the pattern should match plurals, synonyms, and typos.
-      default: false
     context:
       $ref: '../../../common/schemas/Rule.yml#/context'
     filters:

specs/composition-full/common/schemas/listCompositionsResponse.yml → specs/composition-full/common/schemas/ListCompositionsResponse.yml

@@ -6,7 +6,7 @@ listCompositionsResponse:
       type: array
       description: All compositions in your Algolia application.
       items:
-        $ref: '#/composition'
+        $ref: './Composition.yml#/composition'
     nbPages:
       type: integer
       description: Number of pages.
@@ -29,24 +29,3 @@ listCompositionsResponse:
     - nbHits
     - nbPages
     - page
-
-composition:
-  type: object
-  additionalProperties: false
-  properties:
-    objectID:
-      $ref: '../../../common/parameters.yml#/objectID'
-    name:
-      type: string
-      description: Composition name.
-      example: 'my lovely crafted composition'
-    description:
-      type: string
-      description: Composition description.
-      example: 'my lovely crafted composition that is used for X purpose'
-    behavior:
-      $ref: './compositionBehavior.yml#/compositionBehavior'
-  required:
-    - objectID
-    - behavior
-    - name

specs/composition-full/common/schemas/rulesBatchCompositionAction.yml → specs/composition-full/common/schemas/RulesBatchCompositionAction.yml

@@ -10,5 +10,5 @@ deleteCompositionRuleAction:
 
 rulesBatchCompositionAction:
   oneOf:
-    - $ref: './compositionRule.yml#/compositionRule'
+    - $ref: './CompositionRule.yml#/compositionRule'
     - $ref: '#/deleteCompositionRuleAction'

specs/composition-full/common/schemas/SearchParams.yml

@@ -240,7 +240,7 @@ mainInjectionQueryParameters:
       type: array
       items:
         type: string
-      example: [author, title, conten, content]
+      example: [author, title, content]
       description: |
         Attributes to highlight.
 
@@ -705,7 +705,7 @@ injectedItemsQueryParameters:
       type: array
       items:
         type: string
-      example: [author, title, conten, content]
+      example: [author, title, content]
       description: |
         Attributes to highlight.
 

specs/composition-full/paths/manage_compositions/listCompositions.yml

@@ -17,7 +17,7 @@ get:
       content:
         application/json:
           schema:
-            $ref: '../../common/schemas/listCompositionsResponse.yml#/listCompositionsResponse'
+            $ref: '../../common/schemas/ListCompositionsResponse.yml#/listCompositionsResponse'
     '400':
       $ref: '../../../common/responses/BadRequest.yml'
     '402':

specs/composition-full/paths/objects/multipleBatch.yml

@@ -27,7 +27,7 @@ post:
                   action:
                     $ref: '../../common/schemas/Batch.yml#/action'
                   body:
-                    $ref: '../../common/schemas/batchCompositionAction.yml#/batchCompositionAction'
+                    $ref: '../../common/schemas/BatchCompositionAction.yml#/batchCompositionAction'
                 required:
                   - action
                   - body

specs/composition-full/paths/objects/objects.yml

@@ -16,7 +16,7 @@ get:
       content:
         application/json:
           schema:
-            $ref: '../../common/schemas/listCompositionsResponse.yml#/composition'
+            $ref: '../../common/schemas/Composition.yml#/composition'
     '400':
       $ref: '../../../common/responses/BadRequest.yml'
     '402':

specs/composition-full/paths/rules/rule.yml

@@ -18,7 +18,7 @@ get:
       content:
         application/json:
           schema:
-            $ref: '../../common/schemas/compositionRule.yml#/compositionRule'
+            $ref: '../../common/schemas/CompositionRule.yml#/compositionRule'
     '400':
       $ref: '../../../common/responses/BadRequest.yml'
     '402':

specs/composition-full/paths/rules/saveRules.yml

@@ -30,7 +30,7 @@ post:
                   action:
                     $ref: '../../common/schemas/Batch.yml#/action'
                   body:
-                    $ref: '../../common/schemas/rulesBatchCompositionAction.yml#/rulesBatchCompositionAction'
+                    $ref: '../../common/schemas/RulesBatchCompositionAction.yml#/rulesBatchCompositionAction'
                 required:
                   - action
                   - body

specs/composition-full/paths/rules/searchRules.yml

@@ -20,7 +20,7 @@ post:
             query:
               $ref: './parameters.yml#/query'
             anchoring:
-              $ref: '../../common/schemas/compositionRule.yml#/anchoring'
+              $ref: '../../common/schemas/CompositionRule.yml#/anchoring'
             context:
               type: string
               description: Only return composition rules that match the context (exact match).
@@ -57,7 +57,7 @@ post:
                 type: array
                 description: Composition rules that matched the search criteria.
                 items:
-                  $ref: '../../common/schemas/compositionRule.yml#/compositionRule'
+                  $ref: '../../common/schemas/CompositionRule.yml#/compositionRule'
               nbHits:
                 type: integer
                 description: Number of composition rules that matched the search criteria.