📝 [#525] deprecate api fields and filters

Author: Floris272

src/openklant/components/klantinteracties/api/serializers/internetaken.py

@@ -35,7 +35,7 @@ class Meta:
         }
 
 
-@extend_schema_serializer(deprecate_fields=["toegewezen_aan_actor"])
+@extend_schema_serializer(deprecate_fields=["toegewezen_aan_actor", "nummer"])
 class InterneTaakSerializer(serializers.HyperlinkedModelSerializer):
     toegewezen_aan_actor = ActorForeignKeySerializer(
         required=False,

src/openklant/components/klantinteracties/api/serializers/klantcontacten.py

@@ -2,7 +2,7 @@
 from django.utils.translation import gettext_lazy as _
 
 import structlog
-from drf_spectacular.utils import extend_schema_field
+from drf_spectacular.utils import extend_schema_field, extend_schema_serializer
 from rest_framework import serializers
 from vng_api_common.serializers import GegevensGroepSerializer, NestedGegevensGroepMixin
 
@@ -261,6 +261,7 @@ def create(self, validated_data):
         return super().create(validated_data)
 
 
+@extend_schema_serializer(deprecate_fields=["nummer"])
 class KlantcontactSerializer(serializers.HyperlinkedModelSerializer):
     from openklant.components.klantinteracties.api.serializers.internetaken import (
         InterneTaakForeignKeySerializer,

src/openklant/components/klantinteracties/api/serializers/partijen.py

@@ -467,6 +467,7 @@ def create(self, validated_data):
         return super().create(validated_data)
 
 
+@extend_schema_serializer(deprecate_fields=["nummer"])
 class PartijSerializer(NestedGegevensGroepMixin, PolymorphicSerializer):
     from openklant.components.klantinteracties.api.serializers.rekeningnummers import (
         RekeningnummerForeignKeySerializer,

src/openklant/components/klantinteracties/api/viewsets/internetaken.py

@@ -1,7 +1,7 @@
 from django.db import transaction
 
 import structlog
-from drf_spectacular.utils import extend_schema, extend_schema_view
+from drf_spectacular.utils import OpenApiParameter, extend_schema, extend_schema_view
 from notifications_api_common.viewsets import NotificationViewSetMixin
 from rest_framework import viewsets
 from vng_api_common.pagination import DynamicPageSizePagination
@@ -32,6 +32,10 @@
     list=extend_schema(
         summary="Alle interne taken opvragen.",
         description="Alle interne taken opvragen.",
+        parameters=[
+            OpenApiParameter(name="nummer", deprecated=True),
+            OpenApiParameter(name="klantcontact__nummer", deprecated=True),
+        ],
     ),
     retrieve=extend_schema(
         summary="Een specifiek interne taak opvragen.",

src/openklant/components/klantinteracties/api/viewsets/klantcontacten.py

@@ -65,6 +65,7 @@
     list=extend_schema(
         summary="Alle klanten contacten opvragen.",
         description="Alle klanten contacten opvragen.",
+        parameters=[OpenApiParameter(name="nummer", deprecated=True)],
     ),
     retrieve=extend_schema(
         summary="Een specifiek klant contact opvragen.",
@@ -178,6 +179,10 @@ def perform_destroy(self, instance):
     list=extend_schema(
         summary="Alle betrokkenen opvragen.",
         description="Alle betrokkenen opvragen.",
+        parameters=[
+            OpenApiParameter(name="hadKlantcontact__nummer", deprecated=True),
+            OpenApiParameter(name="wasPartij__nummer", deprecated=True),
+        ],
     ),
     retrieve=extend_schema(
         summary="Een specifiek betrokkene opvragen.",

src/openklant/components/klantinteracties/api/viewsets/partijen.py

@@ -51,6 +51,7 @@
     list=extend_schema(
         summary="Alle partijen opvragen.",
         description="Alle partijen opvragen.",
+        parameters=[OpenApiParameter(name="nummer", deprecated=True)],
     ),
     retrieve=extend_schema(
         summary="Een specifiek partij opvragen.",
@@ -276,6 +277,7 @@ def perform_destroy(self, instance):
     list=extend_schema(
         summary="Alle categorie relaties opvragen.",
         description="Alle categorie relaties opvragen, Let op: Dit endpoint is EXPERIMENTEEL.",
+        parameters=[OpenApiParameter(name="partij__nummer", deprecated=True)],
     ),
     retrieve=extend_schema(
         summary="Een specifiek categorie relatie opvragen..",

…internetaak_referentienummer_and_more.py …internetaak_referentienummer_and_more.pysrc/openklant/components/klantinteracties/migrations/0040_internetaak_referentienummer_and_more.py renamed to src/openklant/components/klantinteracties/migrations/0041_internetaak_referentienummer_and_more.py src/openklant/components/klantinteracties/migrations/0040_internetaak_referentienummer_and_more.py renamed to src/openklant/components/klantinteracties/migrations/0041_internetaak_referentienummer_and_more.py

@@ -1,4 +1,4 @@
-# Generated by Django 5.2.11 on 2026-02-09 16:02
+# Generated by Django 5.2.11 on 2026-02-10 14:55
 
 import django.core.validators
 from django.db import migrations, models
@@ -7,7 +7,7 @@
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('klantinteracties', '0039_alter_digitaaladres_betrokkene'),
+        ('klantinteracties', '0040_klantcontact_metadata'),
     ]
 
     operations = [

src/openklant/components/klantinteracties/openapi.yaml

@@ -514,7 +514,7 @@ paths:
         name: hadKlantcontact__nummer
         schema:
           type: string
-        description: Zoek betrokkene object op basis van het klantcontact nummer
+        deprecated: true
       - in: query
         name: hadKlantcontact__referentienummer
         schema:
@@ -572,7 +572,7 @@ paths:
         name: wasPartij__nummer
         schema:
           type: string
-        description: Zoek betrokkene object op basis van het partij nummer
+        deprecated: true
       - in: query
         name: wasPartij__partijIdentificator__codeObjecttype
         schema:
@@ -1059,7 +1059,7 @@ paths:
         name: partij__nummer
         schema:
           type: string
-        description: Zoek categorie relatie object op basis van het partij nummer.
+        deprecated: true
       - in: query
         name: partij__url
         schema:
@@ -1819,9 +1819,7 @@ paths:
         name: klantcontact__nummer
         schema:
           type: string
-        description: '**DEPRECATED** Uniek identificerend nummer dat tijdens communicatie
-          tussen mensen kan worden gebruikt om het specifieke klantcontact aan te
-          duiden.'
+        deprecated: true
       - in: query
         name: klantcontact__referentienummer
         schema:
@@ -1839,8 +1837,7 @@ paths:
         name: nummer
         schema:
           type: string
-        description: '**DEPRECATED** Uniek identificerend nummer dat tijdens communicatie
-          tussen mensen kan worden gebruikt om de specifieke interne taak aan te duiden.'
+        deprecated: true
       - name: page
         required: false
         in: query
@@ -2148,9 +2145,7 @@ paths:
         name: nummer
         schema:
           type: string
-        description: '**DEPRECATED** Uniek identificerend nummer dat tijdens communicatie
-          tussen mensen kan worden gebruikt om het specifieke klantcontact aan te
-          duiden.'
+        deprecated: true
       - in: query
         name: onderwerp
         schema:
@@ -3071,8 +3066,7 @@ paths:
         name: nummer
         schema:
           type: string
-        description: '**DEPRECATED** Uniek identificerend nummer dat tijdens communicatie
-          tussen mensen kan worden gebruikt om de specifieke partij aan te duiden.'
+        deprecated: true
       - name: page
         required: false
         in: query
@@ -4042,6 +4036,7 @@ components:
           description: '**DEPRECATED** Uniek identificerend nummer dat tijdens communicatie
             tussen mensen kan worden gebruikt om de specifieke partij aan te duiden.'
           maxLength: 10
+          deprecated: true
         interneNotitie:
           type: string
           description: Mededelingen, aantekeningen of bijzonderheden over de partij,
@@ -4953,6 +4948,7 @@ components:
             tussen mensen kan worden gebruikt om de specifieke interne taak aan te
             duiden.'
           maxLength: 10
+          deprecated: true
         referentienummer:
           type: string
           nullable: true
@@ -5078,6 +5074,7 @@ components:
             tussen mensen kan worden gebruikt om het specifieke klantcontact aan te
             duiden.'
           maxLength: 10
+          deprecated: true
         referentienummer:
           type: string
           nullable: true
@@ -6323,6 +6320,7 @@ components:
             tussen mensen kan worden gebruikt om de specifieke interne taak aan te
             duiden.'
           maxLength: 10
+          deprecated: true
         referentienummer:
           type: string
           nullable: true
@@ -6424,6 +6422,7 @@ components:
             tussen mensen kan worden gebruikt om het specifieke klantcontact aan te
             duiden.'
           maxLength: 10
+          deprecated: true
         referentienummer:
           type: string
           nullable: true