Skip to content

Adds @id to @content-rules endpoint and makes it consistent with other endpoints #1905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adds @id to @content-rules endpoint and makes it consistent with other endpoints #1905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions news/1901.bugfix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Changed the structure of the @content-rules endpoint response to return a flat format with @id at the top level, making it consistent with other REST API endpoints. @irtisamsajin
9 changes: 4 additions & 5 deletions src/plone/restapi/services/rules/get.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@ def reply(self):
assignable_rules = manage_assignments.assignable_rules()

return {
"content-rules": {
"acquired_rules": acquired_rules,
"assigned_rules": assigned_rules,
"assignable_rules": assignable_rules,
}
"@id": f"{self.context.absolute_url()}/@content-rules",
"acquired_rules": acquired_rules,
"assigned_rules": assigned_rules,
"assignable_rules": assignable_rules,
}
51 changes: 25 additions & 26 deletions src/plone/restapi/tests/http-examples/rules_get.resp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,29 @@ HTTP/1.1 200 OK
Content-Type: application/json

{
"content-rules": {
"acquired_rules": [],
"assignable_rules": [],
"assigned_rules": [
{
"bubbles": true,
"description": "First rule added in the testing setup",
"enabled": true,
"global_enabled": true,
"id": "rule-1",
"title": "First test rule",
"trigger": "Comment added",
"url": "http://localhost:55001/plone/++rule++rule-1/@@manage-elements"
},
{
"bubbles": true,
"description": "Second rule added in the testing setup",
"enabled": true,
"global_enabled": true,
"id": "rule-2",
"title": "Second test rule",
"trigger": "Comment added",
"url": "http://localhost:55001/plone/++rule++rule-2/@@manage-elements"
}
]
}
"@id": "http://localhost:55001/plone/@content-rules",
"acquired_rules": [],
"assignable_rules": [],
"assigned_rules": [
{
"bubbles": true,
"description": "First rule added in the testing setup",
"enabled": true,
"global_enabled": true,
"id": "rule-1",
"title": "First test rule",
"trigger": "Comment added",
"url": "http://localhost:55001/plone/++rule++rule-1/@@manage-elements"
},
{
"bubbles": true,
"description": "Second rule added in the testing setup",
"enabled": true,
"global_enabled": true,
"id": "rule-2",
"title": "Second test rule",
"trigger": "Comment added",
"url": "http://localhost:55001/plone/++rule++rule-2/@@manage-elements"
}
]
}