Merge branch 'main' into clara/chore/add-composition-as-codeowner

Author: shortcuts

clients/algoliasearch-client-javascript/packages/client-composition/model/composition.ts

@@ -4,7 +4,7 @@ import type { CompositionBehavior } from './compositionBehavior';
 
 export type Composition = {
   /**
-   * Unique record identifier.
+   * Composition unique identifier.
    */
   objectID: string;
 

clients/algoliasearch-client-javascript/packages/client-composition/model/compositionRule.ts

@@ -6,7 +6,7 @@ import type { TimeRange } from './timeRange';
 
 export type CompositionRule = {
   /**
-   * Unique record identifier.
+   * Composition rule unique identifier.
    */
   objectID: string;
 

clients/algoliasearch-client-javascript/packages/client-composition/model/deleteCompositionAction.ts

@@ -5,7 +5,7 @@
  */
 export type DeleteCompositionAction = {
   /**
-   * Unique record identifier.
+   * Composition unique identifier.
    */
   objectID: string;
 };

clients/algoliasearch-client-javascript/packages/client-composition/model/deleteCompositionRuleAction.ts

@@ -5,7 +5,7 @@
  */
 export type DeleteCompositionRuleAction = {
   /**
-   * Unique record identifier.
+   * Composition rule unique identifier.
    */
   objectID: string;
 };

docs/bundled/composition-full.json

@@ -1035,7 +1035,8 @@
       },
       "compositionObjectID": {
         "type": "string",
-        "description": "Unique Composition ObjectID."
+        "example": "my_composition_object_id",
+        "description": "Composition unique identifier."
       },
       "query": {
         "type": "string",
@@ -3755,7 +3756,7 @@
         "additionalProperties": false,
         "properties": {
           "objectID": {
-            "$ref": "#/components/schemas/objectID"
+            "$ref": "#/components/schemas/compositionObjectID"
           },
           "name": {
             "type": "string",
@@ -3791,7 +3792,7 @@
         "additionalProperties": false,
         "properties": {
           "objectID": {
-            "$ref": "#/components/schemas/objectID"
+            "$ref": "#/components/schemas/compositionObjectID"
           }
         },
         "required": [
@@ -3819,6 +3820,11 @@
         "type": "string",
         "description": "Unique identifier of a rule object."
       },
+      "compositionRuleObjectID": {
+        "type": "string",
+        "example": "my_composition_rule_object_id",
+        "description": "Composition rule unique identifier."
+      },
       "anchoring": {
         "type": "string",
         "description": "Which part of the search query the pattern should match:\n\n- `startsWith`. The pattern must match the beginning of the query.\n- `endsWith`. The pattern must match the end of the query.\n- `is`. The pattern must match the query exactly.\n- `contains`. The pattern must match anywhere in the query.\n\nEmpty queries are only allowed as patterns with `anchoring: is`.\n",
@@ -3878,7 +3884,7 @@
         "additionalProperties": false,
         "properties": {
           "objectID": {
-            "$ref": "#/components/schemas/objectID"
+            "$ref": "#/components/schemas/compositionRuleObjectID"
           },
           "conditions": {
             "type": "array",
@@ -3933,7 +3939,7 @@
         "additionalProperties": false,
         "properties": {
           "objectID": {
-            "$ref": "#/components/schemas/objectID"
+            "$ref": "#/components/schemas/compositionRuleObjectID"
           }
         },
         "required": [

docs/bundled/composition-full.yml

@@ -229,7 +229,8 @@
     "schemas": {
       "compositionObjectID": {
         "type": "string",
-        "description": "Unique Composition ObjectID."
+        "example": "my_composition_object_id",
+        "description": "Composition unique identifier."
       },
       "query": {
         "type": "string",

docs/bundled/composition.json

@@ -454,7 +454,7 @@ paths:
           label: curl
           source: |-
             curl --request POST \
-              --url https://algolia_application_id.algolia.net/1/compositions/lorem/run \
+              --url https://algolia_application_id.algolia.net/1/compositions/my_composition_object_id/run \
               --header 'accept: application/json' \
               --header 'content-type: application/json' \
               --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
@@ -802,7 +802,7 @@ paths:
           label: curl
           source: |-
             curl --request POST \
-              --url https://algolia_application_id.algolia.net/1/compositions/lorem/facets/lorem/query \
+              --url https://algolia_application_id.algolia.net/1/compositions/my_composition_object_id/facets/lorem/query \
               --header 'accept: application/json' \
               --header 'content-type: application/json' \
               --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
@@ -830,7 +830,8 @@ components:
   schemas:
     compositionObjectID:
       type: string
-      description: Unique Composition ObjectID.
+      example: my_composition_object_id
+      description: Composition unique identifier.
     query:
       type: string
       description: Search query.

docs/bundled/composition.yml

@@ -719,7 +719,8 @@ components:
           example: Invalid Application-Id or API-Key
     compositionObjectID:
       type: string
-      description: Unique Composition ObjectID.
+      example: my_composition_object_id
+      description: Composition unique identifier.
     query:
       type: string
       description: Search query.
@@ -3859,7 +3860,7 @@ components:
       additionalProperties: false
       properties:
         objectID:
-          $ref: '#/components/schemas/objectID'
+          $ref: '#/components/schemas/compositionObjectID'
         name:
           type: string
           description: Composition name.
@@ -3886,7 +3887,7 @@ components:
       additionalProperties: false
       properties:
         objectID:
-          $ref: '#/components/schemas/objectID'
+          $ref: '#/components/schemas/compositionObjectID'
       required:
         - objectID
     batchCompositionAction:
@@ -3908,6 +3909,10 @@ components:
       title: objectID
       type: string
       description: Unique identifier of a rule object.
+    compositionRuleObjectID:
+      type: string
+      example: my_composition_rule_object_id
+      description: Composition rule unique identifier.
     anchoring:
       type: string
       description: |
@@ -3988,7 +3993,7 @@ components:
       additionalProperties: false
       properties:
         objectID:
-          $ref: '#/components/schemas/objectID'
+          $ref: '#/components/schemas/compositionRuleObjectID'
         conditions:
           type: array
           minItems: 0
@@ -4031,7 +4036,7 @@ components:
       additionalProperties: false
       properties:
         objectID:
-          $ref: '#/components/schemas/objectID'
+          $ref: '#/components/schemas/compositionRuleObjectID'
       required:
         - objectID
     rulesBatchCompositionAction:

specs/bundled/composition-full.yml

@@ -287,7 +287,8 @@ components:
   schemas:
     compositionObjectID:
       type: string
-      description: Unique Composition ObjectID.
+      example: my_composition_object_id
+      description: Composition unique identifier.
     query:
       type: string
       description: Search query.