From a2cdb83328c32d9d7ecb11932fdf1e80648c3c9b Mon Sep 17 00:00:00 2001 From: Sergei Maertens Date: Fri, 1 Mar 2024 14:17:04 +0100 Subject: [PATCH] :pencil: [#3735] Update documentation about pre-request clients --- docs/developers/extensions.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/developers/extensions.rst b/docs/developers/extensions.rst index eede8a1758..0119df2b97 100644 --- a/docs/developers/extensions.rst +++ b/docs/developers/extensions.rst @@ -4,6 +4,8 @@ Extensions ========== +Official extensions maintained by the Open Forms core developers. + Keycloak token exchange extension ================================= @@ -39,9 +41,11 @@ The flow works as follows: #. Open Forms requests prefill data from Haal Centraal: - * The client that makes the request to the ZGW API is :class:`openforms.pre_requests.clients.PreRequestZGWClient`. - This client is a subclass of :class:`zgw_consumers.client.ZGWClient` which overrides the ``pre_request`` method so - that any pre-request hooks registered in Open Forms are run before performing the request. + * Prefill data is retrieved using the client + :class:`openforms.contrib.haal_centraal.clients.brp.BRPClient`, which makes use of + the pre-request hooks through :class:`openforms.pre_requests.clients.PreRequestMixin`. + It intercepts the :mod:`requests` request preparation to modify the request before + it's actually sent out over the network. * The ``open-forms-ext-token-exchange`` extension registers a pre-request hook which adds a `custom authentication class`_ to the request. * The custom authentication class ``token_exchange.auth.TokenAccessAuth`` checks if the URL to which the