improve some descriptions etc

This commit is contained in:
shamoon 2024-12-10 09:42:19 -08:00
parent ef4198e043
commit 4ab8c3d2f2
2 changed files with 25 additions and 0 deletions

View File

@ -1197,6 +1197,14 @@ class SavedViewViewSet(ModelViewSet, PassUserMixin):
"description": "Further documentation", "description": "Further documentation",
"url": "https://docs.paperless-ngx.com/api/#bulk-editing", "url": "https://docs.paperless-ngx.com/api/#bulk-editing",
}, },
responses={
200: inline_serializer(
name="BulkEditDocumentsResult",
fields={
"result": serializers.CharField(),
},
),
},
), ),
) )
class BulkEditView(PassUserMixin): class BulkEditView(PassUserMixin):
@ -2326,6 +2334,14 @@ def serve_file(doc: Document, use_archive: bool, disposition: str):
"description": "Further documentation", "description": "Further documentation",
"url": "https://docs.paperless-ngx.com/api/#objects", "url": "https://docs.paperless-ngx.com/api/#objects",
}, },
responses={
200: inline_serializer(
name="BulkEditResult",
fields={
"result": serializers.CharField(),
},
),
},
), ),
) )
class BulkEditObjectsView(PassUserMixin): class BulkEditObjectsView(PassUserMixin):

View File

@ -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): class ApplicationConfigurationViewSet(ModelViewSet):
model = ApplicationConfiguration model = ApplicationConfiguration