Make IndexProjects REST endpoint take an argument for being async
Not all callers might want to have this be an asynchronous operation,
but some might, especially when reindexing projects with lots of
children. Hence, this commit makes that configurable.
Change-Id: Id67734cf0e33408f384925514cf8886c229844d2
diff --git a/Documentation/rest-api-projects.txt b/Documentation/rest-api-projects.txt
index 54f8022..792cca8 100644
--- a/Documentation/rest-api-projects.txt
+++ b/Documentation/rest-api-projects.txt
@@ -1357,8 +1357,8 @@
=== Index project
Adds or updates the current project (and children, if specified) in the secondary index.
-The indexing task is executed asynchronously in background, so this command
-returns immediately.
+The indexing task is executed asynchronously in background and this command returns
+immediately if `async` is specified in the input.
As an input, a link:#index-project-input[IndexProjectInput] entity can be provided.
@@ -1369,6 +1369,7 @@
{
"index_children": "true"
+ "async": "true"
}
----
@@ -3162,6 +3163,8 @@
|Field Name ||Description
|`index_children` ||
If children should be indexed recursively.
+|`async` ||
+If projects should be indexed asynchronously.
|================================
[[inherited-boolean-info]]
