feat: Support the "noPageBreak" rendering layout field

Author: Wuestengecko

polarion_rest_api_client/data_models.py

@@ -35,13 +35,18 @@
     "WorkItemLink",
 ]
 
-BOOLEAN_RENDERING_PROPERTIES = ["fieldsAtEndAsTable", "hidden"]
+BOOLEAN_RENDERING_PROPERTIES = [
+    "fieldsAtEndAsTable",
+    "hidden",
+    "noPageBreak",
+]
 RENDERING_LAYOUT_FIELDS = {
     "fieldsAtEndAsTable": "fields_at_end_as_table",
     "fieldsAtStart": "fields_at_start",
     "fieldsAtEnd": "fields_at_end",
     "sidebarWorkItemFields": "sidebar_work_item_fields",
     "hidden": "hidden",
+    "noPageBreak": "no_page_break",
 }
 
 
@@ -326,6 +331,7 @@ class RenderingProperties:
     sidebar_work_item_fields: list[str] | None = None
     fields_at_end_as_table: bool = False
     hidden: bool = False
+    no_page_break: bool = False
 
     def serialize(self) -> list[dict[str, t.Any]]:
         """Serialize an instance of this class to be sent via the API."""

tests/data/expected_requests/create_document.json

@@ -18,7 +18,8 @@
               { "key": "fieldsAtStart", "value": "id" },
               { "key": "fieldsAtEnd", "value": "custom" },
               { "key": "sidebarWorkItemFields", "value": "id" },
-              { "key": "hidden", "value": "false" }
+              { "key": "hidden", "value": "false" },
+              { "key": "noPageBreak", "value": "true" }
             ],
             "type": "task"
           },
@@ -28,7 +29,8 @@
             "properties": [
               { "key": "fieldsAtEndAsTable", "value": "false" },
               { "key": "fieldsAtStart", "value": "id" },
-              { "key": "hidden", "value": "false" }
+              { "key": "hidden", "value": "false" },
+              { "key": "noPageBreak", "value": "false" }
             ],
             "type": "task2"
           }

tests/data/expected_requests/update_document_2.json

@@ -13,7 +13,8 @@
             { "key": "fieldsAtStart", "value": "id" },
             { "key": "fieldsAtEnd", "value": "custom" },
             { "key": "sidebarWorkItemFields", "value": "id" },
-            { "key": "hidden", "value": "true" }
+            { "key": "hidden", "value": "true" },
+            { "key": "noPageBreak", "value": "true" }
           ],
           "type": "task"
         },
@@ -23,7 +24,8 @@
           "properties": [
             { "key": "fieldsAtEndAsTable", "value": "false" },
             { "key": "fieldsAtStart", "value": "id" },
-            { "key": "hidden", "value": "false" }
+            { "key": "hidden", "value": "false" },
+            { "key": "noPageBreak", "value": "false" }
           ],
           "type": "task2"
         }

tests/data/mock_api_responses/get_document.json

@@ -35,6 +35,10 @@
             {
               "key": "fieldsAtEndAsTable",
               "value": "true"
+            },
+            {
+              "key": "noPageBreak",
+              "value": "true"
             }
           ]
         }

tests/test_client_documents.py

@@ -52,6 +52,7 @@ def test_get_document_with_all_fields(
                     fields_at_end=["custom", "bla"],
                     sidebar_work_item_fields=["id"],
                     fields_at_end_as_table=True,
+                    no_page_break=True,
                 ),
             ),
         ],
@@ -89,6 +90,7 @@ def test_create_new_document(
                     fields_at_end=["custom"],
                     sidebar_work_item_fields=["id"],
                     fields_at_end_as_table=True,
+                    no_page_break=True,
                 ),
             ),
             data_models.RenderingLayout(
@@ -97,6 +99,7 @@ def test_create_new_document(
                 layouter=data_models.Layouter("paragraph"),
                 properties=data_models.RenderingProperties(
                     fields_at_start=["id"],
+                    no_page_break=False,
                 ),
             ),
         ],
@@ -166,6 +169,7 @@ def test_update_document(
                     fields_at_end=["custom"],
                     sidebar_work_item_fields=["id"],
                     hidden=True,
+                    no_page_break=True,
                 ),
             ),
             data_models.RenderingLayout(
@@ -174,6 +178,7 @@ def test_update_document(
                 layouter=data_models.Layouter("paragraph"),
                 properties=data_models.RenderingProperties(
                     fields_at_start=["id"],
+                    no_page_break=False,
                 ),
             ),
         ],