CPM-724: Fix doc

Author: pierallard

content/files/Akeneo PIM API.postman_collection.json

@@ -3997,7 +3997,7 @@
                 {
                   "key": "with_attribute_options",
                   "value": "true",
-                  "description": "(boolean ) • Return labels of attribute options in the response. (Only available since the 5.0 version).",
+                  "description": "(boolean ) • Return labels of attribute options in the response.",
                   "disabled": true
                 },
                 {

content/swagger/akeneo-web-api.json

@@ -278,6 +278,21 @@ ErrorByLine:
     message:
       type: string
       description: Message explaining the error
+ErrorByLineProductUuid:
+  type: object
+  properties:
+    line:
+      type: integer
+      description: Line number
+    uuid:
+      type: string
+      description: Product uuid
+    status_code:
+      type: integer
+      description: HTTP status code, see <a href="/documentation/responses.html#client-errors">Client errors</a> to understand the meaning of each code
+    message:
+      type: string
+      description: Message explaining the error
 ErrorByObject:
   type: array
   items:

content/swagger/definitions.yaml

@@ -159,16 +159,23 @@ example: {
   "groups": [],
   "parent": null,
   "values": {
+    "sku": [
+      {
+        "data": "top",
+        "locale": null,
+        "scope": null
+      }
+    ],
     "name": [
       {
         "data": "Top",
         "locale": "en_US",
-        "scope": null,
+        "scope": null
       },
       {
         "data": "Débardeur",
         "locale": "fr_FR",
-        "scope": null,
+        "scope": null
       }
     ],
     "description": [

content/swagger/resources/products_uuid/definitions/product_uuid.yaml

@@ -5,7 +5,7 @@ get:
     - Product [uuid]
   x-versions:
     - "SaaS"
-  description: This endpoint allows you to get a list of products. Products are paginated and they can be filtered. In the Enterprise Edition, since the 2.0, permissions based on your user groups are applied to the set of products you request.
+  description: This endpoint allows you to get a list of products. Products are paginated and they can be filtered. In the Enterprise Edition, permissions based on your user groups are applied to the set of products you request.
   parameters:
     - name: search
       in: query
@@ -70,7 +70,7 @@ post:
     - Product [uuid]
   x-versions:
     - "SaaS"
-  description: This endpoint allows you to create a new product. In the Enterprise Edition, since the v2.0, permissions based on your user groups are applied to the product you try to create.
+  description: This endpoint allows you to create a new product. In the Enterprise Edition, permissions based on your user groups are applied to the product you try to create. If no uuid is provided, the PIM will generate one for you.
   parameters:
     - name: body
       in: body
@@ -96,7 +96,7 @@ patch:
     - Product [uuid]
   x-versions:
     - "SaaS"
-  description: This endpoint allows you to update and/or create several products at once. Learn more about <a href="/documentation/update.html#update-behavior">Update behavior</a>. Note that if no product exists for the given uuid, it creates it. In the Enterprise Edition, since the v2.0, permissions based on your user groups are applied to the products you try to update. It may result in the creation of drafts if you only have edit rights through the product's categories.
+  description: This endpoint allows you to update and/or create several products at once. Learn more about <a href="/documentation/update.html#update-behavior">Update behavior</a>. Note that if no product exists for the given uuid, it creates it. In the Enterprise Edition, permissions based on your user groups are applied to the products you try to update. It may result in the creation of drafts if you only have edit rights through the product's categories.
   x-body-by-line: Contains several lines, each line is a product in JSON standard format
   parameters:
     - name: body
@@ -105,18 +105,18 @@ patch:
         $ref: "#/definitions/ProductUuid"
         x-examples:
           x-example-1:
-            '{"uuid":"fc24e6c3-933c-4a93-8a81-e5c703d134d5","values":{"sku":[{"data":"cap","locale":null,"scope":null}],"description":[{"scope":"ecommerce","locale":"en_US","data":"My amazing cap"}]}}'
+            '{"uuid":"fc24e6c3-933c-4a93-8a81-e5c703d134d5","values":{"description":[{"scope":"ecommerce","locale":"en_US","data":"My amazing cap"}]}}'
           x-example-2:
-            '{"uuid":"573dd613-0c7f-4143-83d5-63cc5e535966","values":{"sku":[{"data":"mug","locale":null,"scope":null}]}, "group":["promotion"]}'
+            '{"uuid":"573dd613-0c7f-4143-83d5-63cc5e535966","values":{"sku":[{"data":"updated_sku","locale":null,"scope":null}]}, "group":["promotion"]}'
           x-example-3:
-            '{"uuid":"2d9e205c-78c9-495a-831c-e1a10531eeb1","values":{"sku":[{"data":"tshirt","locale":null,"scope":null}]},"family":"clothes"}'
+            '{"values":{"sku":[{"data":"new_product","locale":null,"scope":null}]},"family":"clothes"}'
   responses:
     200:
       description: OK
       x-details: Returns a plain text response whose lines are JSON containing the status of each update or creation
       x-no-entity: true
       schema:
-        $ref: "#/definitions/ErrorByLine"
+        $ref: "#/definitions/ErrorByLineProductUuid"
       examples:
         x-example-1:
           '{"line":1,"uuid":"fc24e6c3-933c-4a93-8a81-e5c703d134d5","status_code":204}'

content/swagger/resources/products_uuid/routes/products_uuid.yaml

@@ -5,7 +5,7 @@ get:
     - Product [uuid]
   x-versions:
     - "SaaS"
-  description: This endpoint allows you to get the information about a given product. In the Entreprise Edition, since the v2.0, permissions based on your user groups are applied to the product you request.
+  description: This endpoint allows you to get the information about a given product. In the Entreprise Edition, permissions based on your user groups are applied to the product you request.
   parameters:
     - $ref: '#/parameters/uuid'
     - $ref: '#/parameters/with_attribute_options'
@@ -32,7 +32,7 @@ patch:
     - Product [uuid]
   x-versions:
     - "SaaS"
-  description: This endpoint allows you to update a given product. Learn more about <a href="/documentation/update.html#update-behavior">Update behavior</a>. Note that if no product exists for the given uuid, it creates it. In the Entreprise Edition, since the v2.0, permissions based on your user groups are applied to the product you try to update. It may result in the creation of a draft if you only have edit rights through the product's categories.
+  description: This endpoint allows you to update a given product. Learn more about <a href="/documentation/update.html#update-behavior">Update behavior</a>. Note that if no product exists for the given uuid, it creates it. In the Entreprise Edition, permissions based on your user groups are applied to the product you try to update. It may result in the creation of a draft if you only have edit rights through the product's categories.
   parameters:
     - $ref: '#/parameters/uuid'
     - name: body
@@ -60,7 +60,7 @@ delete:
     - Product [uuid]
   x-versions:
     - "SaaS"
-  description: This endpoint allows you to delete a given product. In the Enterprise Edition, since the 2.0, permissions based on your user groups are applied to the product you try to delete.
+  description: This endpoint allows you to delete a given product. In the Enterprise Edition, permissions based on your user groups are applied to the product you try to delete.
   parameters:
     - $ref: '#/parameters/uuid'
   responses: