Skip to content

Commit 34067fd

Browse files
CEX-702: [pim api doc] patch workflow task with rejected attributes (#1106)
* CEX-702: [pim api doc] patch workflow task with rejected attributes * CEX-702: fix * CEX-702: fix * CEX-702: akeneo-web-api.json * CEX-702: akeneo-web-api.json
1 parent aadc04d commit 34067fd

File tree

2 files changed

+41
-3
lines changed

2 files changed

+41
-3
lines changed

content/swagger/akeneo-web-api.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

content/swagger/resources/workflows/routes/workflows_tasks_uuid.yaml

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ patch:
1111
<ul>
1212
<li>To approve a 'review' task, set status to <code>approved</code>.</li>
1313
<li>To complete an 'enrichment' task, set status to <code>completed</code>.</li>
14-
<li>To reject a 'review' task, set status to <code>rejected</code> and provide <code>send_back_to_step_uuid</code>.</li>
14+
<li>To reject a 'review' task, set status to <code>rejected</code>, provide <code>send_back_to_step_uuid</code>, and optionally provide <code>rejected_attributes</code> to specify details about rejected attributes.</li>
1515
</ul>
1616
parameters:
1717
- $ref: '#/parameters/uuid'
@@ -29,6 +29,23 @@ patch:
2929
send_back_to_step_uuid:
3030
type: string
3131
description: (required only for rejected status) The UUID of the workflow step to which the task should be returned.
32+
rejected_attributes:
33+
type: object
34+
description: (optional, only for rejected status) Optionally provides details about which attributes were rejected. For each attribute name you can specify a comment, the locale, and the scope for the rejection.
35+
additionalProperties:
36+
type: array
37+
items:
38+
type: object
39+
properties:
40+
comment:
41+
type: string
42+
description: Comment about the rejection reason for this attribute.
43+
locale:
44+
type: [string, "null"]
45+
description: Locale code, or null if not applicable.
46+
scope:
47+
type: [string, "null"]
48+
description: Scope code, or null if not applicable.
3249
example:
3350
[
3451
{
@@ -39,7 +56,28 @@ patch:
3956
},
4057
{
4158
status: "rejected",
42-
send_back_to_step_uuid: "123e4567-e89b-12d3-a456-426614174000"
59+
send_back_to_step_uuid: "7108ee60-a1ea-4fe1-baca-b39909e23d24",
60+
rejected_attributes: {
61+
name: [
62+
{
63+
comment: "",
64+
locale: null,
65+
scope: null
66+
}
67+
],
68+
description: [
69+
{
70+
comment: "Wrong description",
71+
locale: "en_US",
72+
scope: "ecommerce"
73+
},
74+
{
75+
comment: "",
76+
locale: "fr_FR",
77+
scope: "mobile"
78+
}
79+
]
80+
}
4381
}
4482
]
4583
responses:

0 commit comments

Comments
 (0)