Skip to content

serialize layout for Plone Site in Plone 6 #1940

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davisagli merged 3 commits into from
Aug 15, 2025
Merged

serialize layout for Plone Site in Plone 6 #1940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af8d4c0
serialize for Plone Site in Plone 6
erral Aug 14, 2025
88a5e03
Update news/1939.bugfix
stevepiercy Aug 14, 2025
623c2a3
Merge branch 'main' into erral-issue-1939
davisagli Aug 15, 2025
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/1939.bugfix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Serialize the `layout` of a Plone Site if it is a Plone 6 site. @erral
2 changes: 2 additions & 0 deletions src/plone/restapi/serializer/site.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ def __call__(self, version=None, include_items=True, include_expansion=True):

if HAS_PLONE_6:
result["UID"] = self.context.UID()
result["layout"] = self.context.getLayout()

# Insert review_state
wf = getToolByName(self.context, "portal_workflow")
result["review_state"] = wf.getInfoFor(
Expand Down
1 change: 1 addition & 0 deletions src/plone/restapi/tests/http-examples/jwt_logged_in.resp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Content-Type: application/json
"title": "English",
"token": "en"
},
"layout": "document_view",
"lock": {
"locked": false,
"stealable": true
Expand Down
1 change: 1 addition & 0 deletions src/plone/restapi/tests/http-examples/navroot_site_get.resp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Content-Type: application/json
"title": "English",
"token": "en"
},
"layout": "language-switcher",
"lock": {
"locked": false,
"stealable": true
Expand Down
1 change: 1 addition & 0 deletions src/plone/restapi/tests/http-examples/navroot_standard_site_content_get.resp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Content-Type: application/json
"title": "English",
"token": "en"
},
"layout": "document_view",
"lock": {
"locked": false,
"stealable": true
Expand Down
1 change: 1 addition & 0 deletions src/plone/restapi/tests/http-examples/navroot_standard_site_content_get_expansion.resp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Content-Type: application/json
"title": "English",
"token": "en"
},
"layout": "document_view",
"lock": {
"locked": false,
"stealable": true
Expand Down
1 change: 1 addition & 0 deletions src/plone/restapi/tests/http-examples/navroot_standard_site_get.resp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Content-Type: application/json
"title": "English",
"token": "en"
},
"layout": "document_view",
"lock": {
"locked": false,
"stealable": true
Expand Down
2 changes: 2 additions & 0 deletions src/plone/restapi/tests/http-examples/navroot_standard_site_get_expansion.resp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Content-Type: application/json
"title": "English",
"token": "en"
},
"layout": "document_view",
"lock": {
"locked": false,
"stealable": true
Expand Down Expand Up @@ -92,6 +93,7 @@ Content-Type: application/json
"title": "English",
"token": "en"
},
"layout": "document_view",
"lock": {
"locked": false,
"stealable": true
Expand Down
2 changes: 2 additions & 0 deletions src/plone/restapi/tests/http-examples/site_get_expand_navroot.resp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Content-Type: application/json
"title": "English",
"token": "en"
},
"layout": "language-switcher",
"lock": {
"locked": false,
"stealable": true
Expand Down Expand Up @@ -116,6 +117,7 @@ Content-Type: application/json
"title": "English",
"token": "en"
},
"layout": "language-switcher",
"lock": {
"locked": false,
"stealable": true
Expand Down
1 change: 1 addition & 0 deletions src/plone/restapi/tests/http-examples/siteroot.resp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Content-Type: application/json
"title": "English",
"token": "en"
},
"layout": "document_view",
"lock": {
"locked": false,
"stealable": true
Expand Down
7 changes: 7 additions & 0 deletions src/plone/restapi/tests/test_dxcontent_serializer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -796,6 +796,13 @@ def test_allow_discussion_global_enabled_but_instance_has_no_discussion_behavior
self.assertIn("allow_discussion", obj)
self.assertEqual(False, obj["allow_discussion"])

@unittest.skipUnless(HAS_PLONE_6, "Requires Dexterity-based site root")
def test_get_layout_for_siteroot(self):
current_layout = self.portal.getLayout()
obj = self.serialize(self.portal)
self.assertIn("layout", obj)
self.assertEqual(current_layout, obj["layout"])


class TestDXContentPrimaryFieldTargetUrl(unittest.TestCase):
layer = PLONE_RESTAPI_DX_INTEGRATION_TESTING
Expand Down