Merge pull request #1517 from open-zaak/feature/1490-restore-descripi…

…ton-for-TextChoices

📝[#1490] return text choice descriptions

requirements/base.txt

@@ -1,6 +1,6 @@
 #
-# This file is autogenerated by pip-compile with Python 3.10
-# by the following command:
+# This file is autogenerated by pip-compile with python 3.10
+# To update, run:
 #
 #    ./bin/compile_dependencies.sh
 #
@@ -57,7 +57,7 @@ click-repl==0.2.0
     # via celery
 cmislib-maykin==0.7.4
     # via drc-cmis
-commonground-api-common==1.12.0
+commonground-api-common==1.12.2
     # via
     #   -r requirements/base.in
     #   drc-cmis

requirements/ci.txt

@@ -1,6 +1,6 @@
 #
-# This file is autogenerated by pip-compile with Python 3.10
-# by the following command:
+# This file is autogenerated by pip-compile with python 3.10
+# To update, run:
 #
 #    ./bin/compile_dependencies.sh
 #
@@ -90,7 +90,7 @@ cmislib-maykin==0.7.4
     # via
     #   -r requirements/base.txt
     #   drc-cmis
-commonground-api-common==1.12.0
+commonground-api-common==1.12.2
     # via
     #   -r requirements/base.txt
     #   drc-cmis

requirements/dev.txt

@@ -1,6 +1,6 @@
 #
-# This file is autogenerated by pip-compile with Python 3.10
-# by the following command:
+# This file is autogenerated by pip-compile with python 3.10
+# To update, run:
 #
 #    ./bin/compile_dependencies.sh
 #
@@ -107,7 +107,7 @@ cmislib-maykin==0.7.4
     # via
     #   -r requirements/ci.txt
     #   drc-cmis
-commonground-api-common==1.12.0
+commonground-api-common==1.12.2
     # via
     #   -r requirements/ci.txt
     #   drc-cmis

src/openzaak/components/catalogi/openapi.yaml

@@ -10553,20 +10553,35 @@ components:
           allOf:
           - $ref: '#/components/schemas/AfleidingswijzeEnum'
           title: Afleidingswijze brondatum
-          description: |-
-            Wijze van bepalen van de brondatum.
-
-            Uitleg bij mogelijke waarden:
-
-            * `afgehandeld` - Afgehandeld
-            * `ander_datumkenmerk` - Ander datumkenmerk
-            * `eigenschap` - Eigenschap
-            * `gerelateerde_zaak` - Gerelateerde zaak
-            * `hoofdzaak` - Hoofdzaak
-            * `ingangsdatum_besluit` - Ingangsdatum besluit
-            * `termijn` - Termijn
-            * `vervaldatum_besluit` - Vervaldatum besluit
-            * `zaakobject` - Zaakobject
+          description: "Wijze van bepalen van de brondatum.\n\nUitleg bij mogelijke\
+            \ waarden:\n\n* `afgehandeld` - (Afgehandeld) De termijn start op de datum\
+            \ waarop de zaak is afgehandeld (ZAAK.Einddatum in het RGBZ).\n* `ander_datumkenmerk`\
+            \ - (Ander datumkenmerk) De termijn start op de datum die is vastgelegd\
+            \ in een ander datumveld dan de datumvelden waarop de overige waarden\
+            \ (van deze attribuutsoort) betrekking hebben. `Objecttype`, `Registratie`\
+            \ en `Datumkenmerk` zijn niet leeg.\n* `eigenschap` - (Eigenschap) De\
+            \ termijn start op de datum die is vastgelegd in een ander datumveld dan\
+            \ de datumvelden waarop de overige waarden (van deze attribuutsoort) betrekking\
+            \ hebben. `Objecttype`, `Registratie` en `Datumkenmerk` zijn niet leeg.\n\
+            * `gerelateerde_zaak` - (Gerelateerde zaak) De termijn start op de datum\
+            \ waarop de gerelateerde zaak is afgehandeld (`ZAAK.Einddatum` of `ZAAK.Gerelateerde_zaak.Einddatum`\
+            \ in het RGBZ). `ResultaatType.ZaakType` heeft gerelateerd `ZaakType`\n\
+            * `hoofdzaak` - (Hoofdzaak) De termijn start op de datum waarop de gerelateerde\
+            \ zaak is afgehandeld, waarvan de zaak een deelzaak is (`ZAAK.Einddatum`\
+            \ van de hoofdzaak in het RGBZ). ResultaatType.ZaakType is deelzaaktype\
+            \ van ZaakType.\n* `ingangsdatum_besluit` - (Ingangsdatum besluit) De\
+            \ termijn start op de datum waarop het besluit van kracht wordt (`BESLUIT.Ingangsdatum`\
+            \ in het RGBZ).\tResultaatType.ZaakType heeft relevant BesluitType\n*\
+            \ `termijn` - (Termijn) De termijn start een vast aantal jaren na de datum\
+            \ waarop de zaak is afgehandeld (`ZAAK.Einddatum` in het RGBZ).\n* `vervaldatum_besluit`\
+            \ - (Vervaldatum besluit) De termijn start op de dag na de datum waarop\
+            \ het besluit vervalt (`BESLUIT.Vervaldatum` in het RGBZ). ResultaatType.ZaakType\
+            \ heeft relevant BesluitType\n* `zaakobject` - (Zaakobject) De termijn\
+            \ start op de einddatum geldigheid van het zaakobject waarop de zaak betrekking\
+            \ heeft (bijvoorbeeld de overlijdendatum van een Persoon). M.b.v. de attribuutsoort\
+            \ `Objecttype` wordt vastgelegd om welke zaakobjecttype het gaat; m.b.v.\
+            \ de attribuutsoort `Datumkenmerk` wordt vastgelegd welke datum-attribuutsoort\
+            \ van het zaakobjecttype het betreft."
         datumkenmerk:
           type: string
           description: Naam van de attribuutsoort van het procesobject dat bepalend
@@ -10639,20 +10654,35 @@ components:
           allOf:
           - $ref: '#/components/schemas/AfleidingswijzeEnum'
           title: Afleidingswijze brondatum
-          description: |-
-            Wijze van bepalen van de brondatum.
-
-            Uitleg bij mogelijke waarden:
-
-            * `afgehandeld` - Afgehandeld
-            * `ander_datumkenmerk` - Ander datumkenmerk
-            * `eigenschap` - Eigenschap
-            * `gerelateerde_zaak` - Gerelateerde zaak
-            * `hoofdzaak` - Hoofdzaak
-            * `ingangsdatum_besluit` - Ingangsdatum besluit
-            * `termijn` - Termijn
-            * `vervaldatum_besluit` - Vervaldatum besluit
-            * `zaakobject` - Zaakobject
+          description: "Wijze van bepalen van de brondatum.\n\nUitleg bij mogelijke\
+            \ waarden:\n\n* `afgehandeld` - (Afgehandeld) De termijn start op de datum\
+            \ waarop de zaak is afgehandeld (ZAAK.Einddatum in het RGBZ).\n* `ander_datumkenmerk`\
+            \ - (Ander datumkenmerk) De termijn start op de datum die is vastgelegd\
+            \ in een ander datumveld dan de datumvelden waarop de overige waarden\
+            \ (van deze attribuutsoort) betrekking hebben. `Objecttype`, `Registratie`\
+            \ en `Datumkenmerk` zijn niet leeg.\n* `eigenschap` - (Eigenschap) De\
+            \ termijn start op de datum die is vastgelegd in een ander datumveld dan\
+            \ de datumvelden waarop de overige waarden (van deze attribuutsoort) betrekking\
+            \ hebben. `Objecttype`, `Registratie` en `Datumkenmerk` zijn niet leeg.\n\
+            * `gerelateerde_zaak` - (Gerelateerde zaak) De termijn start op de datum\
+            \ waarop de gerelateerde zaak is afgehandeld (`ZAAK.Einddatum` of `ZAAK.Gerelateerde_zaak.Einddatum`\
+            \ in het RGBZ). `ResultaatType.ZaakType` heeft gerelateerd `ZaakType`\n\
+            * `hoofdzaak` - (Hoofdzaak) De termijn start op de datum waarop de gerelateerde\
+            \ zaak is afgehandeld, waarvan de zaak een deelzaak is (`ZAAK.Einddatum`\
+            \ van de hoofdzaak in het RGBZ). ResultaatType.ZaakType is deelzaaktype\
+            \ van ZaakType.\n* `ingangsdatum_besluit` - (Ingangsdatum besluit) De\
+            \ termijn start op de datum waarop het besluit van kracht wordt (`BESLUIT.Ingangsdatum`\
+            \ in het RGBZ).\tResultaatType.ZaakType heeft relevant BesluitType\n*\
+            \ `termijn` - (Termijn) De termijn start een vast aantal jaren na de datum\
+            \ waarop de zaak is afgehandeld (`ZAAK.Einddatum` in het RGBZ).\n* `vervaldatum_besluit`\
+            \ - (Vervaldatum besluit) De termijn start op de dag na de datum waarop\
+            \ het besluit vervalt (`BESLUIT.Vervaldatum` in het RGBZ). ResultaatType.ZaakType\
+            \ heeft relevant BesluitType\n* `zaakobject` - (Zaakobject) De termijn\
+            \ start op de einddatum geldigheid van het zaakobject waarop de zaak betrekking\
+            \ heeft (bijvoorbeeld de overlijdendatum van een Persoon). M.b.v. de attribuutsoort\
+            \ `Objecttype` wordt vastgelegd om welke zaakobjecttype het gaat; m.b.v.\
+            \ de attribuutsoort `Datumkenmerk` wordt vastgelegd welke datum-attribuutsoort\
+            \ van het zaakobjecttype het betreft."
         datumkenmerk:
           type: string
           description: Naam van de attribuutsoort van het procesobject dat bepalend
@@ -12020,19 +12050,19 @@ components:
         omschrijvingGeneriek:
           allOf:
           - $ref: '#/components/schemas/OmschrijvingGeneriekEnum'
-          description: |-
-            Algemeen gehanteerde omschrijving van de aard van de ROL.
-
-            Uitleg bij mogelijke waarden:
-
-            * `adviseur` - Adviseur
-            * `behandelaar` - Behandelaar
-            * `belanghebbende` - Belanghebbende
-            * `beslisser` - Beslisser
-            * `initiator` - Initiator
-            * `klantcontacter` - Klantcontacter
-            * `zaakcoordinator` - Zaakcoördinator
-            * `mede_initiator` - Mede-initiator
+          description: "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\
+            \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\
+            \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\
+            \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\
+            \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\
+            \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\
+            \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\
+            \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\
+            \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\
+            \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\
+            \ en bedrijven ..\n* `zaakcoordinator` - (Zaakcoördinator) Er voor zorg\
+            \ dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\
+            \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - (Mede-initiator) "
         beginGeldigheid:
           type: string
           format: date
@@ -12735,19 +12765,19 @@ components:
         omschrijvingGeneriek:
           allOf:
           - $ref: '#/components/schemas/OmschrijvingGeneriekEnum'
-          description: |-
-            Algemeen gehanteerde omschrijving van de aard van de ROL.
-
-            Uitleg bij mogelijke waarden:
-
-            * `adviseur` - Adviseur
-            * `behandelaar` - Behandelaar
-            * `belanghebbende` - Belanghebbende
-            * `beslisser` - Beslisser
-            * `initiator` - Initiator
-            * `klantcontacter` - Klantcontacter
-            * `zaakcoordinator` - Zaakcoördinator
-            * `mede_initiator` - Mede-initiator
+          description: "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\
+            \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\
+            \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\
+            \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\
+            \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\
+            \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\
+            \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\
+            \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\
+            \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\
+            \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\
+            \ en bedrijven ..\n* `zaakcoordinator` - (Zaakcoördinator) Er voor zorg\
+            \ dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\
+            \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - (Mede-initiator) "
         catalogus:
           type: string
           format: uri
@@ -12794,19 +12824,19 @@ components:
         omschrijvingGeneriek:
           allOf:
           - $ref: '#/components/schemas/OmschrijvingGeneriekEnum'
-          description: |-
-            Algemeen gehanteerde omschrijving van de aard van de ROL.
-
-            Uitleg bij mogelijke waarden:
-
-            * `adviseur` - Adviseur
-            * `behandelaar` - Behandelaar
-            * `belanghebbende` - Belanghebbende
-            * `beslisser` - Beslisser
-            * `initiator` - Initiator
-            * `klantcontacter` - Klantcontacter
-            * `zaakcoordinator` - Zaakcoördinator
-            * `mede_initiator` - Mede-initiator
+          description: "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\
+            \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\
+            \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\
+            \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\
+            \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\
+            \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\
+            \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\
+            \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\
+            \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\
+            \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\
+            \ en bedrijven ..\n* `zaakcoordinator` - (Zaakcoördinator) Er voor zorg\
+            \ dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\
+            \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - (Mede-initiator) "
         beginGeldigheid:
           type: string
           format: date

src/openzaak/components/documenten/constants.py

@@ -1,12 +1,15 @@
 # SPDX-License-Identifier: EUPL-1.2
 # Copyright (C) 2019 - 2020 Dimpact
+from typing import Dict
+
 from django.db import models
 from django.utils.translation import ugettext_lazy as _
 
 from vng_api_common import constants
+from vng_api_common.choices import TextChoicesWithDescriptions
 
 
-class Statussen(models.TextChoices):
+class Statussen(TextChoicesWithDescriptions):
     in_bewerking = "in_bewerking", _("In bewerking")
     ter_vaststelling = "ter_vaststelling", _("Ter vaststelling")
     definitief = "definitief", _("Definitief")
@@ -16,6 +19,21 @@ class Statussen(models.TextChoices):
     def invalid_for_received(cls) -> tuple:
         return cls.in_bewerking, cls.ter_vaststelling
 
+    @classmethod
+    def descriptions(cls) -> Dict[str, str]:
+        return {
+            cls.in_bewerking: _("Aan het informatieobject wordt nog gewerkt."),
+            cls.ter_vaststelling: _(
+                "Informatieobject gereed maar moet nog vastgesteld " "worden."
+            ),
+            cls.definitief: _(
+                "Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen."
+            ),
+            cls.gearchiveerd: _(
+                "Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element."
+            ),
+        }
+
 
 class ChecksumAlgoritmes(models.TextChoices):
     crc_16 = "crc_16", _("CRC-16")

src/openzaak/components/documenten/openapi.yaml

@@ -5985,10 +5985,10 @@ components:
 
             Uitleg bij mogelijke waarden:
 
-            * `in_bewerking` - In bewerking
-            * `ter_vaststelling` - Ter vaststelling
-            * `definitief` - Definitief
-            * `gearchiveerd` - Gearchiveerd
+            * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt.
+            * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden.
+            * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen.
+            * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.
           oneOf:
           - $ref: '#/components/schemas/StatusEnum'
           - $ref: '#/components/schemas/BlankEnum'
@@ -6169,10 +6169,10 @@ components:
 
             Uitleg bij mogelijke waarden:
 
-            * `in_bewerking` - In bewerking
-            * `ter_vaststelling` - Ter vaststelling
-            * `definitief` - Definitief
-            * `gearchiveerd` - Gearchiveerd
+            * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt.
+            * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden.
+            * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen.
+            * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.
           oneOf:
           - $ref: '#/components/schemas/StatusEnum'
           - $ref: '#/components/schemas/BlankEnum'
@@ -6332,10 +6332,10 @@ components:
 
             Uitleg bij mogelijke waarden:
 
-            * `in_bewerking` - In bewerking
-            * `ter_vaststelling` - Ter vaststelling
-            * `definitief` - Definitief
-            * `gearchiveerd` - Gearchiveerd
+            * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt.
+            * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden.
+            * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen.
+            * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.
           oneOf:
           - $ref: '#/components/schemas/StatusEnum'
           - $ref: '#/components/schemas/BlankEnum'
@@ -7038,10 +7038,10 @@ components:
 
             Uitleg bij mogelijke waarden:
 
-            * `in_bewerking` - In bewerking
-            * `ter_vaststelling` - Ter vaststelling
-            * `definitief` - Definitief
-            * `gearchiveerd` - Gearchiveerd
+            * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt.
+            * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden.
+            * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen.
+            * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.
           oneOf:
           - $ref: '#/components/schemas/StatusEnum'
           - $ref: '#/components/schemas/BlankEnum'