Remove data and schema from non-schema-based control panels (#1933)

* Remove data and schema from non-schema-based control panels

* Update docs

Author: davisagli

docs/source/endpoints/controlpanels.md

@@ -127,8 +127,6 @@ The following fields are returned:
 - `@id`: hypermedia link to the control panel
 - `title`: title of the control panel
 - `group`: group name of the control panel
-- `schema`: JSON Schema of the control panel
-- `data`: current values of the control panel
 - `items`: list of configurable content types
 
 

news/1927.bugfix

@@ -0,0 +1 @@
+In the `@controlpanels` service, removed empty `data` and `schema` from special control panels that do not use a schema (`dexterity-types` and `rules`). @davisagli

src/plone/restapi/controlpanels/rules.py

@@ -19,7 +19,6 @@
 @adapter(Interface, IControlpanelLayer)
 @implementer(IContentRulesControlpanel, IBrowserPublisher)
 class ContentRulesControlpanel(RegistryConfigletPanel):
-    schema = Interface
     configlet_id = "ContentRules"
     configlet_category_id = "plone-content"
 

src/plone/restapi/controlpanels/types.py

@@ -19,7 +19,6 @@
 @adapter(Interface, IControlpanelLayer)
 @implementer(IDexterityTypesControlpanel)
 class DexterityTypesControlpanel(RegistryConfigletPanel):
-    schema = Interface
     configlet_id = "dexterity-types"
     configlet_category_id = "plone-content"
 

src/plone/restapi/deserializer/controlpanels/__init__.py

@@ -35,6 +35,9 @@ def __init__(self, controlpanel):
         self.request = self.controlpanel.request
 
     def __call__(self, mask_validation_errors=True):
+        if self.schema is None:
+            return
+
         data = json_body(self.controlpanel.request)
 
         proxy = self.registry.forInterface(self.schema, prefix=self.schema_prefix)

src/plone/restapi/serializer/controlpanels/__init__.py

@@ -78,38 +78,41 @@ def __init__(self, controlpanel):
         self.registry = getUtility(IRegistry)
 
     def __call__(self):
-        json_schema = get_jsonschema_for_controlpanel(
-            self.controlpanel, self.controlpanel.context, self.controlpanel.request
-        )
-
-        proxy = self.registry.forInterface(self.schema, prefix=self.schema_prefix)
-
-        # Temporarily provide IDexterityContent, so we can use DX field
-        # serializers
-        alsoProvides(proxy, IDexterityContent)
-
-        json_data = {}
-        for name, field in zope.schema.getFields(self.schema).items():
-            serializer = queryMultiAdapter(
-                (field, proxy, self.controlpanel.request), IFieldSerializer
-            )
-            if serializer:
-                value = serializer()
-            else:
-                value = getattr(proxy, name, None)
-            json_data[json_compatible(name)] = value
-
-        noLongerProvides(proxy, IDexterityContent)
-
-        # JSON schema
-        return {
+        result = {
             "@id": "{}/{}/{}".format(
                 self.controlpanel.context.absolute_url(),
                 SERVICE_ID,
                 self.controlpanel.__name__,
             ),
             "title": self.controlpanel.title,
             "group": self.controlpanel.group,
-            "schema": json_schema,
-            "data": json_data,
         }
+
+        if self.schema is not None:
+            json_schema = get_jsonschema_for_controlpanel(
+                self.controlpanel, self.controlpanel.context, self.controlpanel.request
+            )
+            result["schema"] = json_schema
+
+            proxy = self.registry.forInterface(self.schema, prefix=self.schema_prefix)
+
+            # Temporarily provide IDexterityContent, so we can use DX field
+            # serializers
+            alsoProvides(proxy, IDexterityContent)
+
+            json_data = {}
+            for name, field in zope.schema.getFields(self.schema).items():
+                serializer = queryMultiAdapter(
+                    (field, proxy, self.controlpanel.request), IFieldSerializer
+                )
+                if serializer:
+                    value = serializer()
+                else:
+                    value = getattr(proxy, name, None)
+                json_data[json_compatible(name)] = value
+
+            noLongerProvides(proxy, IDexterityContent)
+
+            result["data"] = json_data
+
+        return result

src/plone/restapi/tests/http-examples/controlpanels_get_contentrules.resp

@@ -3,7 +3,6 @@ Content-Type: application/json
 
 {
     "@id": "http://localhost:55001/plone/@controlpanels/content-rules",
-    "data": {},
     "group": "Content",
     "items": [
         [
@@ -29,11 +28,5 @@ Content-Type: application/json
             }
         ]
     ],
-    "schema": {
-        "fieldsets": [],
-        "properties": {},
-        "required": [],
-        "type": "object"
-    },
     "title": "Content Rules"
 }

src/plone/restapi/tests/http-examples/controlpanels_get_dexterity.resp

@@ -3,7 +3,6 @@ Content-Type: application/json
 
 {
     "@id": "http://localhost:55001/plone/@controlpanels/dexterity-types",
-    "data": {},
     "group": "Content",
     "items": [
         {
@@ -97,11 +96,5 @@ Content-Type: application/json
             "title": "DX Test Document"
         }
     ],
-    "schema": {
-        "fieldsets": [],
-        "properties": {},
-        "required": [],
-        "type": "object"
-    },
     "title": "Content Types"
 }

src/plone/restapi/tests/test_services_controlpanels.py

@@ -93,7 +93,9 @@ def test_update_all(self):
             response = self.api_session.get(item["@id"])
 
             # store the outputted data
-            response = self.api_session.patch(item["@id"], json=response.json()["data"])
+            response = self.api_session.patch(
+                item["@id"], json=response.json().get("data", {})
+            )
             self.assertEqual(
                 204,
                 response.status_code,