From: shamoon <4887959+shamoon@users.noreply.github.com>
Date: Mon, 10 Apr 2023 16:38:14 +0000 (-0700)
Subject: Add tasks endpoint to list, clarify use
X-Git-Tag: v1.14.0~1^2~12
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f7cea2f92eacc3ce530790f57cbff1749430b2f7;p=thirdparty%2Fpaperless-ngx.git

Add tasks endpoint to list, clarify use
---

diff --git a/docs/api.md b/docs/api.md
index f4a16b2643..4a24890c89 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -14,14 +14,15 @@ The API provides 7 main endpoints:
 - `/api/document_types/`: 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.
 
 All of these endpoints except for the logging endpoint allow you to
-fetch, edit and delete individual objects by appending their primary key
-to the path, for example `/api/documents/454/`.
+fetch (and edit and delete where appropriate) individual objects by
+appending their primary key to the path, e.g. `/api/documents/454/`.
 
 The objects served by the document endpoint contain the following
 fields:
@@ -261,10 +262,11 @@ The endpoint supports the following optional form fields:
 
 The endpoint will immediately return HTTP 200 if the document consumption
 process was started successfully, with the UUID of the consumption task
-as the data. No additional status information about
-the consumption process itself is available immediately, since that happens in a
-different process. Querying the tasks endpoint with the returned UUID will
-provide information on the state of the consumption.
+as the data. No additional status information about the consumption process
+itself is available immediately, since that happens in a different process.
+However, querying the tasks endpoint with the returned UUID e.g.
+`/api/tasks/?task_id={uuid}` will provide information on the state of the
+consumption including the ID of a created document if consumption succeeded.
 
 ## API Versioning