Add documentation for DigitaalAdres.adres validation

maykinmedia · Nov 26, 2024 · f2447af · f2447af
1 parent e594b7f
commit f2447af
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 4 deletions.
diff --git a/src/openklant/components/klantinteracties/api/serializers/digitaal_adres.py b/src/openklant/components/klantinteracties/api/serializers/digitaal_adres.py
@@ -84,6 +84,16 @@ class Meta:
         )
         extra_kwargs = {
             "uuid": {"read_only": True},
+            "adres": {
+                "help_text": _(
+                    "Validatie van dit veld is afhankelijk van het opgegeven "
+                    "`soortDigitaalAdres`. De validatie die toegepast wordt voor "
+                    " e-mailadressen is te lezen via de volgende URL: "
+                    "https://github.com/django/django/blob/4.2/django/core/validators.py#L174."
+                    "Voor telefoonnummers wordt de volgende regex expressie toegepast ter "
+                    "validatie: `(0[8-9]00[0-9]{4,7})|(0[1-9][0-9]{8})|(\\+[0-9]{9,20}|1400|140[0-9]{2,3})`."
+                )
+            },
             "url": {
                 "view_name": "klantinteracties:digitaaladres-detail",
                 "lookup_field": "uuid",

diff --git a/src/openklant/components/klantinteracties/openapi.yaml b/src/openklant/components/klantinteracties/openapi.yaml
@@ -3455,8 +3455,11 @@ components:
             contact met de gemeente.
         adres:
           type: string
-          description: Digitaal adres waarmee een persoon of organisatie bereikt kan
-            worden.
+          description: 'Validatie van dit veld is afhankelijk van het opgegeven `soortDigitaalAdres`.
+            De validatie die toegepast wordt voor  e-mailadressen is te lezen via
+            de volgende URL: https://github.com/django/django/blob/4.2/django/core/validators.py#L174.Voor
+            telefoonnummers wordt de volgende regex expressie toegepast ter validatie:
+            `(0[8-9]00[0-9]{4,7})|(0[1-9][0-9]{8})|(\+[0-9]{9,20}|1400|140[0-9]{2,3})`.'
           maxLength: 80
         soortDigitaalAdres:
           allOf:
@@ -4864,8 +4867,11 @@ components:
             contact met de gemeente.
         adres:
           type: string
-          description: Digitaal adres waarmee een persoon of organisatie bereikt kan
-            worden.
+          description: 'Validatie van dit veld is afhankelijk van het opgegeven `soortDigitaalAdres`.
+            De validatie die toegepast wordt voor  e-mailadressen is te lezen via
+            de volgende URL: https://github.com/django/django/blob/4.2/django/core/validators.py#L174.Voor
+            telefoonnummers wordt de volgende regex expressie toegepast ter validatie:
+            `(0[8-9]00[0-9]{4,7})|(0[1-9][0-9]{8})|(\+[0-9]{9,20}|1400|140[0-9]{2,3})`.'
           maxLength: 80
         soortDigitaalAdres:
           allOf: