Merge pull request #1438 from open-zaak/feature/1437-eio-verschijning…

…svorm

add eio.verschijningsvorm

src/openzaak/components/documenten/admin.py

@@ -381,6 +381,7 @@ class EnkelvoudigInformatieObjectAdmin(
                     "inhoud",
                     "link",
                     "indicatie_gebruiksrecht",
+                    "verschijningsvorm",
                 )
             },
         ),

src/openzaak/components/documenten/api/serializers.py

@@ -347,6 +347,7 @@ class Meta:
             "ontvangstdatum",
             "verzenddatum",
             "indicatie_gebruiksrecht",
+            "verschijningsvorm",
             "ondertekening",
             "integriteit",
             "informatieobjecttype",  # van-relatie,

src/openzaak/components/documenten/constants.py

@@ -46,11 +46,11 @@ class ObjectInformatieObjectTypes(models.TextChoices):
     verzoek = constants.VERZOEK_CHOICE
 
 
-class AfzenderTypes(DjangoChoices):
-    afzender = ChoiceItem("afzender", _("Afzender"))
-    geadresseerde = ChoiceItem("geadresseerde", _("Geadresseerde"))
+class AfzenderTypes(models.TextChoices):
+    afzender = "afzender", _("Afzender")
+    geadresseerde = "geadresseerde", _("Geadresseerde")
 
 
-class PostAdresTypes(DjangoChoices):
-    antwoordnummer = ChoiceItem("antwoordnummer", _("Antwoordnummer"))
-    postbusnummer = ChoiceItem("postbusnummer", _("Postbusnummer"))
+class PostAdresTypes(models.TextChoices):
+    antwoordnummer = "antwoordnummer", _("Antwoordnummer")
+    postbusnummer = "postbusnummer", _("Postbusnummer")

src/openzaak/components/documenten/migrations/0030_enkelvoudiginformatieobject_verschijningsvorm.py

@@ -0,0 +1,23 @@
+# SPDX-License-Identifier: EUPL-1.2
+# Copyright (C) 2023 Dimpact
+# Generated by Django 3.2.18 on 2023-08-16 17:01
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("documenten", "0029_verzending"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="enkelvoudiginformatieobject",
+            name="verschijningsvorm",
+            field=models.TextField(
+                blank=True,
+                help_text="De essentiële opmaakaspecten van een INFORMATIEOBJECT.",
+            ),
+        ),
+    ]

src/openzaak/components/documenten/models.py

@@ -413,6 +413,10 @@ class EnkelvoudigInformatieObject(
         ),
         db_index=True,
     )
+    verschijningsvorm = models.TextField(
+        blank=True,
+        help_text=_("De essentiële opmaakaspecten van een INFORMATIEOBJECT."),
+    )
 
     # When dealing with remote EIO, there is no pk or canonical instance to derive
     # the lock status from. The getters and setters then use this private attribute.

src/openzaak/components/documenten/openapi.yaml

@@ -2950,6 +2950,10 @@ components:
             via de GEBRUIKSRECHTen resource.
           type: boolean
           nullable: true
+        verschijningsvorm:
+          title: Verschijningsvorm
+          description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT."
+          type: string
         ondertekening:
           $ref: '#/components/schemas/Ondertekening'
         integriteit:
@@ -3175,6 +3179,10 @@ components:
             via de GEBRUIKSRECHTen resource.
           type: boolean
           nullable: true
+        verschijningsvorm:
+          title: Verschijningsvorm
+          description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT."
+          type: string
         ondertekening:
           $ref: '#/components/schemas/Ondertekening'
         integriteit:
@@ -3340,7 +3348,7 @@ components:
         taal:
           title: Taal
           description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT
-            is vastgelegd. Voorbeeld: `nld`. Zie: https://www.iso.org/standard/4767.html'
+            is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html'
           type: string
           maxLength: 3
           minLength: 3
@@ -3419,6 +3427,10 @@ components:
             via de GEBRUIKSRECHTen resource.
           type: boolean
           nullable: true
+        verschijningsvorm:
+          title: Verschijningsvorm
+          description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT."
+          type: string
         ondertekening:
           $ref: '#/components/schemas/Ondertekening'
         integriteit:
@@ -3806,6 +3818,10 @@ components:
             via de GEBRUIKSRECHTen resource.
           type: boolean
           nullable: true
+        verschijningsvorm:
+          title: Verschijningsvorm
+          description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT."
+          type: string
         ondertekening:
           $ref: '#/components/schemas/Ondertekening'
         integriteit:

src/openzaak/components/documenten/resources.md

@@ -61,6 +61,7 @@ Uitleg bij mogelijke waarden:
 | ontvangstdatum | De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden zijn waarbij die personen niet deel uit maken van de behandeling van de zaak waarin het document een rol speelt. | string | nee | C​R​U​D |
 | verzenddatum | De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden zijn waarbij die personen niet deel uit maken van de behandeling van de zaak waarin het document een rol speelt. | string | nee | C​R​U​D |
 | indicatieGebruiksrecht | Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen via de GEBRUIKSRECHTen resource. | boolean | nee | C​R​U​D |
+| verschijningsvorm | De essentiële opmaakaspecten van een INFORMATIEOBJECT. | string | nee | C​R​U​D |
 | informatieobjecttype | URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). | string | ja | C​R​U​D |
 | locked | Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. | boolean | nee | ~~C~~​R​~~U~~​~~D~~ |
 | bestandsdelen |  | array | nee | ~~C~~​R​~~U~~​~~D~~ |

src/openzaak/components/documenten/swagger2.0.json

@@ -3544,6 +3544,11 @@
                     "type": "boolean",
                     "x-nullable": true
                 },
+                "verschijningsvorm": {
+                    "title": "Verschijningsvorm",
+                    "description": "De essenti\u00eble opmaakaspecten van een INFORMATIEOBJECT.",
+                    "type": "string"
+                },
                 "ondertekening": {
                     "$ref": "#/definitions/Ondertekening"
                 },
@@ -3731,6 +3736,11 @@
                     "type": "boolean",
                     "x-nullable": true
                 },
+                "verschijningsvorm": {
+                    "title": "Verschijningsvorm",
+                    "description": "De essenti\u00eble opmaakaspecten van een INFORMATIEOBJECT.",
+                    "type": "string"
+                },
                 "ondertekening": {
                     "$ref": "#/definitions/Ondertekening"
                 },
@@ -3870,7 +3880,7 @@
                 },
                 "taal": {
                     "title": "Taal",
-                    "description": "Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `nld`. Zie: https://www.iso.org/standard/4767.html",
+                    "description": "Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html",
                     "type": "string",
                     "maxLength": 3,
                     "minLength": 3
@@ -3941,6 +3951,11 @@
                     "type": "boolean",
                     "x-nullable": true
                 },
+                "verschijningsvorm": {
+                    "title": "Verschijningsvorm",
+                    "description": "De essenti\u00eble opmaakaspecten van een INFORMATIEOBJECT.",
+                    "type": "string"
+                },
                 "ondertekening": {
                     "$ref": "#/definitions/Ondertekening"
                 },
@@ -4270,6 +4285,11 @@
                     "type": "boolean",
                     "x-nullable": true
                 },
+                "verschijningsvorm": {
+                    "title": "Verschijningsvorm",
+                    "description": "De essenti\u00eble opmaakaspecten van een INFORMATIEOBJECT.",
+                    "type": "string"
+                },
                 "ondertekening": {
                     "$ref": "#/definitions/Ondertekening"
                 },

src/openzaak/components/documenten/tests/test_enkelvoudiginformatieobject.py

@@ -60,6 +60,7 @@ def test_create(self):
             "beschrijving": "test_beschrijving",
             "informatieobjecttype": f"http://testserver{informatieobjecttype_url}",
             "vertrouwelijkheidaanduiding": "openbaar",
+            "verschijningsvorm": "Vorm A",
         }
 
         # Send to the API
@@ -87,6 +88,7 @@ def test_create(self):
         self.assertEqual(stored_object.beschrijving, "test_beschrijving")
         self.assertEqual(stored_object.informatieobjecttype, informatieobjecttype)
         self.assertEqual(stored_object.vertrouwelijkheidaanduiding, "openbaar")
+        self.assertEqual(stored_object.verschijningsvorm, "Vorm A")
 
         expected_url = reverse(stored_object)
         expected_file_url = get_operation_url(
@@ -113,6 +115,7 @@ def test_create(self):
                 "status": "",
                 "locked": False,
                 "lock": "",
+                "verschijningsvorm": "Vorm A",
             }
         )
 
@@ -259,6 +262,7 @@ def test_read(self):
             "integriteit": {"algoritme": "", "waarde": "", "datum": None},
             "informatieobjecttype": f"http://testserver{reverse(test_object.informatieobjecttype)}",
             "locked": False,
+            "verschijningsvorm": "",
         }
 
         response_data = response.json()

src/openzaak/components/documenten/tests/test_enkelvoudiginformatieobject_cmis.py

@@ -123,6 +123,7 @@ def test_create(self):
                 "status": "",
                 "locked": False,
                 "lock": "",
+                "verschijningsvorm": "",
             }
         )
 
@@ -304,6 +305,7 @@ def test_read(self):
             "integriteit": {"algoritme": "", "waarde": "", "datum": None},
             "informatieobjecttype": f"http://testserver{reverse(test_object.informatieobjecttype)}",
             "locked": False,
+            "verschijningsvorm": "",
         }
 
         response_data = response.json()