[james-project] 04/09: JAMES-3047 Missing user recompute messageFastView documentation

[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 f83a247ddfc7b2e3d48423f8bfc1a95b50e782ba
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Tue Feb 11 16:11:28 2020 +0700

    JAMES-3047 Missing user recompute messageFastView documentation
---
 src/site/markdown/server/manage-webadmin.md | 42 +++++++++++++++++++++++++++--
 1 file changed, 40 insertions(+), 2 deletions(-)

diff --git a/src/site/markdown/server/manage-webadmin.md b/src/site/markdown/server/manage-webadmin.md
index f427886..96fd152 100644
--- a/src/site/markdown/server/manage-webadmin.md
+++ b/src/site/markdown/server/manage-webadmin.md
@@ -360,14 +360,14 @@ Response codes:
 
 The kind of task scheduled depends on the action parameter. See below for details.
 
-### Recomputing JMAP fast message view projection
+### Recomputing Global 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.
+These projection items are asynchronously computed on mailbox events.
 
 You can force the full projection recomputation by calling the following endpoint:
 
@@ -561,6 +561,7 @@ Warning: During the re-indexing, the result of search operations might be altere
  - [Listing user mailboxes](#Listing_user_mailboxes)
  - [Deleting_user_mailboxes](#Deleting_user_mailboxes)
  - [ReIndexing a user mails](#ReIndexing_a_user_mails)
+ - [Recomputing User JMAP fast message view projection](#Recomputing_User_JMAP_fast_message_view_projection)
 
 ### Creating a mailbox
 
@@ -681,6 +682,43 @@ Warning: Canceling this task should be considered unsafe as it will leave the cu
 Warning: While we have been trying to reduce the inconsistency window to a maximum (by keeping track of ongoing events),
 concurrent changes done during the reIndexing might be ignored.
 
+### Recomputing User 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 on mailbox events.
+
+You can force the full projection recomputation by calling the following endpoint:
+
+```
+curl -XPOST /users/usernameToBeUsed/mailboxes?task=recomputeFastViewProjectionItems
+```
+
+Will schedule a task for recomputing the fast message view projection for all mailboxes of `usernameToBeUsed`.
+
+[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",
+  "username": "usernameToBeUsed",
+  "processedMessageCount": 3,
+  "failedMessageCount": 1
+}
+```
+
+Response codes:
+
+ - 201: Success. Corresponding task id is returned.
+ - 400: Error in the request. Details can be found in the reported error.
+ - 404: User not found.
+
 ## Administrating quotas by users
 
  - [Getting the quota for a user](#Getting_the_quota_for_a_user)


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