[james-project] 01/08: JAMES-2993 Document webadmin endpoint for message fast view recomputation

[bt...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit a557d0a48a3bd975488c9771e9d3f30c32b018b0
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Mon Dec 16 14:54:12 2019 +0700

    JAMES-2993 Document webadmin endpoint for message fast view recomputation
---
 src/site/markdown/server/manage-webadmin.md | 37 +++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/src/site/markdown/server/manage-webadmin.md b/src/site/markdown/server/manage-webadmin.md
index c3b3786..74a22f7 100644
--- a/src/site/markdown/server/manage-webadmin.md
+++ b/src/site/markdown/server/manage-webadmin.md
@@ -358,6 +358,43 @@ Response codes:
 
 The kind of task scheduled depends on the action parameter. See below for details.
 
+### Recomputing JMAP fast message view projection
+
+This action is only available for backends supporting JMAP protocol.
+
+Message fast view projection stores message properties expected to be fast to fetch but are actually expensive to compute,
+in order for GetMessages operation to be fast to execute for these properties.
+
+These projection items are asynchronously computed via a dedicated listener.
+
+You can force the full projection recomputation by calling the following endpoint:
+
+```
+curl -XPOST /mailboxes?task=recomputeFastViewProjectionItems
+```
+
+Will schedule a task for recomputing the fast message view projection for all mailboxes.
+
+[More details about endpoints returning a task](#Endpoints_returning_a_task).
+
+
+The scheduled task will have the following type `RecomputeAllPreviewsTask` and the following `additionalInformation`:
+
+```
+{
+  "type":"RecomputeAllPreviewsTask",
+  "processedUserCount": 3,
+  "processedMessageCount": 3,
+  "failedUserCount": 2,
+  "failedMessageCount": 1
+}
+```
+
+Response codes:
+
+ - 201: Success. Corresponding task id is returned.
+ - 400: Error in the request. Details can be found in the reported error.
+
 #### ReIndexing action
 
 Be also aware of the limits of this API:


---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org