Define what hidden indexes are

Author: Simran-B

site/content/3.10/develop/http-api/indexes/_index.md

@@ -54,7 +54,8 @@ paths:
           in: query
           required: false
           description: |
-            Whether to include hidden indexes in the result.
+            Whether to include hidden indexes in the result. Internal indexes
+            and ones that are currently built in the background are hidden.
           schema:
             type: boolean
       responses:

site/content/3.10/index-and-search/indexing/working-with-indexes/_index.md

@@ -62,7 +62,8 @@ You can set the following parameters:
 - `withStats` (boolean, _optional_): whether to include index figures and
   estimates in the result. Default: `false`
 - `withHidden` (boolean, _optional_): whether to include hidden indexes in the
-  result. Default: `false`
+  result. Internal indexes and ones that are currently built in the background
+  are hidden. Default: `false`
 
 The `indexes()` method is an alias for `getIndexes()`.
 

site/content/3.11/develop/http-api/indexes/_index.md

@@ -54,7 +54,8 @@ paths:
           in: query
           required: false
           description: |
-            Whether to include hidden indexes in the result.
+            Whether to include hidden indexes in the result. Internal indexes
+            and ones that are currently built in the background are hidden.
           schema:
             type: boolean
       responses:

site/content/3.11/index-and-search/indexing/working-with-indexes/_index.md

@@ -62,7 +62,8 @@ You can set the following parameters:
 - `withStats` (boolean, _optional_): whether to include index figures and
   estimates in the result. Default: `false`
 - `withHidden` (boolean, _optional_): whether to include hidden indexes in the
-  result. Default: `false`
+  result. Internal indexes and ones that are currently built in the background
+  are hidden. Default: `false`
 
 The `indexes()` method is an alias for `getIndexes()`.
 

site/content/3.12/develop/http-api/indexes/_index.md

@@ -54,7 +54,8 @@ paths:
           in: query
           required: false
           description: |
-            Whether to include hidden indexes in the result.
+            Whether to include hidden indexes in the result. Internal indexes
+            and ones that are currently built in the background are hidden.
           schema:
             type: boolean
       responses:

site/content/3.12/index-and-search/indexing/working-with-indexes/_index.md

@@ -62,7 +62,8 @@ You can set the following parameters:
 - `withStats` (boolean, _optional_): whether to include index figures and
   estimates in the result. Default: `false`
 - `withHidden` (boolean, _optional_): whether to include hidden indexes in the
-  result. Default: `false`
+  result. Internal indexes and ones that are currently built in the background
+  are hidden. Default: `false`
 
 The `indexes()` method is an alias for `getIndexes()`.
 

site/content/4.0/develop/http-api/indexes/_index.md

@@ -54,7 +54,8 @@ paths:
           in: query
           required: false
           description: |
-            Whether to include hidden indexes in the result.
+            Whether to include hidden indexes in the result. Internal indexes
+            and ones that are currently built in the background are hidden.
           schema:
             type: boolean
       responses:

site/content/4.0/index-and-search/indexing/working-with-indexes/_index.md

@@ -62,7 +62,8 @@ You can set the following parameters:
 - `withStats` (boolean, _optional_): whether to include index figures and
   estimates in the result. Default: `false`
 - `withHidden` (boolean, _optional_): whether to include hidden indexes in the
-  result. Default: `false`
+  result. Internal indexes and ones that are currently built in the background
+  are hidden. Default: `false`
 
 The `indexes()` method is an alias for `getIndexes()`.