Merge pull request #1546 from open-zaak/feature/1545-eio-trefwoorden

Feature/1545 eio trefwoorden

src/openzaak/components/autorisaties/api/filters.py

@@ -2,13 +2,10 @@
 # Copyright (C) 2019 - 2020 Dimpact
 from django.utils.translation import ugettext_lazy as _
 
-from django_filters.rest_framework import filters
 from vng_api_common.authorizations.models import Applicatie
 from vng_api_common.filtersets import FilterSet
 
-
-class CharArrayFilter(filters.BaseInFilter, filters.CharFilter):
-    pass
+from openzaak.utils.filters import CharArrayFilter
 
 
 class ApplicatieFilter(FilterSet):

src/openzaak/components/catalogi/api/filters.py

@@ -12,6 +12,8 @@
 from vng_api_common.filtersets import FilterSet
 from vng_api_common.utils import get_help_text, get_resource_for_path
 
+from openzaak.utils.filters import CharArrayFilter
+
 from ..models import (
     BesluitType,
     Catalogus,
@@ -67,10 +69,6 @@ def geldigheid_filter(queryset, name, value):
     )
 
 
-class CharArrayFilter(filters.BaseInFilter, filters.CharFilter):
-    pass
-
-
 class RolTypeFilter(FilterSet):
     status = filters.ChoiceFilter(
         field_name="zaaktype__concept",

src/openzaak/components/documenten/admin.py

@@ -382,6 +382,7 @@ class EnkelvoudigInformatieObjectAdmin(
                     "link",
                     "indicatie_gebruiksrecht",
                     "verschijningsvorm",
+                    "trefwoorden",
                 )
             },
         ),

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

@@ -11,7 +11,7 @@
 from vng_api_common.filtersets import FilterSet
 from vng_api_common.utils import get_help_text
 
-from openzaak.utils.filters import ExpandFilter
+from openzaak.utils.filters import CharArrayFilter, ExpandFilter
 
 from ..models import (
     EnkelvoudigInformatieObject,
@@ -31,11 +31,12 @@
 
 
 class EnkelvoudigInformatieObjectListFilter(FilterSet):
+    trefwoorden = CharArrayFilter(field_name="trefwoorden", lookup_expr="contains")
     expand = ExpandFilter(serializer_class=EnkelvoudigInformatieObjectSerializer)
 
     class Meta:
         model = EnkelvoudigInformatieObject
-        fields = ("identificatie", "bronorganisatie")
+        fields = ("identificatie", "bronorganisatie", "trefwoorden")
 
 
 class EnkelvoudigInformatieObjectDetailFilter(FilterSet):

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

@@ -346,6 +346,7 @@ class Meta:
             "informatieobjecttype",  # van-relatie,
             "locked",
             "bestandsdelen",
+            "trefwoorden",
         )
         extra_kwargs = {
             "taal": {"min_length": 3},

src/openzaak/components/documenten/migrations/0031_enkelvoudiginformatieobject_trefwoorden.py

@@ -0,0 +1,28 @@
+# SPDX-License-Identifier: EUPL-1.2
+# Copyright (C) 2024 Dimpact
+# Generated by Django 3.2.23 on 2024-01-22 14:39
+
+import django.contrib.postgres.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("documenten", "0030_enkelvoudiginformatieobject_verschijningsvorm"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="enkelvoudiginformatieobject",
+            name="trefwoorden",
+            field=django.contrib.postgres.fields.ArrayField(
+                base_field=models.CharField(max_length=100, verbose_name="trefwoord"),
+                blank=True,
+                db_index=True,
+                default=list,
+                help_text="Een lijst van trefwoorden gescheiden door comma's.",
+                size=None,
+            ),
+        ),
+    ]

src/openzaak/components/documenten/models.py

@@ -5,6 +5,7 @@
 from urllib.parse import urlparse
 
 from django.conf import settings
+from django.contrib.postgres.fields import ArrayField
 from django.core.validators import MaxValueValidator, MinValueValidator
 from django.db import models, transaction
 from django.db.models import Q
@@ -417,6 +418,14 @@ class EnkelvoudigInformatieObject(
         help_text=_("De essentiële opmaakaspecten van een INFORMATIEOBJECT."),
     )
 
+    trefwoorden = ArrayField(
+        models.CharField(_("trefwoord"), max_length=100),
+        blank=True,
+        default=list,
+        help_text=_("Een lijst van trefwoorden gescheiden door comma's."),
+        db_index=True,
+    )
+
     # 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.
     _locked = False

src/openzaak/components/documenten/openapi.yaml

@@ -160,6 +160,16 @@ paths:
         required: false
         schema:
           type: string
+      - name: trefwoorden
+        in: query
+        description: Multiple values may be separated by commas.
+        required: false
+        schema:
+          type: array
+          items:
+            type: string
+        style: form
+        explode: false
       - name: expand
         in: query
         description: 'Sluit de gespecifieerde gerelateerde resources in in het antwoord. '
@@ -3159,6 +3169,14 @@ components:
           items:
             $ref: '#/components/schemas/BestandsDeel'
           readOnly: true
+        trefwoorden:
+          description: Een lijst van trefwoorden gescheiden door comma's.
+          type: array
+          items:
+            title: Trefwoord
+            type: string
+            maxLength: 100
+            minLength: 1
     EnkelvoudigInformatieObjectCreateLockData:
       required:
       - bronorganisatie
@@ -3385,6 +3403,14 @@ components:
           items:
             $ref: '#/components/schemas/BestandsDeel'
           readOnly: true
+        trefwoorden:
+          description: Een lijst van trefwoorden gescheiden door comma's.
+          type: array
+          items:
+            title: Trefwoord
+            type: string
+            maxLength: 100
+            minLength: 1
         lock:
           title: Lock
           description: Het gegenereerde lock ID voor grote bestandsuploads wat gebruikt
@@ -3417,6 +3443,12 @@ components:
             \ eerste in een samenwerkingsketen heeft vastgelegd."
           type: string
           minLength: 1
+        trefwoorden:
+          description: Multiple values may be separated by commas.
+          type: array
+          items:
+            type: string
+            nullable: true
         expand:
           title: Expand
           description: "Sluit de gespecifieerde gerelateerde resources in in het antwoord.\
@@ -3650,6 +3682,14 @@ components:
           items:
             $ref: '#/components/schemas/BestandsDeel'
           readOnly: true
+        trefwoorden:
+          description: Een lijst van trefwoorden gescheiden door comma's.
+          type: array
+          items:
+            title: Trefwoord
+            type: string
+            maxLength: 100
+            minLength: 1
     Wijzigingen:
       type: object
       properties:
@@ -4038,6 +4078,14 @@ components:
           items:
             $ref: '#/components/schemas/BestandsDeel'
           readOnly: true
+        trefwoorden:
+          description: Een lijst van trefwoorden gescheiden door comma's.
+          type: array
+          items:
+            title: Trefwoord
+            type: string
+            maxLength: 100
+            minLength: 1
         lock:
           title: Lock
           description: Tijdens het updaten van een document (PATCH, PUT) moet het

src/openzaak/components/documenten/resources.md

@@ -65,6 +65,7 @@ Uitleg bij mogelijke waarden:
 | 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~~ |
+| trefwoorden | Een lijst van trefwoorden gescheiden door comma's. | array | nee | C​R​U​D |
 
 ## AuditTrail
 

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

@@ -161,6 +161,21 @@
                         "required": false,
                         "type": "string"
                     },
+                    {
+                        "name": "trefwoorden",
+                        "in": "query",
+                        "description": "Multiple values may be separated by commas.",
+                        "required": false,
+                        "type": "array",
+                        "schema": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "style": "form",
+                        "explode": false
+                    },
                     {
                         "name": "expand",
                         "in": "query",
@@ -3859,6 +3874,16 @@
                         "$ref": "#/definitions/BestandsDeel"
                     },
                     "readOnly": true
+                },
+                "trefwoorden": {
+                    "description": "Een lijst van trefwoorden gescheiden door comma's.",
+                    "type": "array",
+                    "items": {
+                        "title": "Trefwoord",
+                        "type": "string",
+                        "maxLength": 100,
+                        "minLength": 1
+                    }
                 }
             }
         },
@@ -4052,6 +4077,16 @@
                     },
                     "readOnly": true
                 },
+                "trefwoorden": {
+                    "description": "Een lijst van trefwoorden gescheiden door comma's.",
+                    "type": "array",
+                    "items": {
+                        "title": "Trefwoord",
+                        "type": "string",
+                        "maxLength": 100,
+                        "minLength": 1
+                    }
+                },
                 "lock": {
                     "title": "Lock",
                     "description": "Het gegenereerde lock ID voor grote bestandsuploads wat gebruikt moet worden bij document updates. Documenten met base64-encoded bestandsdata worden zonder lock aangemaakt.",
@@ -4087,6 +4122,14 @@
                     "type": "string",
                     "minLength": 1
                 },
+                "trefwoorden": {
+                    "description": "Multiple values may be separated by commas.",
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "x-nullable": true
+                    }
+                },
                 "expand": {
                     "title": "Expand",
                     "description": "Sluit de gespecifieerde gerelateerde resources in in het antwoord. \n\nUitleg bij mogelijke waarden:\n\n* `informatieobjecttype` - informatieobjecttype",
@@ -4286,6 +4329,16 @@
                         "$ref": "#/definitions/BestandsDeel"
                     },
                     "readOnly": true
+                },
+                "trefwoorden": {
+                    "description": "Een lijst van trefwoorden gescheiden door comma's.",
+                    "type": "array",
+                    "items": {
+                        "title": "Trefwoord",
+                        "type": "string",
+                        "maxLength": 100,
+                        "minLength": 1
+                    }
                 }
             }
         },
@@ -4621,6 +4674,16 @@
                     },
                     "readOnly": true
                 },
+                "trefwoorden": {
+                    "description": "Een lijst van trefwoorden gescheiden door comma's.",
+                    "type": "array",
+                    "items": {
+                        "title": "Trefwoord",
+                        "type": "string",
+                        "maxLength": 100,
+                        "minLength": 1
+                    }
+                },
                 "lock": {
                     "title": "Lock",
                     "description": "Tijdens het updaten van een document (PATCH, PUT) moet het `lock` veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde hebben.",

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

@@ -61,6 +61,7 @@ def test_create(self):
             "informatieobjecttype": f"http://testserver{informatieobjecttype_url}",
             "vertrouwelijkheidaanduiding": "openbaar",
             "verschijningsvorm": "Vorm A",
+            "trefwoorden": ["some", "other"],
         }
 
         # Send to the API
@@ -89,6 +90,7 @@ def test_create(self):
         self.assertEqual(stored_object.informatieobjecttype, informatieobjecttype)
         self.assertEqual(stored_object.vertrouwelijkheidaanduiding, "openbaar")
         self.assertEqual(stored_object.verschijningsvorm, "Vorm A")
+        self.assertEqual(stored_object.trefwoorden, ["some", "other"])
 
         expected_url = reverse(stored_object)
         expected_file_url = get_operation_url(
@@ -263,6 +265,7 @@ def test_read(self):
             "informatieobjecttype": f"http://testserver{reverse(test_object.informatieobjecttype)}",
             "locked": False,
             "verschijningsvorm": "",
+            "trefwoorden": [],
         }
 
         response_data = response.json()
@@ -1072,3 +1075,16 @@ def test_retrieve_expand(self):
         }
 
         self.assertEqual(data, expected_results)
+
+    def test_trefwoorden(self):
+        eio = EnkelvoudigInformatieObjectFactory.create(trefwoorden=["some", "other"])
+        EnkelvoudigInformatieObjectFactory.create(trefwoorden=[])
+        EnkelvoudigInformatieObjectFactory.create(trefwoorden=["dummy"])
+
+        response = self.client.get(self.url, {"trefwoorden": "some"})
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()["results"]
+        self.assertEqual(len(data), 1)
+        self.assertEqual(data[0]["url"], f"http://testserver{reverse(eio)}")

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

@@ -124,6 +124,7 @@ def test_create(self):
                 "locked": False,
                 "lock": "",
                 "verschijningsvorm": "",
+                "trefwoorden": [],
             }
         )
 
@@ -306,6 +307,7 @@ def test_read(self):
             "informatieobjecttype": f"http://testserver{reverse(test_object.informatieobjecttype)}",
             "locked": False,
             "verschijningsvorm": "",
+            "trefwoorden": [],
         }
 
         response_data = response.json()

src/openzaak/utils/filters.py

@@ -8,6 +8,10 @@
 from .expansion import get_expand_options_for_serializer
 
 
+class CharArrayFilter(filters.BaseInFilter, filters.CharFilter):
+    pass
+
+
 class MaximaleVertrouwelijkheidaanduidingFilter(filters.ChoiceFilter):
     def __init__(self, *args, **kwargs):
         kwargs.setdefault("choices", VertrouwelijkheidsAanduiding.choices)