feat: extend page serializer with additional page fields (#35)

* feat: extend page serializer with additional fields (`depth`, `numchild`, `login_required`, `application_namespace`) and update tests (types)

* docs: update README with revised API responses and disclaimers

* Update pyproject.toml

* refactor: remove `depth` and `numchild` fields from page serializer and types

---------

Co-authored-by: Fabian Braun <[email protected]>

Author: metaforx

README.md

@@ -24,12 +24,10 @@ permissions for authenticated staff user<br>
 
 🧩 **Flexible responses** – Fetch plugin content as JSON or fully rendered HTML
 
-> ⚠️ **Disclaimer**
+> ⚠️ **Note**
 >
-> `djangocms-rest` is under active development. While it is safe to explore and test, using it in
-> production is at your own responsibility.
->
-> The impact is limited since the API is **read-only** and does not expose any write operations.
+> `djangocms-rest` is under active development. Since the API is read-only, it's safe to explore
+> without risk of unintended data changes.
 
 ## What is headless mode?
 
@@ -260,15 +258,20 @@ https://drf-spectacular.readthedocs.io/en/latest/index.html
     "absolute_url": "string",
     "path": "string",
     "is_home": true,
+    "login_required": true,
     "in_navigation": true,
     "soft_root": true,
     "template": "string",
     "xframe_options": "string",
-    "limit_visibility_in_menu": true,
+    "limit_visibility_in_menu": false,
     "language": "string",
     "languages": [
         "string"
     ],
+    "is_preview": false,
+    "application_namespace": "string",
+    "creation_date": "2025-05-29T07:59:21.301Z",
+    "changed_date": "2025-05-29T07:59:21.301Z",
     "children": []
 }
 ```
@@ -310,7 +313,9 @@ To determine permissions `user_can_view_page()` from djangocms is used, usually
 
 ### Sample API-Response: api/{en}/pages/{sub}/
 
+> GET CONTENT using `/api/{language}/placeholders/{content_type_id}/{object_id}/{slot}/`
 ```json
+
 {
     "title": "sub",
     "page_title": "sub",
@@ -319,31 +324,39 @@ To determine permissions `user_can_view_page()` from djangocms is used, usually
     "redirect": null,
     "in_navigation": true,
     "soft_root": false,
-    "template": "INHERIT",
-    "xframe_options": 0,
-    "limit_visibility_in_menu": null,
+    "template": "home.html",
+    "xframe_options": "",
+    "limit_visibility_in_menu": false,
     "language": "en",
     "path": "sub",
     "absolute_url": "/sub/",
     "is_home": false,
+    "login_required": false,
     "languages": [
         "en"
     ],
     "is_preview": false,
-    "creation_date": "2025-02-26T21:22:16.844637Z",
-    "changed_date": "2025-02-26T21:22:16.856326Z",
-    // GET CONTENT using `/api/{language}/placeholders/{content_type_id}/{object_id}/{slot}/`
+    "application_namespace": null,
+    "creation_date": "2025-02-27T16:49:01.180050Z",
+    "changed_date": "2025-02-27T16:49:01.180214Z",
     "placeholders": [
         {
             "content_type_id": 5,
-            "object_id": 5,
+            "object_id": 6,
             "slot": "content"
+        },
+        {
+            "content_type_id": 5,
+            "object_id": 6,
+            "slot": "cta"
         }
     ]
 }
 ```
 
-### Sample API-Response: api/{en}/placeholders/{5}/{5}/{content}/[?html=1]
+### Sample API-Response: api/{en}/placeholders/{5}/{6}/{content}/[?html=1]
+
+> Rendered HTML with an optional flag ?html=1
 
 ```json
 {
@@ -375,7 +388,6 @@ To determine permissions `user_can_view_page()` from djangocms is used, usually
         }
     ],
     "html": "<p>Test Content</p>"
-    //Rendered HTML when uins ?html=1
 }
 ```
 

djangocms_rest/serializers/pages.py

@@ -16,6 +16,7 @@ class BasePageSerializer(serializers.Serializer):
     absolute_url = serializers.URLField(max_length=200, allow_blank=True)
     path = serializers.CharField(max_length=200)
     is_home = serializers.BooleanField()
+    login_required = serializers.BooleanField()
     in_navigation = serializers.BooleanField()
     soft_root = serializers.BooleanField()
     template = serializers.CharField(max_length=100)
@@ -24,6 +25,7 @@ class BasePageSerializer(serializers.Serializer):
     language = serializers.CharField(max_length=10)
     languages = serializers.ListSerializer(child=serializers.CharField(), allow_empty=True, required=False)
     is_preview = serializers.BooleanField(default=False)
+    application_namespace = serializers.CharField(max_length=200, allow_null=True)
     creation_date = serializers.DateTimeField()
     changed_date = serializers.DateTimeField()
 
@@ -56,8 +58,10 @@ def get_base_representation(self, page_content: PageContent) -> Dict:
             "path": relative_url,
             "absolute_url": absolute_url,
             "is_home": page_content.page.is_home,
+            "login_required": page_content.page.login_required,
             "languages": page_content.page.get_languages(),
             "is_preview": getattr(self, "is_preview", False),
+            "application_namespace": page_content.page.application_namespace,
             "creation_date": page_content.creation_date,
             "changed_date": page_content.changed_date,
         }

pyproject.toml

@@ -15,9 +15,12 @@ classifiers = [
     "Framework :: Django",
     "Framework :: Django :: 4.2",
     "Framework :: Django :: 5.0",
+    "Framework :: Django :: 5.1",
+    "Framework :: Django :: 5.2",
     "Framework :: Django CMS",
     "Framework :: Django CMS :: 4.0",
     "Framework :: Django CMS :: 4.1",
+    "Framework :: Django CMS :: 5.0",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent",

tests/types.py

@@ -19,8 +19,10 @@
     "path": str,
     "absolute_url": str,
     "is_home": bool,
+    "login_required": bool,
     "languages": list,
     "is_preview": bool,
+    "application_namespace": (str, type(None)),
     "creation_date": (str, "datetime"),
     "changed_date": (str, "datetime"),
 }