improve doc

elastic · Aug 20, 2021 · 16c0b0a · 16c0b0a
1 parent b9a1b38
commit 16c0b0a
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/...ent/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md b/...ent/core/server/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.md
@@ -16,6 +16,6 @@ export interface SavedObjectsOpenPointInTimeOptions
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [keepAlive](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.keepalive.md) | <code>string</code> | Optionally specify how long ES should keep the PIT alive until the next request. Defaults to <code>5m</code>. |
-|  [namespaces](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md) | <code>string[]</code> | An optional list of namespaces to be used by the PIT. |
+|  [namespaces](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md) | <code>string[]</code> | An optional list of namespaces to be used when opening the PIT.<!-- -->When the spaces plugin is enabled: - this will default to the user's current space (as determined by the URL) - if specified, the user's current space will be ignored - <code>['*']</code> will search across all available spaces |
 |  [preference](./kibana-plugin-core-server.savedobjectsopenpointintimeoptions.preference.md) | <code>string</code> | An optional ES preference value to be used for the query. |
 
diff --git a/...rver/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md b/...rver/kibana-plugin-core-server.savedobjectsopenpointintimeoptions.namespaces.md
@@ -4,7 +4,9 @@
 
 ## SavedObjectsOpenPointInTimeOptions.namespaces property
 
-An optional list of namespaces to be used by the PIT.
+An optional list of namespaces to be used when opening the PIT.
+
+When the spaces plugin is enabled: - this will default to the user's current space (as determined by the URL) - if specified, the user's current space will be ignored - `['*']` will search across all available spaces
 
 <b>Signature:</b>
 

diff --git a/src/core/server/saved_objects/service/saved_objects_client.ts b/src/core/server/saved_objects/service/saved_objects_client.ts
@@ -344,7 +344,12 @@ export interface SavedObjectsOpenPointInTimeOptions {
    */
   preference?: string;
   /**
-   * An optional list of namespaces to be used by the PIT.
+   * An optional list of namespaces to be used when opening the PIT.
+   *
+   * When the spaces plugin is enabled:
+   *  - this will default to the user's current space (as determined by the URL)
+   *  - if specified, the user's current space will be ignored
+   *  - `['*']` will search across all available spaces
    */
   namespaces?: string[];
 }