From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Fri, 14 Feb 2025 16:20:43 +0000 (-0800) Subject: Documentation: correct modify_tags param requirement X-Git-Tag: v2.15.0~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fc68f55d1a08d895564d52adfd5d8ea1fd5bc86c;p=thirdparty%2Fpaperless-ngx.git Documentation: correct modify_tags param requirement --- diff --git a/docs/api.md b/docs/api.md index ac9bac912..327c3220c 100644 --- a/docs/api.md +++ b/docs/api.md @@ -444,7 +444,7 @@ The following methods are supported: - `remove_tag` - Requires `parameters`: `{ "tag": TAG_ID }` - `modify_tags` - - Requires `parameters`: `{ "add_tags": [LIST_OF_TAG_IDS] }` and / or `{ "remove_tags": [LIST_OF_TAG_IDS] }` + - Requires `parameters`: `{ "add_tags": [LIST_OF_TAG_IDS] }` and `{ "remove_tags": [LIST_OF_TAG_IDS] }` - `delete` - No `parameters` required - `reprocess` diff --git a/src/documents/tests/test_api_bulk_edit.py b/src/documents/tests/test_api_bulk_edit.py index 28c6de336..bcbe5922d 100644 --- a/src/documents/tests/test_api_bulk_edit.py +++ b/src/documents/tests/test_api_bulk_edit.py @@ -211,7 +211,7 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase): def test_api_modify_tags_not_provided(self, m): """ GIVEN: - - API data to modify tags is missing modify_tags field + - API data to modify tags is missing remove_tags field WHEN: - API to edit tags is called THEN: