PMXG-357: Add documentation about product link

Author: StevenVAIDIE

content/concepts/catalog-structure.md

@@ -87,6 +87,7 @@ Below is the list of attribute types and their description:
 | Reference data simple select | pim_reference_data_simpleselect | allows you to manage any kind of data that has its own properties, as a single-choice select. |
 | Reference data multi select | pim_reference_data_multiselect | allows you to manage any kind of data that has its own properties, as a multi-choice select. |
 | Table (Growth and Enterprise editions only) | pim_catalog_table | allows you to manage multidimensional data in the form of a table |
+| Product link | pim_catalog_product_link | Allow you to create a unidirectional relationship between a product/product model to another. |
 
 In the Akeneo UI, you can find the attributes in the `Settings`/`Attributes` menu. Below is an example of one attribute in the UI.
 
@@ -143,7 +144,7 @@ The `group_labels` field is only available since the 5.0.
 _Focus on the table attribute configuration_
 
 The structure of a table attribute is defined in a specific `table_configuration` field, which describes the columns of the table.
-Each column is defined by a data type (select, text, boolean, number), and a unique code. It can hold a collection of labels,
+Each column is defined by a data type (select, text, boolean, number, incremental_number, reference_entity, product_link, measurement, date), and a unique code. It can hold a collection of labels,
 and user-defined validation constraints based on the column data type. A table configuration must define at least two columns, and the first one has to be a `select` data type.
 In order to ensure that the PIM will still be running, we have defined some limits.  
 - You can create up to **10 columns** in a single table.

content/concepts/products.md

@@ -387,6 +387,69 @@ Whenever the attribute's type is `pim_catalog_number`, the `data` field should c
 }
 ```
 
+#### Product link attribute
+::: availability versions=SaaS editions=EE
+:::
+
+Whenever the attribute type is pim_catalog_product_link, the data field must contain:
+- The `type` of the linked entity, with the value `product` or `product_model`
+- The `identifier` or the `id` of the linked entity:
+  - If type is `product`: either the UUID in the id key, or the identifier in the identifier key
+  - If type is `product_model`: the product model code in the id key
+
+##### Examples
+```json
+{
+  "values": {
+    "included_battery": [
+      {
+        "locale": null,
+        "scope": null,
+        "data": {
+          "type": "product",
+          "id": "fc24e6c3-933c-4a93-8a81-e5c703d134d5"
+        },
+        "attribute_type": "pim_catalog_product_link"
+      }
+    ]
+  }
+}
+```
+```json
+{
+  "values": {
+    "included_battery": [
+      {
+        "locale": null,
+        "scope": null,
+        "data": {
+          "type": "product",
+          "identifier": "bl1850b"
+        },
+        "attribute_type": "pim_catalog_product_link"
+      }
+    ]
+  }
+}
+```
+```json
+{
+  "values": {
+    "included_battery": [
+      {
+        "locale": null,
+        "scope": null,
+        "data": {
+          "type": "product_model",
+          "id": "my_super_battery"
+        },
+        "attribute_type": "pim_catalog_product_link"
+      }
+    ]
+  }
+}
+```
+
 #### Metric attribute
 ::: availability versions=1.7,2.x,3.x,4.0,5.0,6.0,7.0,SaaS editions=CE,EE
 :::

content/event-platform/available-events.md

@@ -1171,6 +1171,21 @@ The modifications that can lead to this event include:
                 "scope": "a_scope"
               }
             ],
+            "a_pim_catalog_product_link_attribute": [
+              {
+                "previous": {
+                  "type": "product",
+                  "id": "83413cad-b3aa-4f68-9b4b-7fc90c1ce84a"
+                },
+                "new": {
+                  "type": "product",
+                  "id": "aeabe737-f655-4389-bcc0-d8dd2fc47824"
+                },
+                "type": "pim_catalog_product_link",
+                "locale": "a_locale",
+                "scope": "a_scope"
+              }
+            ],
             "a_pim_catalog_number_attribute": [
               {
                 "previous": 0,

content/rest-api/filter.md

@@ -607,6 +607,25 @@ With the IN operator, the list of product identifiers can contain up to **100**
 | STARTS WITH, CONTAINS, DOES NOT CONTAIN, =, !=            | string             |
 | EMPTY, NOT EMPTY                                          | no value           |
 
+**The `pim_catalog_product_link` attribute types**
+::: availability versions=SaaS editions=EE
+
+| Allowed operators | Allowed value type      |
+|-------------------|-------------------------|
+| IN, NOT IN        | a list of product links |
+| EMPTY, NOT EMPTY  | no value                |
+
+A product link have the following structure:
+
+```json
+{
+  "type": "product",
+  "id": "31243126-cfa4-4d8c-a3ea-e989e059eae2"
+}
+```
+
+Where `type` value can be one of the following: `product`, `product_model` and `id` is the product UUID in case the type is `product` or the product model code in case type is `product_model`.
+
 ## Filter product values
 
 Thanks to the above sections, you are able to filter your products to only get those you want. In this section, you will see that you also can filter the product values to only receive those you want.

content/swagger/resources/attributes/definitions/attribute.yaml

@@ -28,6 +28,7 @@ properties:
         "akeneo_reference_entity",
         "akeneo_reference_entity_collection",
         "pim_catalog_asset_collection",
+        "pim_catalog_product_link",
       ]
     x-immutable: true
   labels:
@@ -172,7 +173,7 @@ properties:
           description: Column code
         data_type:
           type: string
-          enum: ["select", "text", "number", "boolean"]
+          enum: ["select", "text", "number", "boolean", "incremental_number", "reference_entity", "product_link", "measurement", "date"]
           description: Column data type
         validations:
           type: object

content/tutorials/guides/how-to-get-pim-product-information.md

@@ -711,6 +711,7 @@ Disclaimer: The previous snippet doesn’t handle for now the following attribut
 - Reference data simple select attribute
 - Reference data multi select attribute
 - Table attribute
+- Product link attribute
 :::
 
 ###### 2.3 - Collect product media files