📝 Update documentation and translation of all documentation (#1256)

backend/doc/config/services.rst

@@ -4,7 +4,7 @@ Services
 ========
 
 The ZAC reads data from the external APIs. These APIs need to be
-configured. Some of the data is for performance reasons copied into a read-only 
+configured. For performance some of the data is copied into a read-only 
 elasticsearch database.
 
 Most API's are added as services under **ZGW_Consumers > Services** in the admin

backend/doc/troubleshooting/zaak-detail.rst

@@ -9,6 +9,12 @@ Zaak detail page does not load
 * Make sure user has permissions. Please refer to :ref:`authorizations <authorizations-index>`.
 * Make sure `meta` objecttypes are set correctly in :ref:`admin panel <admin-panel>`. Please refer to :ref:`config-metaobjecttypes`.
 
+Zaak detail page data out of sync
+---------------------------------
+
+* Clear cache: `clear cache`_. ADVICE: it's easiest to clear all cache patterns with `{'pattern': '*'}` if running redis as caching backend.
+* Reindex zaak: `reindex-zaak`_. !WARNING: do NOT set `reset_indices: True` or suffer the consequences!
+
 Cannot change `betrokkenen`
 ----------------------------
 
@@ -17,3 +23,6 @@ Cannot change `betrokkenen`
 * Make sure the ZAC is subscribed and can receive notifications from Open Notificaties.
 * Make sure there is at least one `(hoofd)behandelaar`.
 * Make sure you have the correct permissions. Please refer to :ref:`authorizations <authorizations-index>`.
+
+.. _clear cache: https://zac.cg-intern.utrecht.nl/api/docs/#tag/management/operation/core_management_cache_reset_create
+.. _reindex zaak: https://zac.cg-intern.ont.utrecht.nl/api/docs/#tag/management/operation/search_management_reindex_zaak_create

backend/src/zac/accounts/api/views.py

@@ -75,7 +75,7 @@ class LogoutView(views.APIView):
 
     def get_serializer(self, *args, **kwargs):
         # Shut up drf-spectacular - return empty serializer
-        return {}
+        return dict()
 
     def post(self, request):
         logout(request)

backend/src/zac/api/views.py

@@ -63,19 +63,21 @@ def get(self, request: Request, *args, **kwargs):
 
     def get_serializer(self, *args, **kwargs):
         # shut up drf-spectacular
-        return {}
+        return dict()
 
 
 class PingView(APIView):
     authentication_classes = [SessionAuthentication]
     permission_classes = [IsAuthenticated]
 
     @extend_schema(
+        "ping",
         summary=_("Ping a user session."),
         description=_("Extends user session on activity."),
+        request=None,
         responses={
             "200": inline_serializer(
-                "Serializer",
+                "PingSerializer",
                 fields={"pong": serializers.BooleanField(default=True)},
             )
         },
@@ -85,4 +87,4 @@ def get(self, request: Request, *args, **kwargs):
 
     def get_serializer(self, *args, **kwargs):
         # shut up drf-spectacular
-        return {}
+        return dict()

backend/src/zac/camunda/api/serializers.py

@@ -172,7 +172,7 @@ def get_process_variables(self) -> Dict:
             "get_process_variables",
         ):
             return mapped_serializer.get_process_variables()
-        return {}
+        return dict()
 
 
 class MessageSerializer(serializers.Serializer):