Add SavedObject management section registration in core

docs/development/core/server/kibana-plugin-server.isavedobjecttyperegistry.md

@@ -9,5 +9,5 @@ See [SavedObjectTypeRegistry](./kibana-plugin-server.savedobjecttyperegistry.md)
 <b>Signature:</b>
 
 ```typescript
-export declare type ISavedObjectTypeRegistry = Pick<SavedObjectTypeRegistry, 'getType' | 'getAllTypes' | 'getIndex' | 'isNamespaceAgnostic' | 'isHidden'>;
+export declare type ISavedObjectTypeRegistry = Pick<SavedObjectTypeRegistry, 'getType' | 'getAllTypes' | 'getIndex' | 'isNamespaceAgnostic' | 'isHidden' | 'getImportableAndExportableTypes' | 'isImportableAndExportable'>;
 ```

docs/development/core/server/kibana-plugin-server.md

@@ -113,7 +113,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [PluginManifest](./kibana-plugin-server.pluginmanifest.md) | Describes the set of required and optional properties plugin can define in its mandatory JSON manifest file. |
 |  [PluginsServiceSetup](./kibana-plugin-server.pluginsservicesetup.md) |  |
 |  [PluginsServiceStart](./kibana-plugin-server.pluginsservicestart.md) |  |
-|  [RequestHandlerContext](./kibana-plugin-server.requesthandlercontext.md) | Plugin specific context passed to a route handler.<!-- -->Provides the following clients: - [rendering](./kibana-plugin-server.iscopedrenderingclient.md) - Rendering client which uses the data of the incoming request - [savedObjects.client](./kibana-plugin-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [elasticsearch.dataClient](./kibana-plugin-server.scopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [elasticsearch.adminClient](./kibana-plugin-server.scopedclusterclient.md) - Elasticsearch admin client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request |
+|  [RequestHandlerContext](./kibana-plugin-server.requesthandlercontext.md) | Plugin specific context passed to a route handler.<!-- -->Provides the following clients and services: - [rendering](./kibana-plugin-server.iscopedrenderingclient.md) - Rendering client which uses the data of the incoming request - [savedObjects.client](./kibana-plugin-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.dataClient](./kibana-plugin-server.scopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [elasticsearch.adminClient](./kibana-plugin-server.scopedclusterclient.md) - Elasticsearch admin client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request |
 |  [RouteConfig](./kibana-plugin-server.routeconfig.md) | Route specific configuration. |
 |  [RouteConfigOptions](./kibana-plugin-server.routeconfigoptions.md) | Additional route options. |
 |  [RouteConfigOptionsBody](./kibana-plugin-server.routeconfigoptionsbody.md) | Additional body options for a route |
@@ -161,6 +161,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [SavedObjectsServiceSetup](./kibana-plugin-server.savedobjectsservicesetup.md) | Saved Objects is Kibana's data persistence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods for registering Saved Object types, creating and registering Saved Object client wrappers and factories. |
 |  [SavedObjectsServiceStart](./kibana-plugin-server.savedobjectsservicestart.md) | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing and querying state. The SavedObjectsServiceStart API provides a scoped Saved Objects client for interacting with Saved Objects. |
 |  [SavedObjectsType](./kibana-plugin-server.savedobjectstype.md) |  |
+|  [SavedObjectsTypeManagementDefinition](./kibana-plugin-server.savedobjectstypemanagementdefinition.md) | Configuration options for the [type](./kibana-plugin-server.savedobjectstype.md)<!-- -->'s management section. |
 |  [SavedObjectsTypeMappingDefinition](./kibana-plugin-server.savedobjectstypemappingdefinition.md) | Describe a saved object type mapping. |
 |  [SavedObjectsUpdateOptions](./kibana-plugin-server.savedobjectsupdateoptions.md) |  |
 |  [SavedObjectsUpdateResponse](./kibana-plugin-server.savedobjectsupdateresponse.md) |  |

docs/development/core/server/kibana-plugin-server.requesthandlercontext.core.md

@@ -11,6 +11,7 @@ core: {
         rendering: IScopedRenderingClient;
         savedObjects: {
             client: SavedObjectsClientContract;
+            typeRegistry: ISavedObjectTypeRegistry;
         };
         elasticsearch: {
             dataClient: IScopedClusterClient;

docs/development/core/server/kibana-plugin-server.requesthandlercontext.md

@@ -6,7 +6,7 @@
 
 Plugin specific context passed to a route handler.
 
-Provides the following clients: - [rendering](./kibana-plugin-server.iscopedrenderingclient.md) - Rendering client which uses the data of the incoming request - [savedObjects.client](./kibana-plugin-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [elasticsearch.dataClient](./kibana-plugin-server.scopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [elasticsearch.adminClient](./kibana-plugin-server.scopedclusterclient.md) - Elasticsearch admin client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request
+Provides the following clients and services: - [rendering](./kibana-plugin-server.iscopedrenderingclient.md) - Rendering client which uses the data of the incoming request - [savedObjects.client](./kibana-plugin-server.savedobjectsclient.md) - Saved Objects client which uses the credentials of the incoming request - [savedObjects.typeRegistry](./kibana-plugin-server.isavedobjecttyperegistry.md) - Type registry containing all the registered types. - [elasticsearch.dataClient](./kibana-plugin-server.scopedclusterclient.md) - Elasticsearch data client which uses the credentials of the incoming request - [elasticsearch.adminClient](./kibana-plugin-server.scopedclusterclient.md) - Elasticsearch admin client which uses the credentials of the incoming request - [uiSettings.client](./kibana-plugin-server.iuisettingsclient.md) - uiSettings client which uses the credentials of the incoming request
 
 <b>Signature:</b>
 
@@ -18,5 +18,5 @@ export interface RequestHandlerContext
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [core](./kibana-plugin-server.requesthandlercontext.core.md) | <code>{</code><br/><code>        rendering: IScopedRenderingClient;</code><br/><code>        savedObjects: {</code><br/><code>            client: SavedObjectsClientContract;</code><br/><code>        };</code><br/><code>        elasticsearch: {</code><br/><code>            dataClient: IScopedClusterClient;</code><br/><code>            adminClient: IScopedClusterClient;</code><br/><code>        };</code><br/><code>        uiSettings: {</code><br/><code>            client: IUiSettingsClient;</code><br/><code>        };</code><br/><code>    }</code> |  |
+|  [core](./kibana-plugin-server.requesthandlercontext.core.md) | <code>{</code><br/><code>        rendering: IScopedRenderingClient;</code><br/><code>        savedObjects: {</code><br/><code>            client: SavedObjectsClientContract;</code><br/><code>            typeRegistry: ISavedObjectTypeRegistry;</code><br/><code>        };</code><br/><code>        elasticsearch: {</code><br/><code>            dataClient: IScopedClusterClient;</code><br/><code>            adminClient: IScopedClusterClient;</code><br/><code>        };</code><br/><code>        uiSettings: {</code><br/><code>            client: IUiSettingsClient;</code><br/><code>        };</code><br/><code>    }</code> |  |
 

docs/development/core/server/kibana-plugin-server.savedobjectstype.management.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsType](./kibana-plugin-server.savedobjectstype.md) &gt; [management](./kibana-plugin-server.savedobjectstype.management.md)
+
+## SavedObjectsType.management property
+
+An optional [management section](./kibana-plugin-server.savedobjectstypemanagementdefinition.md) definition for the type.
+
+<b>Signature:</b>
+
+```typescript
+management?: SavedObjectsTypeManagementDefinition;
+```

docs/development/core/server/kibana-plugin-server.savedobjectstype.md

@@ -21,6 +21,7 @@ This is only internal for now, and will only be public when we expose the regist
 |  [convertToAliasScript](./kibana-plugin-server.savedobjectstype.converttoaliasscript.md) | <code>string</code> | If defined, will be used to convert the type to an alias. |
 |  [hidden](./kibana-plugin-server.savedobjectstype.hidden.md) | <code>boolean</code> | Is the type hidden by default. If true, repositories will not have access to this type unless explicitly declared as an <code>extraType</code> when creating the repository.<!-- -->See [createInternalRepository](./kibana-plugin-server.savedobjectsservicestart.createinternalrepository.md)<!-- -->. |
 |  [indexPattern](./kibana-plugin-server.savedobjectstype.indexpattern.md) | <code>string</code> | If defined, the type instances will be stored in the given index instead of the default one. |
+|  [management](./kibana-plugin-server.savedobjectstype.management.md) | <code>SavedObjectsTypeManagementDefinition</code> | An optional [management section](./kibana-plugin-server.savedobjectstypemanagementdefinition.md) definition for the type. |
 |  [mappings](./kibana-plugin-server.savedobjectstype.mappings.md) | <code>SavedObjectsTypeMappingDefinition</code> | The [mapping definition](./kibana-plugin-server.savedobjectstypemappingdefinition.md) for the type. |
 |  [migrations](./kibana-plugin-server.savedobjectstype.migrations.md) | <code>SavedObjectMigrationMap</code> | An optional map of [migrations](./kibana-plugin-server.savedobjectmigrationfn.md) to be used to migrate the type. |
 |  [name](./kibana-plugin-server.savedobjectstype.name.md) | <code>string</code> | The name of the type, which is also used as the internal id. |

docs/development/core/server/kibana-plugin-server.savedobjectstypemanagementdefinition.defaultsearchfield.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsTypeManagementDefinition](./kibana-plugin-server.savedobjectstypemanagementdefinition.md) &gt; [defaultSearchField](./kibana-plugin-server.savedobjectstypemanagementdefinition.defaultsearchfield.md)
+
+## SavedObjectsTypeManagementDefinition.defaultSearchField property
+
+The default search field to use for this type. Defaults to `id`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+defaultSearchField?: string;
+```

docs/development/core/server/kibana-plugin-server.savedobjectstypemanagementdefinition.getediturl.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsTypeManagementDefinition](./kibana-plugin-server.savedobjectstypemanagementdefinition.md) &gt; [getEditUrl](./kibana-plugin-server.savedobjectstypemanagementdefinition.getediturl.md)
+
+## SavedObjectsTypeManagementDefinition.getEditUrl property
+
+Function returning the url to use to redirect to the edition page of this object. If not defined, edition will not be allowed.
+
+<b>Signature:</b>
+
+```typescript
+getEditUrl?: (savedObject: SavedObject<any>) => string;
+```

docs/development/core/server/kibana-plugin-server.savedobjectstypemanagementdefinition.getinappurl.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsTypeManagementDefinition](./kibana-plugin-server.savedobjectstypemanagementdefinition.md) &gt; [getInAppUrl](./kibana-plugin-server.savedobjectstypemanagementdefinition.getinappurl.md)
+
+## SavedObjectsTypeManagementDefinition.getInAppUrl property
+
+Function returning the url to use to redirect to this object from the management section. If not defined, redirecting to the object will not be allowed.
+
+<b>Signature:</b>
+
+```typescript
+getInAppUrl?: (savedObject: SavedObject<any>) => {
+        path: string;
+        uiCapabilitiesPath: string;
+    };
+```

docs/development/core/server/kibana-plugin-server.savedobjectstypemanagementdefinition.gettitle.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsTypeManagementDefinition](./kibana-plugin-server.savedobjectstypemanagementdefinition.md) &gt; [getTitle](./kibana-plugin-server.savedobjectstypemanagementdefinition.gettitle.md)
+
+## SavedObjectsTypeManagementDefinition.getTitle property
+
+Function returning the title to display in the management table. If not defined, will use the object's type and id to generate a label.
+
+<b>Signature:</b>
+
+```typescript
+getTitle?: (savedObject: SavedObject<any>) => string;
+```

docs/development/core/server/kibana-plugin-server.savedobjectstypemanagementdefinition.icon.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsTypeManagementDefinition](./kibana-plugin-server.savedobjectstypemanagementdefinition.md) &gt; [icon](./kibana-plugin-server.savedobjectstypemanagementdefinition.icon.md)
+
+## SavedObjectsTypeManagementDefinition.icon property
+
+The icon name to display in the management table. If not defined, no icon will be displayed.
+
+<b>Signature:</b>
+
+```typescript
+icon?: string;
+```

docs/development/core/server/kibana-plugin-server.savedobjectstypemanagementdefinition.importableandexportable.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsTypeManagementDefinition](./kibana-plugin-server.savedobjectstypemanagementdefinition.md) &gt; [importableAndExportable](./kibana-plugin-server.savedobjectstypemanagementdefinition.importableandexportable.md)
+
+## SavedObjectsTypeManagementDefinition.importableAndExportable property
+
+Is the type importable or exportable. Defaults to `false`<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+importableAndExportable?: boolean;
+```

docs/development/core/server/kibana-plugin-server.savedobjectstypemanagementdefinition.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectsTypeManagementDefinition](./kibana-plugin-server.savedobjectstypemanagementdefinition.md)
+
+## SavedObjectsTypeManagementDefinition interface
+
+Configuration options for the [type](./kibana-plugin-server.savedobjectstype.md)<!-- -->'s management section.
+
+<b>Signature:</b>
+
+```typescript
+export interface SavedObjectsTypeManagementDefinition 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [defaultSearchField](./kibana-plugin-server.savedobjectstypemanagementdefinition.defaultsearchfield.md) | <code>string</code> | The default search field to use for this type. Defaults to <code>id</code>. |
+|  [getEditUrl](./kibana-plugin-server.savedobjectstypemanagementdefinition.getediturl.md) | <code>(savedObject: SavedObject&lt;any&gt;) =&gt; string</code> | Function returning the url to use to redirect to the edition page of this object. If not defined, edition will not be allowed. |
+|  [getInAppUrl](./kibana-plugin-server.savedobjectstypemanagementdefinition.getinappurl.md) | <code>(savedObject: SavedObject&lt;any&gt;) =&gt; {</code><br/><code>        path: string;</code><br/><code>        uiCapabilitiesPath: string;</code><br/><code>    }</code> | Function returning the url to use to redirect to this object from the management section. If not defined, redirecting to the object will not be allowed. |
+|  [getTitle](./kibana-plugin-server.savedobjectstypemanagementdefinition.gettitle.md) | <code>(savedObject: SavedObject&lt;any&gt;) =&gt; string</code> | Function returning the title to display in the management table. If not defined, will use the object's type and id to generate a label. |
+|  [icon](./kibana-plugin-server.savedobjectstypemanagementdefinition.icon.md) | <code>string</code> | The icon name to display in the management table. If not defined, no icon will be displayed. |
+|  [importableAndExportable](./kibana-plugin-server.savedobjectstypemanagementdefinition.importableandexportable.md) | <code>boolean</code> | Is the type importable or exportable. Defaults to <code>false</code>. |
+

docs/development/core/server/kibana-plugin-server.savedobjecttyperegistry.getimportableandexportabletypes.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectTypeRegistry](./kibana-plugin-server.savedobjecttyperegistry.md) &gt; [getImportableAndExportableTypes](./kibana-plugin-server.savedobjecttyperegistry.getimportableandexportabletypes.md)
+
+## SavedObjectTypeRegistry.getImportableAndExportableTypes() method
+
+Return all [types](./kibana-plugin-server.savedobjectstype.md) currently registered that are importable/exportable.
+
+<b>Signature:</b>
+
+```typescript
+getImportableAndExportableTypes(): SavedObjectsType[];
+```
+<b>Returns:</b>
+
+`SavedObjectsType[]`
+

docs/development/core/server/kibana-plugin-server.savedobjecttyperegistry.isimportableandexportable.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [SavedObjectTypeRegistry](./kibana-plugin-server.savedobjecttyperegistry.md) &gt; [isImportableAndExportable](./kibana-plugin-server.savedobjecttyperegistry.isimportableandexportable.md)
+
+## SavedObjectTypeRegistry.isImportableAndExportable() method
+
+Returns the `management.importableAndExportable` property for given type, or `false` if the type is not registered or does not define a management section.
+
+<b>Signature:</b>
+
+```typescript
+isImportableAndExportable(type: string): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  type | <code>string</code> |  |
+
+<b>Returns:</b>
+
+`boolean`
+

docs/development/core/server/kibana-plugin-server.savedobjecttyperegistry.md

@@ -17,9 +17,11 @@ export declare class SavedObjectTypeRegistry
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [getAllTypes()](./kibana-plugin-server.savedobjecttyperegistry.getalltypes.md) |  | Return all [types](./kibana-plugin-server.savedobjectstype.md) currently registered. |
+|  [getImportableAndExportableTypes()](./kibana-plugin-server.savedobjecttyperegistry.getimportableandexportabletypes.md) |  | Return all [types](./kibana-plugin-server.savedobjectstype.md) currently registered that are importable/exportable. |
 |  [getIndex(type)](./kibana-plugin-server.savedobjecttyperegistry.getindex.md) |  | Returns the <code>indexPattern</code> property for given type, or <code>undefined</code> if the type is not registered. |
 |  [getType(type)](./kibana-plugin-server.savedobjecttyperegistry.gettype.md) |  | Return the [type](./kibana-plugin-server.savedobjectstype.md) definition for given type name. |
 |  [isHidden(type)](./kibana-plugin-server.savedobjecttyperegistry.ishidden.md) |  | Returns the <code>hidden</code> property for given type, or <code>false</code> if the type is not registered. |
+|  [isImportableAndExportable(type)](./kibana-plugin-server.savedobjecttyperegistry.isimportableandexportable.md) |  | Returns the <code>management.importableAndExportable</code> property for given type, or <code>false</code> if the type is not registered or does not define a management section. |
 |  [isNamespaceAgnostic(type)](./kibana-plugin-server.savedobjecttyperegistry.isnamespaceagnostic.md) |  | Returns the <code>namespaceAgnostic</code> property for given type, or <code>false</code> if the type is not registered. |
 |  [registerType(type)](./kibana-plugin-server.savedobjecttyperegistry.registertype.md) |  | Register a [type](./kibana-plugin-server.savedobjectstype.md) inside the registry. A type can only be registered once. subsequent calls with the same type name will throw an error. |