Merge pull request #1119 from akeneo/CEX-732-apidoc

CEX-732 - Add comments and review status on pending attributes in tasks list

Author: amigaire

content/swagger/akeneo-web-api.json

@@ -41,7 +41,7 @@ properties:
     description: |
       Object of attributes for the task that are awaiting completion or require user input.
       The keys of this object are attribute codes (e.g. "name", "description", "size"), and
-      each value is an array of objects with locale and scope information.
+      each value is an array of objects with information on locale, scope, rejection status and comment.
       This field is only included when `with_attributes=true`.
     additionalProperties:
       type: array
@@ -57,15 +57,21 @@ properties:
             type: string
             x-nullable: true
             description: The scope (channel) code for the attribute value, null if the attribute is not scopable
+          rejected:
+            type: boolean
+            description: Whether this attribute value has been rejected
+          comment:
+            type: string
+            description: Comment explaining why the attribute value was rejected
     example:
-      "name": [{"locale": null, "scope": null}]
+      "name": [{"locale": null, "scope": null, "rejected": false}]
       "description": [
-        {"locale": "en_US", "scope": "ecommerce"},
-        {"locale": "fr_FR", "scope": "ecommerce"}
+        {"locale": "en_US", "scope": "ecommerce", "rejected": false},
+        {"locale": "fr_FR", "scope": "ecommerce", "rejected": true, "comment": "Typo in the description"}
       ]
       "color": [
-        {"locale": "en_US", "scope": null},
-        {"locale": "fr_FR", "scope": null}
+        {"locale": "en_US", "scope": null, "rejected": true},
+        {"locale": "fr_FR", "scope": null, "rejected": false}
       ]
   _links:
     type: object

content/swagger/resources/workflows/definitions/workflow_task.yaml

@@ -48,10 +48,10 @@ get:
                 due_date: "2024-03-31T18:00:00Z"
                 rejected: true
                 pending_attributes:
-                  "name": [{"locale": null, "scope": null}]
+                  "name": [{"locale": null, "scope": null, "rejected": false}]
                   "description": [
-                    {"locale": "en_US", "scope": "ecommerce"},
-                    {"locale": "fr_FR", "scope": "ecommerce"}
+                    {"locale": "en_US", "scope": "ecommerce", "rejected": false},
+                    {"locale": "fr_FR", "scope": "ecommerce", "rejected": true, "comment": "Typo in the description" }
                   ]
                 _links:
                   self:
@@ -66,11 +66,11 @@ get:
                 due_date: "2024-03-28T18:00:00Z"
                 rejected: false
                 pending_attributes:
-                  "name": [{"locale": null, "scope": null}]
-                  "size": [{"locale": null, "scope": null}]
+                  "name": [{"locale": null, "scope": null, "rejected": false}]
+                  "size": [{"locale": null, "scope": null, "rejected": true}]
                   "color": [
-                    {"locale": "en_US", "scope": null},
-                    {"locale": "fr_FR", "scope": null}
+                    {"locale": "en_US", "scope": null, "rejected": false},
+                    {"locale": "fr_FR", "scope": null, "rejected": false}
                   ]
                 _links:
                   self: