[#66] update zgw consumers (#196)

--------- Co-authored-by: Steven Bal <steven@maykinmedia.nl>
open-zaak · Nov 29, 2024 · fa08b63 · fa08b63
1 parent 0193368
commit fa08b63
Show file tree

Hide file tree

Showing 20 changed files with 184 additions and 157 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,6 +2,20 @@
 Changes
 =======
 
+1.x.x (TBD)
+-----------
+**Bugfixes and QOL**
+
+* [#66] updated commonground-api-common to 2.1.0 (TBD)
+
+.. warning::
+
+    Configuring external services is now done through the `Service` model. This
+    replaces the `APICredential` model in the admin interface. A data migration
+    was added to move to the `Service` model. It is advised to verify the `Service`
+    instances in the admin to check that the data migration was ran as expected.
+
+
 1.7.1 (2024-10-04)
 ------------------
 

diff --git a/docs/installation/configuration/opennotifs_config.rst b/docs/installation/configuration/opennotifs_config.rst
@@ -36,17 +36,19 @@ using Open Zaak as the example.
 1. Configure the credentials for the Open Zaak Autorisaties API (so Open
    Notificaties can access the Autorisaties API):
 
-   a. Navigate to **API Autorisaties > Externe API credentials**
-   b. Click **Externe API credential toevoegen**.
+   a. Navigate to **API Autorisaties > Services**
+   b. Click **Service toevoegen**.
    c. Fill out the form:
 
-      - **API root**: *The URL of the Open Zaak Autorisaties API endpoint*
+      - **Api root url**: *The URL of the Open Zaak Autorisaties API endpoint*
       - **Label**: *For example:* ``Open Zaak Autorisaties``
 
-      - **Client ID**: *For example:* ``open-notificaties``
+      - **Client id**: *For example:* ``open-notificaties``
       - **Secret**: *Some random string*
-      - **User ID**: *Same as the Client ID*
-      - **User representation**: *For example:* ``Open Notificaties``
+      - **Authorization type**: *ZGW client_id + secret*
+      - **Gebruikers ID**: *Same as the Client ID*
+      - **Gebruikersweergave**: *For example:* ``Open Notificaties``
+      - **Service slug**: *For example:* ``authorization-api-service``
 
       Make sure Open Notificaties is authorized in Open Zaak to access the
       Autorisaties API by using the same Client ID and Secret as given here.
@@ -56,8 +58,8 @@ using Open Zaak as the example.
 2. Then we need to allow Open Zaak to access Open Notificaties (for
    authentication purposes, so we can then check its authorizations):
 
-   a. Navigate to **API Autorisaties > Client credentials**
-   b. Click **Client credential toevoegen**.
+   a. Navigate to **API Autorisaties > Autorisatiegegevens**
+   b. Click **Autorisatiegegeven toevoegen**.
    c. Fill out the form:
 
       - **Client ID**: *For example:* ``open-zaak``
@@ -121,4 +123,4 @@ All done!
 .. _`documentation of Open Zaak`: https://open-zaak.readthedocs.io/en/latest/installation/config/openzaak_config.html#configure-notificaties-api
 .. _`configuration of Open Zaak`: https://open-zaak.readthedocs.io/en/stable/installation/config/openzaak_config_cli.html#open-zaak-configuration
 .. _`manual`: https://open-notificaties.readthedocs.io/en/stable/manual/subscriptions.html#aanmaken-abonnement
-.. _`API specification`: https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-zaak/open-notificaties/1.0.0/src/openapi.yaml#tag/notificaties
+.. _`API specification`: https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-zaak/open-notificaties/1.0.0/src/openapi.yaml#tag/notificaties
diff --git a/requirements/base.in b/requirements/base.in
@@ -4,6 +4,3 @@ open-api-framework
 markdown
 self-certifi
 furl
-
-# API libraries
-gemma-zds-client
diff --git a/requirements/base.txt b/requirements/base.txt
@@ -7,7 +7,10 @@
 amqp==5.2.0
     # via kombu
 ape-pie==0.2.0
-    # via zgw-consumers
+    # via
+    #   commonground-api-common
+    #   notifications-api-common
+    #   zgw-consumers
 asgiref==3.8.1
     # via
     #   django
@@ -59,7 +62,7 @@ click-plugins==1.1.1
     # via celery
 click-repl==0.3.0
     # via celery
-commonground-api-common==1.13.2
+commonground-api-common==2.1.0
     # via open-api-framework
 coreapi==2.3.3
     # via commonground-api-common
@@ -201,11 +204,6 @@ furl==2.1.3
     # via
     #   -r requirements/base.in
     #   ape-pie
-gemma-zds-client==1.0.1
-    # via
-    #   -r requirements/base.in
-    #   commonground-api-common
-    #   notifications-api-common
 glom==23.5.0
     # via mozilla-django-oidc-db
 humanize==4.10.0
@@ -242,7 +240,7 @@ mozilla-django-oidc==4.0.1
     # via mozilla-django-oidc-db
 mozilla-django-oidc-db==0.19.0
     # via open-api-framework
-notifications-api-common==0.2.2
+notifications-api-common==0.3.1
     # via commonground-api-common
 open-api-framework==0.8.1
     # via -r requirements/base.in
@@ -265,7 +263,6 @@ pycparser==2.22
 pyjwt==2.9.0
     # via
     #   commonground-api-common
-    #   gemma-zds-client
     #   zgw-consumers
 pyopenssl==24.2.1
     # via
@@ -289,7 +286,6 @@ pyyaml==6.0.2
     # via
     #   drf-spectacular
     #   drf-yasg
-    #   gemma-zds-client
     #   oyaml
 qrcode==7.4.2
     # via django-two-factor-auth
@@ -305,10 +301,12 @@ requests==2.32.3
     #   commonground-api-common
     #   coreapi
     #   django-log-outgoing-requests
-    #   gemma-zds-client
     #   mozilla-django-oidc
     #   open-api-framework
+    #   requests-mock
     #   zgw-consumers
+requests-mock==1.12.1
+    # via commonground-api-common
 rpds-py==0.20.0
     # via
     #   jsonschema
@@ -362,7 +360,8 @@ webencodings==0.5.1
     # via bleach
 wrapt==1.16.0
     # via elastic-apm
-zgw-consumers==0.34.0
+zgw-consumers==0.35.1
     # via
+    #   commonground-api-common
     #   notifications-api-common
     #   open-api-framework
diff --git a/requirements/ci.txt b/requirements/ci.txt
@@ -13,6 +13,8 @@ amqp==5.2.0
 ape-pie==0.2.0
     # via
     #   -r requirements/base.txt
+    #   commonground-api-common
+    #   notifications-api-common
     #   zgw-consumers
 asgiref==3.8.1
     # via
@@ -100,9 +102,10 @@ click-repl==0.3.0
     #   celery
 codecov==2.1.13
     # via -r requirements/ci.in
-commonground-api-common==1.13.2
+commonground-api-common[testutils]==2.1.0
     # via
     #   -r requirements/base.txt
+    #   -r requirements/test-tools.in
     #   open-api-framework
 commonmark==0.9.1
     # via recommonmark
@@ -163,6 +166,7 @@ django==4.2.15
     #   notifications-api-common
     #   open-api-framework
     #   zgw-consumers
+    #   zgw-consumers-oas
 django-admin-index==3.1.1
     # via
     #   -r requirements/base.txt
@@ -324,7 +328,9 @@ face==20.1.1
 factory-boy==3.2.1
     # via -r requirements/test-tools.in
 faker==13.15.1
-    # via factory-boy
+    # via
+    #   factory-boy
+    #   zgw-consumers-oas
 flake8==7.0.0
     # via -r requirements/test-tools.in
 flower==2.0.1
@@ -337,11 +343,6 @@ furl==2.1.3
     # via
     #   -r requirements/base.txt
     #   ape-pie
-gemma-zds-client==1.0.1
-    # via
-    #   -r requirements/base.txt
-    #   commonground-api-common
-    #   notifications-api-common
 glom==23.5.0
     # via
     #   -r requirements/base.txt
@@ -425,7 +426,7 @@ multidict==6.0.5
     # via yarl
 mypy-extensions==0.4.3
     # via black
-notifications-api-common==0.2.2
+notifications-api-common==0.3.1
     # via
     #   -r requirements/base.txt
     #   commonground-api-common
@@ -484,7 +485,6 @@ pyjwt==2.9.0
     # via
     #   -r requirements/base.txt
     #   commonground-api-common
-    #   gemma-zds-client
     #   zgw-consumers
 pyopenssl==24.2.1
     # via
@@ -524,9 +524,9 @@ pyyaml==6.0.2
     #   -r requirements/base.txt
     #   drf-spectacular
     #   drf-yasg
-    #   gemma-zds-client
     #   oyaml
     #   vcrpy
+    #   zgw-consumers-oas
 qrcode==7.4.2
     # via
     #   -r requirements/base.txt
@@ -550,14 +550,16 @@ requests==2.32.3
     #   commonground-api-common
     #   coreapi
     #   django-log-outgoing-requests
-    #   gemma-zds-client
     #   mozilla-django-oidc
     #   open-api-framework
     #   requests-mock
     #   sphinx
     #   zgw-consumers
 requests-mock==1.12.1
-    # via -r requirements/test-tools.in
+    # via
+    #   -r requirements/base.txt
+    #   -r requirements/test-tools.in
+    #   commonground-api-common
 rpds-py==0.20.0
     # via
     #   -r requirements/base.txt
@@ -630,6 +632,7 @@ typing-extensions==4.12.2
     #   mozilla-django-oidc-db
     #   qrcode
     #   zgw-consumers
+    #   zgw-consumers-oas
 tzdata==2024.1
     # via
     #   -r requirements/base.txt
@@ -683,8 +686,11 @@ wrapt==1.16.0
     #   vcrpy
 yarl==1.9.4
     # via vcrpy
-zgw-consumers==0.34.0
+zgw-consumers==0.35.1
     # via
     #   -r requirements/base.txt
+    #   commonground-api-common
     #   notifications-api-common
     #   open-api-framework
+zgw-consumers-oas==1.0.0
+    # via commonground-api-common
diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -13,6 +13,8 @@ amqp==5.2.0
 ape-pie==0.2.0
     # via
     #   -r requirements/base.txt
+    #   commonground-api-common
+    #   notifications-api-common
     #   zgw-consumers
 asgiref==3.8.1
     # via
@@ -103,9 +105,10 @@ click-repl==0.3.0
     # via
     #   -r requirements/base.txt
     #   celery
-commonground-api-common==1.13.2
+commonground-api-common[testutils]==2.1.0
     # via
     #   -r requirements/base.txt
+    #   -r requirements/test-tools.in
     #   open-api-framework
 commonmark==0.9.1
     # via recommonmark
@@ -166,6 +169,7 @@ django==4.2.15
     #   notifications-api-common
     #   open-api-framework
     #   zgw-consumers
+    #   zgw-consumers-oas
 django-admin-index==3.1.1
     # via
     #   -r requirements/base.txt
@@ -329,7 +333,9 @@ face==20.1.1
 factory-boy==3.2.1
     # via -r requirements/test-tools.in
 faker==13.15.1
-    # via factory-boy
+    # via
+    #   factory-boy
+    #   zgw-consumers-oas
 flake8==7.0.0
     # via -r requirements/test-tools.in
 flower==2.0.1
@@ -342,11 +348,6 @@ furl==2.1.3
     # via
     #   -r requirements/base.txt
     #   ape-pie
-gemma-zds-client==1.0.1
-    # via
-    #   -r requirements/base.txt
-    #   commonground-api-common
-    #   notifications-api-common
 gitdb==4.0.9
     # via gitpython
 gitpython==3.1.41
@@ -432,7 +433,7 @@ multidict==6.0.5
     # via yarl
 mypy-extensions==0.4.3
     # via black
-notifications-api-common==0.2.2
+notifications-api-common==0.3.1
     # via
     #   -r requirements/base.txt
     #   commonground-api-common
@@ -491,7 +492,6 @@ pyjwt==2.9.0
     # via
     #   -r requirements/base.txt
     #   commonground-api-common
-    #   gemma-zds-client
     #   zgw-consumers
 pyopenssl==24.2.1
     # via
@@ -531,9 +531,9 @@ pyyaml==6.0.2
     #   -r requirements/base.txt
     #   drf-spectacular
     #   drf-yasg
-    #   gemma-zds-client
     #   oyaml
     #   vcrpy
+    #   zgw-consumers-oas
 qrcode==7.4.2
     # via
     #   -r requirements/base.txt
@@ -556,14 +556,16 @@ requests==2.32.3
     #   commonground-api-common
     #   coreapi
     #   django-log-outgoing-requests
-    #   gemma-zds-client
     #   mozilla-django-oidc
     #   open-api-framework
     #   requests-mock
     #   sphinx
     #   zgw-consumers
 requests-mock==1.12.1
-    # via -r requirements/test-tools.in
+    # via
+    #   -r requirements/base.txt
+    #   -r requirements/test-tools.in
+    #   commonground-api-common
 rpds-py==0.20.0
     # via
     #   -r requirements/base.txt
@@ -637,6 +639,7 @@ typing-extensions==4.12.2
     #   mozilla-django-oidc-db
     #   qrcode
     #   zgw-consumers
+    #   zgw-consumers-oas
 tzdata==2024.1
     # via
     #   -r requirements/base.txt
@@ -692,11 +695,14 @@ wrapt==1.16.0
     #   vcrpy
 yarl==1.9.4
     # via vcrpy
-zgw-consumers==0.34.0
+zgw-consumers==0.35.1
     # via
     #   -r requirements/base.txt
+    #   commonground-api-common
     #   notifications-api-common
     #   open-api-framework
+zgw-consumers-oas==1.0.0
+    # via commonground-api-common
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip