From 4ab8c3d2f285dc90a3bcafd212b9b886a82907d7 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Tue, 10 Dec 2024 09:42:19 -0800 Subject: [PATCH] improve some descriptions etc --- src/documents/views.py | 16 ++++++++++++++++ src/paperless/views.py | 9 +++++++++ 2 files changed, 25 insertions(+) diff --git a/src/documents/views.py b/src/documents/views.py index d8c3ef12c..109a71b72 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -1197,6 +1197,14 @@ class SavedViewViewSet(ModelViewSet, PassUserMixin): "description": "Further documentation", "url": "https://docs.paperless-ngx.com/api/#bulk-editing", }, + responses={ + 200: inline_serializer( + name="BulkEditDocumentsResult", + fields={ + "result": serializers.CharField(), + }, + ), + }, ), ) class BulkEditView(PassUserMixin): @@ -2326,6 +2334,14 @@ def serve_file(doc: Document, use_archive: bool, disposition: str): "description": "Further documentation", "url": "https://docs.paperless-ngx.com/api/#objects", }, + responses={ + 200: inline_serializer( + name="BulkEditResult", + fields={ + "result": serializers.CharField(), + }, + ), + }, ), ) class BulkEditObjectsView(PassUserMixin): diff --git a/src/paperless/views.py b/src/paperless/views.py index bfc276dcc..1ef23a84a 100644 --- a/src/paperless/views.py +++ b/src/paperless/views.py @@ -327,6 +327,15 @@ class GenerateAuthTokenView(GenericAPIView): ) +@extend_schema_view( + list=extend_schema( + description="Get the application configuration", + external_docs={ + "description": "Application Configuration", + "url": "https://docs.paperless-ngx.com/configuration/", + }, + ), +) class ApplicationConfigurationViewSet(ModelViewSet): model = ApplicationConfiguration