]> git.ipfire.org Git - thirdparty/paperless-ngx.git/commitdiff
Documentation: organize API endpoints (#5077)
authorDiego Gsponer <diego.gsponer@bluewin.ch>
Fri, 22 Dec 2023 17:27:07 +0000 (18:27 +0100)
committerGitHub <noreply@github.com>
Fri, 22 Dec 2023 17:27:07 +0000 (09:27 -0800)
docs/api.md

index 2ff8f077d11697bf8bd5891f7fd17bc4a532c5c1..82244936f1eccea5419be5a2361d9da4daa7d8cc 100644 (file)
@@ -8,20 +8,22 @@ most of the available filters and ordering fields.
 
 The API provides the following main endpoints:
 
+- `/api/consumption_templates/`: Full CRUD support.
+- `/api/correspondents/`: Full CRUD support.
+- `/api/custom_fields/`: Full CRUD support.
 - `/api/documents/`: Full CRUD support, except POSTing new documents.
   See below.
-- `/api/correspondents/`: Full CRUD support.
 - `/api/document_types/`: Full CRUD support.
+- `/api/groups/`: Full CRUD support.
 - `/api/logs/`: Read-Only.
-- `/api/tags/`: Full CRUD support.
-- `/api/tasks/`: Read-only.
 - `/api/mail_accounts/`: Full CRUD support.
 - `/api/mail_rules/`: Full CRUD support.
-- `/api/users/`: Full CRUD support.
-- `/api/groups/`: Full CRUD support.
-- `/api/share_links/`: Full CRUD support.
-- `/api/custom_fields/`: Full CRUD support.
 - `/api/profile/`: GET, PATCH
+- `/api/share_links/`: Full CRUD support.
+- `/api/storage_paths/`: Full CRUD support.
+- `/api/tags/`: Full CRUD support.
+- `/api/tasks/`: Read-only.
+- `/api/users/`: Full CRUD support.
 
 All of these endpoints except for the logging endpoint allow you to
 fetch (and edit and delete where appropriate) individual objects by