ClusterClient but exposes additional callAsCurrentUser method that doesn't use credentials of the Kibana internal user (as callAsInternalUser does) to request Elasticsearch API, but rather passes HTTP headers extracted from the current user request to the API.See [ScopedClusterClient](./kibana-plugin-server.scopedclusterclient.md). |
## Enumerations
@@ -106,6 +107,7 @@ The plugin integrates with the core system via lifecycle events: `setup`
| [RouteValidatorOptions](./kibana-plugin-server.routevalidatoroptions.md) | Additional options for the RouteValidator class to modify its default behaviour. |
| [SavedObject](./kibana-plugin-server.savedobject.md) | |
| [SavedObjectAttributes](./kibana-plugin-server.savedobjectattributes.md) | The data for a Saved Object is stored as an object in the attributes property. |
+| [SavedObjectMigrationMap](./kibana-plugin-server.savedobjectmigrationmap.md) | A map of [migration functions](./kibana-plugin-server.savedobjectmigrationfn.md) to be used for a given type. The map's keys must be valid semver versions.For a given document, only migrations with a higher version number than that of the document will be applied. Migrations are executed in order, starting from the lowest version and ending with the highest one. |
| [SavedObjectReference](./kibana-plugin-server.savedobjectreference.md) | A reference to another saved object. |
| [SavedObjectsBaseOptions](./kibana-plugin-server.savedobjectsbaseoptions.md) | |
| [SavedObjectsBulkCreateObject](./kibana-plugin-server.savedobjectsbulkcreateobject.md) | |
@@ -116,6 +118,8 @@ The plugin integrates with the core system via lifecycle events: `setup`
| [SavedObjectsBulkUpdateResponse](./kibana-plugin-server.savedobjectsbulkupdateresponse.md) | |
| [SavedObjectsClientProviderOptions](./kibana-plugin-server.savedobjectsclientprovideroptions.md) | Options to control the creation of the Saved Objects Client. |
| [SavedObjectsClientWrapperOptions](./kibana-plugin-server.savedobjectsclientwrapperoptions.md) | Options passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance. |
+| [SavedObjectsComplexFieldMapping](./kibana-plugin-server.savedobjectscomplexfieldmapping.md) | See [SavedObjectsFieldMapping](./kibana-plugin-server.savedobjectsfieldmapping.md) for documentation. |
+| [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md) | See [SavedObjectsFieldMapping](./kibana-plugin-server.savedobjectsfieldmapping.md) for documentation. |
| [SavedObjectsCreateOptions](./kibana-plugin-server.savedobjectscreateoptions.md) | |
| [SavedObjectsDeleteByNamespaceOptions](./kibana-plugin-server.savedobjectsdeletebynamespaceoptions.md) | |
| [SavedObjectsDeleteOptions](./kibana-plugin-server.savedobjectsdeleteoptions.md) | |
@@ -132,6 +136,7 @@ The plugin integrates with the core system via lifecycle events: `setup`
| [SavedObjectsImportUnknownError](./kibana-plugin-server.savedobjectsimportunknownerror.md) | Represents a failure to import due to an unknown reason. |
| [SavedObjectsImportUnsupportedTypeError](./kibana-plugin-server.savedobjectsimportunsupportedtypeerror.md) | Represents a failure to import due to having an unsupported saved object type. |
| [SavedObjectsIncrementCounterOptions](./kibana-plugin-server.savedobjectsincrementcounteroptions.md) | |
+| [SavedObjectsMappingProperties](./kibana-plugin-server.savedobjectsmappingproperties.md) | Describe the fields of a [saved object type](./kibana-plugin-server.savedobjectstypemappingdefinition.md). |
| [SavedObjectsMigrationLogger](./kibana-plugin-server.savedobjectsmigrationlogger.md) | |
| [SavedObjectsMigrationVersion](./kibana-plugin-server.savedobjectsmigrationversion.md) | Information about the migrations that have been applied to this SavedObject. When Kibana starts up, KibanaMigrator detects outdated documents and migrates them based on this value. For each migration that has been applied, the plugin's name is used as a key and the latest migration version as the value. |
| [SavedObjectsRawDoc](./kibana-plugin-server.savedobjectsrawdoc.md) | A raw document as represented directly in the saved object index. |
@@ -139,6 +144,8 @@ The plugin integrates with the core system via lifecycle events: `setup`
| [SavedObjectsResolveImportErrorsOptions](./kibana-plugin-server.savedobjectsresolveimporterrorsoptions.md) | Options to control the "resolve import" operation. |
| [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 creating and registering Saved Object client wrappers. |
| [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) | |
+| [SavedObjectsTypeMappingDefinition](./kibana-plugin-server.savedobjectstypemappingdefinition.md) | Describe a saved object type mapping. |
| [SavedObjectsUpdateOptions](./kibana-plugin-server.savedobjectsupdateoptions.md) | |
| [SavedObjectsUpdateResponse](./kibana-plugin-server.savedobjectsupdateresponse.md) | |
| [SessionCookieValidationResult](./kibana-plugin-server.sessioncookievalidationresult.md) | Return type from a function to validate cookie contents. |
@@ -218,10 +225,13 @@ The plugin integrates with the core system via lifecycle events: `setup`
| [RouteValidatorFullConfig](./kibana-plugin-server.routevalidatorfullconfig.md) | Route validations config and options merged into one object |
| [SavedObjectAttribute](./kibana-plugin-server.savedobjectattribute.md) | Type definition for a Saved Object attribute value |
| [SavedObjectAttributeSingle](./kibana-plugin-server.savedobjectattributesingle.md) | Don't use this type, it's simply a helper type for [SavedObjectAttribute](./kibana-plugin-server.savedobjectattribute.md) |
+| [SavedObjectMigrationFn](./kibana-plugin-server.savedobjectmigrationfn.md) | A migration function defined for a [saved objects type](./kibana-plugin-server.savedobjectstype.md) used to migrate it's |
+| [SavedObjectSanitizedDoc](./kibana-plugin-server.savedobjectsanitizeddoc.md) | |
| [SavedObjectsClientContract](./kibana-plugin-server.savedobjectsclientcontract.md) | Saved Objects is Kibana's data persisentence mechanism allowing plugins to use Elasticsearch for storing plugin state.\#\# SavedObjectsClient errorsSince the SavedObjectsClient has its hands in everything we are a little paranoid about the way we present errors back to to application code. Ideally, all errors will be either:1. Caused by bad implementation (ie. undefined is not a function) and as such unpredictable 2. An error that has been classified and decorated appropriately by the decorators in [SavedObjectsErrorHelpers](./kibana-plugin-server.savedobjectserrorhelpers.md)Type 1 errors are inevitable, but since all expected/handle-able errors should be Type 2 the isXYZError() helpers exposed at SavedObjectsErrorHelpers should be used to understand and manage error responses from the SavedObjectsClient.Type 2 errors are decorated versions of the source error, so if the elasticsearch client threw an error it will be decorated based on its type. That means that rather than looking for error.body.error.type or doing substring checks on error.body.error.reason, just use the helpers to understand the meaning of the error:\`\`\`js if (SavedObjectsErrorHelpers.isNotFoundError(error)) { // handle 404 }if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { // 401 handling should be automatic, but in case you wanted to know }// always rethrow the error unless you handle it throw error; \`\`\`\#\#\# 404s from missing indexFrom the perspective of application code and APIs the SavedObjectsClient is a black box that persists objects. One of the internal details that users have no control over is that we use an elasticsearch index for persistance and that index might be missing.At the time of writing we are in the process of transitioning away from the operating assumption that the SavedObjects index is always available. Part of this transition is handling errors resulting from an index missing. These used to trigger a 500 error in most cases, and in others cause 404s with different error messages.From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The object the request/call was targeting could not be found. This is why \#14141 takes special care to ensure that 404 errors are generic and don't distinguish between index missing or document missing.\#\#\# 503s from missing indexUnlike all other methods, create requests are supposed to succeed even when the Kibana index does not exist because it will be automatically created by elasticsearch. When that is not the case it is because Elasticsearch's action.auto_create_index setting prevents it from being created automatically so we throw a special 503 with the intention of informing the user that their Elasticsearch settings need to be updated.See [SavedObjectsClient](./kibana-plugin-server.savedobjectsclient.md) See [SavedObjectsErrorHelpers](./kibana-plugin-server.savedobjectserrorhelpers.md) |
| [SavedObjectsClientFactory](./kibana-plugin-server.savedobjectsclientfactory.md) | Describes the factory used to create instances of the Saved Objects Client. |
| [SavedObjectsClientFactoryProvider](./kibana-plugin-server.savedobjectsclientfactoryprovider.md) | Provider to invoke to retrieve a [SavedObjectsClientFactory](./kibana-plugin-server.savedobjectsclientfactory.md). |
| [SavedObjectsClientWrapperFactory](./kibana-plugin-server.savedobjectsclientwrapperfactory.md) | Describes the factory used to create instances of Saved Objects Client Wrappers. |
+| [SavedObjectsFieldMapping](./kibana-plugin-server.savedobjectsfieldmapping.md) | Describe a [saved object type mapping](./kibana-plugin-server.savedobjectstypemappingdefinition.md) field.Please refer to [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html) For the mapping documentation |
| [ScopeableRequest](./kibana-plugin-server.scopeablerequest.md) | A user credentials container. It accommodates the necessary auth credentials to impersonate the current user.See [KibanaRequest](./kibana-plugin-server.kibanarequest.md). |
| [SharedGlobalConfig](./kibana-plugin-server.sharedglobalconfig.md) | |
| [StringValidation](./kibana-plugin-server.stringvalidation.md) | Allows regex objects or a regex string |
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectmigrationfn.md b/docs/development/core/server/kibana-plugin-server.savedobjectmigrationfn.md
new file mode 100644
index 0000000000000..629d748083737
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectmigrationfn.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectMigrationFn](./kibana-plugin-server.savedobjectmigrationfn.md)
+
+## SavedObjectMigrationFn type
+
+A migration function defined for a [saved objects type](./kibana-plugin-server.savedobjectstype.md) used to migrate it's
+
+Signature:
+
+```typescript
+export declare type SavedObjectMigrationFn = (doc: SavedObjectUnsanitizedDoc, log: SavedObjectsMigrationLogger) => SavedObjectUnsanitizedDoc;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectmigrationmap.md b/docs/development/core/server/kibana-plugin-server.savedobjectmigrationmap.md
new file mode 100644
index 0000000000000..1f49b44f73a72
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectmigrationmap.md
@@ -0,0 +1,27 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectMigrationMap](./kibana-plugin-server.savedobjectmigrationmap.md)
+
+## SavedObjectMigrationMap interface
+
+A map of [migration functions](./kibana-plugin-server.savedobjectmigrationfn.md) to be used for a given type. The map's keys must be valid semver versions.
+
+For a given document, only migrations with a higher version number than that of the document will be applied. Migrations are executed in order, starting from the lowest version and ending with the highest one.
+
+Signature:
+
+```typescript
+export interface SavedObjectMigrationMap
+```
+
+## Example
+
+
+```typescript
+const migrations: SavedObjectMigrationMap = {
+ '1.0.0': migrateToV1,
+ '2.1.0': migrateToV21
+}
+
+```
+
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsanitizeddoc.md b/docs/development/core/server/kibana-plugin-server.savedobjectsanitizeddoc.md
new file mode 100644
index 0000000000000..3c7cd591cd41b
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsanitizeddoc.md
@@ -0,0 +1,12 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectSanitizedDoc](./kibana-plugin-server.savedobjectsanitizeddoc.md)
+
+## SavedObjectSanitizedDoc type
+
+
+Signature:
+
+```typescript
+export declare type SavedObjectSanitizedDoc = SavedObjectDoc & Referencable;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.dynamic.md b/docs/development/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.dynamic.md
new file mode 100644
index 0000000000000..44e548c611b02
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.dynamic.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsComplexFieldMapping](./kibana-plugin-server.savedobjectscomplexfieldmapping.md) > [dynamic](./kibana-plugin-server.savedobjectscomplexfieldmapping.dynamic.md)
+
+## SavedObjectsComplexFieldMapping.dynamic property
+
+Signature:
+
+```typescript
+dynamic?: string;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.md b/docs/development/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.md
new file mode 100644
index 0000000000000..ecb5ec0e88911
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsComplexFieldMapping](./kibana-plugin-server.savedobjectscomplexfieldmapping.md)
+
+## SavedObjectsComplexFieldMapping interface
+
+See [SavedObjectsFieldMapping](./kibana-plugin-server.savedobjectsfieldmapping.md) for documentation.
+
+Signature:
+
+```typescript
+export interface SavedObjectsComplexFieldMapping
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [dynamic](./kibana-plugin-server.savedobjectscomplexfieldmapping.dynamic.md) | string | |
+| [properties](./kibana-plugin-server.savedobjectscomplexfieldmapping.properties.md) | SavedObjectsMappingProperties | |
+| [type](./kibana-plugin-server.savedobjectscomplexfieldmapping.type.md) | string | |
+
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.properties.md b/docs/development/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.properties.md
new file mode 100644
index 0000000000000..7ceb0f8ee43c5
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.properties.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsComplexFieldMapping](./kibana-plugin-server.savedobjectscomplexfieldmapping.md) > [properties](./kibana-plugin-server.savedobjectscomplexfieldmapping.properties.md)
+
+## SavedObjectsComplexFieldMapping.properties property
+
+Signature:
+
+```typescript
+properties: SavedObjectsMappingProperties;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.type.md b/docs/development/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.type.md
new file mode 100644
index 0000000000000..ef0db5123c927
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectscomplexfieldmapping.type.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsComplexFieldMapping](./kibana-plugin-server.savedobjectscomplexfieldmapping.md) > [type](./kibana-plugin-server.savedobjectscomplexfieldmapping.type.md)
+
+## SavedObjectsComplexFieldMapping.type property
+
+Signature:
+
+```typescript
+type?: string;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.enabled.md b/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.enabled.md
new file mode 100644
index 0000000000000..b7e4203977763
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.enabled.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md) > [enabled](./kibana-plugin-server.savedobjectscorefieldmapping.enabled.md)
+
+## SavedObjectsCoreFieldMapping.enabled property
+
+Signature:
+
+```typescript
+enabled?: boolean;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.fields.md b/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.fields.md
new file mode 100644
index 0000000000000..880ef36cd73fc
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.fields.md
@@ -0,0 +1,15 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md) > [fields](./kibana-plugin-server.savedobjectscorefieldmapping.fields.md)
+
+## SavedObjectsCoreFieldMapping.fields property
+
+Signature:
+
+```typescript
+fields?: {
+ [subfield: string]: {
+ type: string;
+ };
+ };
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.index.md b/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.index.md
new file mode 100644
index 0000000000000..31ff5a1d51948
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.index.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md) > [index](./kibana-plugin-server.savedobjectscorefieldmapping.index.md)
+
+## SavedObjectsCoreFieldMapping.index property
+
+Signature:
+
+```typescript
+index?: boolean;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.md b/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.md
new file mode 100644
index 0000000000000..4287921997098
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.md
@@ -0,0 +1,23 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md)
+
+## SavedObjectsCoreFieldMapping interface
+
+See [SavedObjectsFieldMapping](./kibana-plugin-server.savedobjectsfieldmapping.md) for documentation.
+
+Signature:
+
+```typescript
+export interface SavedObjectsCoreFieldMapping
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [enabled](./kibana-plugin-server.savedobjectscorefieldmapping.enabled.md) | boolean | |
+| [fields](./kibana-plugin-server.savedobjectscorefieldmapping.fields.md) | { [subfield: string]: { type: string; }; } | |
+| [index](./kibana-plugin-server.savedobjectscorefieldmapping.index.md) | boolean | |
+| [type](./kibana-plugin-server.savedobjectscorefieldmapping.type.md) | string | |
+
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.type.md b/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.type.md
new file mode 100644
index 0000000000000..8071217af861f
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectscorefieldmapping.type.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsCoreFieldMapping](./kibana-plugin-server.savedobjectscorefieldmapping.md) > [type](./kibana-plugin-server.savedobjectscorefieldmapping.type.md)
+
+## SavedObjectsCoreFieldMapping.type property
+
+Signature:
+
+```typescript
+type: string;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsfieldmapping.md b/docs/development/core/server/kibana-plugin-server.savedobjectsfieldmapping.md
new file mode 100644
index 0000000000000..f31e18e8df670
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsfieldmapping.md
@@ -0,0 +1,15 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsFieldMapping](./kibana-plugin-server.savedobjectsfieldmapping.md)
+
+## SavedObjectsFieldMapping type
+
+Describe a [saved object type mapping](./kibana-plugin-server.savedobjectstypemappingdefinition.md) field.
+
+Please refer to [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html) For the mapping documentation
+
+Signature:
+
+```typescript
+export declare type SavedObjectsFieldMapping = SavedObjectsCoreFieldMapping | SavedObjectsComplexFieldMapping;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsmappingproperties.md b/docs/development/core/server/kibana-plugin-server.savedobjectsmappingproperties.md
new file mode 100644
index 0000000000000..23c5a83afc1f8
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsmappingproperties.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsMappingProperties](./kibana-plugin-server.savedobjectsmappingproperties.md)
+
+## SavedObjectsMappingProperties interface
+
+Describe the fields of a [saved object type](./kibana-plugin-server.savedobjectstypemappingdefinition.md).
+
+Signature:
+
+```typescript
+export interface SavedObjectsMappingProperties
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsmigrationlogger.md b/docs/development/core/server/kibana-plugin-server.savedobjectsmigrationlogger.md
index a98d88700cd55..1b8db4a6c9f8d 100644
--- a/docs/development/core/server/kibana-plugin-server.savedobjectsmigrationlogger.md
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsmigrationlogger.md
@@ -17,5 +17,6 @@ export interface SavedObjectsMigrationLogger
| --- | --- | --- |
| [debug](./kibana-plugin-server.savedobjectsmigrationlogger.debug.md) | (msg: string) => void | |
| [info](./kibana-plugin-server.savedobjectsmigrationlogger.info.md) | (msg: string) => void | |
+| [warn](./kibana-plugin-server.savedobjectsmigrationlogger.warn.md) | (msg: string) => void | |
| [warning](./kibana-plugin-server.savedobjectsmigrationlogger.warning.md) | (msg: string) => void | |
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsmigrationlogger.warn.md b/docs/development/core/server/kibana-plugin-server.savedobjectsmigrationlogger.warn.md
new file mode 100644
index 0000000000000..7ebb1dd5ee4d2
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsmigrationlogger.warn.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsMigrationLogger](./kibana-plugin-server.savedobjectsmigrationlogger.md) > [warn](./kibana-plugin-server.savedobjectsmigrationlogger.warn.md)
+
+## SavedObjectsMigrationLogger.warn property
+
+Signature:
+
+```typescript
+warn: (msg: string) => void;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsmigrationlogger.warning.md b/docs/development/core/server/kibana-plugin-server.savedobjectsmigrationlogger.warning.md
index a87955d603b70..689a799515094 100644
--- a/docs/development/core/server/kibana-plugin-server.savedobjectsmigrationlogger.warning.md
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsmigrationlogger.warning.md
@@ -4,6 +4,11 @@
## SavedObjectsMigrationLogger.warning property
+> Warning: This API is now obsolete.
+>
+> Use `warn` instead.
+>
+
Signature:
```typescript
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsrawdoc._source.md b/docs/development/core/server/kibana-plugin-server.savedobjectsrawdoc._source.md
index dcf207f8120ea..332df982b23eb 100644
--- a/docs/development/core/server/kibana-plugin-server.savedobjectsrawdoc._source.md
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsrawdoc._source.md
@@ -7,5 +7,5 @@
Signature:
```typescript
-_source: any;
+_source: SavedObjectsRawDocSource;
```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsrawdoc.md b/docs/development/core/server/kibana-plugin-server.savedobjectsrawdoc.md
index b0130df01817f..3e3ad7da5aecd 100644
--- a/docs/development/core/server/kibana-plugin-server.savedobjectsrawdoc.md
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsrawdoc.md
@@ -9,7 +9,7 @@ A raw document as represented directly in the saved object index.
Signature:
```typescript
-export interface RawDoc
+export interface SavedObjectsRawDoc
```
## Properties
@@ -19,6 +19,6 @@ export interface RawDoc
| [\_id](./kibana-plugin-server.savedobjectsrawdoc._id.md) | string | |
| [\_primary\_term](./kibana-plugin-server.savedobjectsrawdoc._primary_term.md) | number | |
| [\_seq\_no](./kibana-plugin-server.savedobjectsrawdoc._seq_no.md) | number | |
-| [\_source](./kibana-plugin-server.savedobjectsrawdoc._source.md) | any | |
+| [\_source](./kibana-plugin-server.savedobjectsrawdoc._source.md) | SavedObjectsRawDocSource | |
| [\_type](./kibana-plugin-server.savedobjectsrawdoc._type.md) | string | |
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.generaterawid.md b/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.generaterawid.md
new file mode 100644
index 0000000000000..50fb4433b33c8
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.generaterawid.md
@@ -0,0 +1,26 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsSerializer](./kibana-plugin-server.savedobjectsserializer.md) > [generateRawId](./kibana-plugin-server.savedobjectsserializer.generaterawid.md)
+
+## SavedObjectsSerializer.generateRawId() method
+
+Given a saved object type and id, generates the compound id that is stored in the raw document.
+
+Signature:
+
+```typescript
+generateRawId(namespace: string | undefined, type: string, id?: string): string;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| namespace | string | undefined | |
+| type | string | |
+| id | string | |
+
+Returns:
+
+`string`
+
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.israwsavedobject.md b/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.israwsavedobject.md
new file mode 100644
index 0000000000000..32d00ee1a9f7f
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.israwsavedobject.md
@@ -0,0 +1,24 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsSerializer](./kibana-plugin-server.savedobjectsserializer.md) > [isRawSavedObject](./kibana-plugin-server.savedobjectsserializer.israwsavedobject.md)
+
+## SavedObjectsSerializer.isRawSavedObject() method
+
+Determines whether or not the raw document can be converted to a saved object.
+
+Signature:
+
+```typescript
+isRawSavedObject(rawDoc: SavedObjectsRawDoc): boolean;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| rawDoc | SavedObjectsRawDoc | |
+
+Returns:
+
+`boolean`
+
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.md b/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.md
new file mode 100644
index 0000000000000..5fa84af147b40
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.md
@@ -0,0 +1,29 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsSerializer](./kibana-plugin-server.savedobjectsserializer.md)
+
+## SavedObjectsSerializer class
+
+A serializer that can be used to manually convert [raw](./kibana-plugin-server.savedobjectsrawdoc.md) or [sanitized](./kibana-plugin-server.savedobjectsanitizeddoc.md) documents to the other kind.
+
+Signature:
+
+```typescript
+export declare class SavedObjectsSerializer
+```
+
+## Remarks
+
+Serializer instances should only be created and accessed by calling [SavedObjectsServiceStart.createSerializer](./kibana-plugin-server.savedobjectsservicestart.createserializer.md)
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `SavedObjectsSerializer` class.
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [generateRawId(namespace, type, id)](./kibana-plugin-server.savedobjectsserializer.generaterawid.md) | | Given a saved object type and id, generates the compound id that is stored in the raw document. |
+| [isRawSavedObject(rawDoc)](./kibana-plugin-server.savedobjectsserializer.israwsavedobject.md) | | Determines whether or not the raw document can be converted to a saved object. |
+| [rawToSavedObject(doc)](./kibana-plugin-server.savedobjectsserializer.rawtosavedobject.md) | | Converts a document from the format that is stored in elasticsearch to the saved object client format. |
+| [savedObjectToRaw(savedObj)](./kibana-plugin-server.savedobjectsserializer.savedobjecttoraw.md) | | Converts a document from the saved object client format to the format that is stored in elasticsearch. |
+
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.rawtosavedobject.md b/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.rawtosavedobject.md
new file mode 100644
index 0000000000000..6a8a006241297
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.rawtosavedobject.md
@@ -0,0 +1,24 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsSerializer](./kibana-plugin-server.savedobjectsserializer.md) > [rawToSavedObject](./kibana-plugin-server.savedobjectsserializer.rawtosavedobject.md)
+
+## SavedObjectsSerializer.rawToSavedObject() method
+
+Converts a document from the format that is stored in elasticsearch to the saved object client format.
+
+Signature:
+
+```typescript
+rawToSavedObject(doc: SavedObjectsRawDoc): SavedObjectSanitizedDoc;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| doc | SavedObjectsRawDoc | |
+
+Returns:
+
+`SavedObjectSanitizedDoc`
+
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.savedobjecttoraw.md b/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.savedobjecttoraw.md
new file mode 100644
index 0000000000000..b0d2043665b54
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsserializer.savedobjecttoraw.md
@@ -0,0 +1,24 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsSerializer](./kibana-plugin-server.savedobjectsserializer.md) > [savedObjectToRaw](./kibana-plugin-server.savedobjectsserializer.savedobjecttoraw.md)
+
+## SavedObjectsSerializer.savedObjectToRaw() method
+
+Converts a document from the saved object client format to the format that is stored in elasticsearch.
+
+Signature:
+
+```typescript
+savedObjectToRaw(savedObj: SavedObjectSanitizedDoc): SavedObjectsRawDoc;
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| savedObj | SavedObjectSanitizedDoc | |
+
+Returns:
+
+`SavedObjectsRawDoc`
+
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsservicesetup.md b/docs/development/core/server/kibana-plugin-server.savedobjectsservicesetup.md
index 64fb1f4a5f638..9981bfee0cb7d 100644
--- a/docs/development/core/server/kibana-plugin-server.savedobjectsservicesetup.md
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsservicesetup.md
@@ -20,9 +20,19 @@ When plugins access the Saved Objects client, a new client is created using the
## Example
+
+```ts
import { SavedObjectsClient, CoreSetup } from 'src/core/server';
-export class Plugin() { setup: (core: CoreSetup) => { core.savedObjects.setClientFactory(({ request: KibanaRequest }) => { return new SavedObjectsClient(core.savedObjects.scopedRepository(request)); }) } }
+export class Plugin() {
+ setup: (core: CoreSetup) => {
+ core.savedObjects.setClientFactory(({ request: KibanaRequest }) => {
+ return new SavedObjectsClient(core.savedObjects.scopedRepository(request));
+ })
+ }
+}
+
+```
## Properties
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsservicestart.createserializer.md b/docs/development/core/server/kibana-plugin-server.savedobjectsservicestart.createserializer.md
new file mode 100644
index 0000000000000..b0e7ae1db89c1
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsservicestart.createserializer.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsServiceStart](./kibana-plugin-server.savedobjectsservicestart.md) > [createSerializer](./kibana-plugin-server.savedobjectsservicestart.createserializer.md)
+
+## SavedObjectsServiceStart.createSerializer property
+
+Creates a [serializer](./kibana-plugin-server.savedobjectsserializer.md) that is aware of all registered types.
+
+Signature:
+
+```typescript
+createSerializer: () => SavedObjectsSerializer;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectsservicestart.md b/docs/development/core/server/kibana-plugin-server.savedobjectsservicestart.md
index cf2b4f57a7461..ad34d76bb33f4 100644
--- a/docs/development/core/server/kibana-plugin-server.savedobjectsservicestart.md
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectsservicestart.md
@@ -18,5 +18,6 @@ export interface SavedObjectsServiceStart
| --- | --- | --- |
| [createInternalRepository](./kibana-plugin-server.savedobjectsservicestart.createinternalrepository.md) | (extraTypes?: string[]) => ISavedObjectsRepository | Creates a [Saved Objects repository](./kibana-plugin-server.isavedobjectsrepository.md) that uses the internal Kibana user for authenticating with Elasticsearch. |
| [createScopedRepository](./kibana-plugin-server.savedobjectsservicestart.createscopedrepository.md) | (req: KibanaRequest, extraTypes?: string[]) => ISavedObjectsRepository | Creates a [Saved Objects repository](./kibana-plugin-server.isavedobjectsrepository.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. |
+| [createSerializer](./kibana-plugin-server.savedobjectsservicestart.createserializer.md) | () => SavedObjectsSerializer | Creates a [serializer](./kibana-plugin-server.savedobjectsserializer.md) that is aware of all registered types. |
| [getScopedClient](./kibana-plugin-server.savedobjectsservicestart.getscopedclient.md) | (req: KibanaRequest, options?: SavedObjectsClientProviderOptions) => SavedObjectsClientContract | Creates a [Saved Objects client](./kibana-plugin-server.savedobjectsclientcontract.md) that uses the credentials from the passed in request to authenticate with Elasticsearch. If other plugins have registered Saved Objects client wrappers, these will be applied to extend the functionality of the client.A client that is already scoped to the incoming request is also exposed from the route handler context see [RequestHandlerContext](./kibana-plugin-server.requesthandlercontext.md). |
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectstype.converttoaliasscript.md b/docs/development/core/server/kibana-plugin-server.savedobjectstype.converttoaliasscript.md
new file mode 100644
index 0000000000000..f2519b2600e2f
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectstype.converttoaliasscript.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsType](./kibana-plugin-server.savedobjectstype.md) > [convertToAliasScript](./kibana-plugin-server.savedobjectstype.converttoaliasscript.md)
+
+## SavedObjectsType.convertToAliasScript property
+
+If defined, will be used to convert the type to an alias.
+
+Signature:
+
+```typescript
+convertToAliasScript?: string;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectstype.hidden.md b/docs/development/core/server/kibana-plugin-server.savedobjectstype.hidden.md
new file mode 100644
index 0000000000000..9e611bc8faf27
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectstype.hidden.md
@@ -0,0 +1,15 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsType](./kibana-plugin-server.savedobjectstype.md) > [hidden](./kibana-plugin-server.savedobjectstype.hidden.md)
+
+## SavedObjectsType.hidden property
+
+Is the type hidden by default. If true, repositories will not have access to this type unless explicitly declared as an `extraType` when creating the repository.
+
+See [createInternalRepository](./kibana-plugin-server.savedobjectsservicestart.createinternalrepository.md).
+
+Signature:
+
+```typescript
+hidden: boolean;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectstype.indexpattern.md b/docs/development/core/server/kibana-plugin-server.savedobjectstype.indexpattern.md
new file mode 100644
index 0000000000000..18cb6fe936060
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectstype.indexpattern.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsType](./kibana-plugin-server.savedobjectstype.md) > [indexPattern](./kibana-plugin-server.savedobjectstype.indexpattern.md)
+
+## SavedObjectsType.indexPattern property
+
+If defined, the type instances will be stored in the given index instead of the default one.
+
+Signature:
+
+```typescript
+indexPattern?: string;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectstype.mappings.md b/docs/development/core/server/kibana-plugin-server.savedobjectstype.mappings.md
new file mode 100644
index 0000000000000..3166a2604d728
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectstype.mappings.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsType](./kibana-plugin-server.savedobjectstype.md) > [mappings](./kibana-plugin-server.savedobjectstype.mappings.md)
+
+## SavedObjectsType.mappings property
+
+The [mapping definition](./kibana-plugin-server.savedobjectstypemappingdefinition.md) for the type.
+
+Signature:
+
+```typescript
+mappings: SavedObjectsTypeMappingDefinition;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectstype.md b/docs/development/core/server/kibana-plugin-server.savedobjectstype.md
new file mode 100644
index 0000000000000..1e989652e52bf
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectstype.md
@@ -0,0 +1,28 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsType](./kibana-plugin-server.savedobjectstype.md)
+
+## SavedObjectsType interface
+
+Signature:
+
+```typescript
+export interface SavedObjectsType
+```
+
+## Remarks
+
+This is only internal for now, and will only be public when we expose the registerType API
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [convertToAliasScript](./kibana-plugin-server.savedobjectstype.converttoaliasscript.md) | string | If defined, will be used to convert the type to an alias. |
+| [hidden](./kibana-plugin-server.savedobjectstype.hidden.md) | boolean | Is the type hidden by default. If true, repositories will not have access to this type unless explicitly declared as an extraType when creating the repository.See [createInternalRepository](./kibana-plugin-server.savedobjectsservicestart.createinternalrepository.md). |
+| [indexPattern](./kibana-plugin-server.savedobjectstype.indexpattern.md) | string | If defined, the type instances will be stored in the given index instead of the default one. |
+| [mappings](./kibana-plugin-server.savedobjectstype.mappings.md) | SavedObjectsTypeMappingDefinition | The [mapping definition](./kibana-plugin-server.savedobjectstypemappingdefinition.md) for the type. |
+| [migrations](./kibana-plugin-server.savedobjectstype.migrations.md) | SavedObjectMigrationMap | An optional map of [migrations](./kibana-plugin-server.savedobjectmigrationfn.md) to be used to migrate the type. |
+| [name](./kibana-plugin-server.savedobjectstype.name.md) | string | The name of the type, which is also used as the internal id. |
+| [namespaceAgnostic](./kibana-plugin-server.savedobjectstype.namespaceagnostic.md) | boolean | Is the type global (true), or namespaced (false). |
+
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectstype.migrations.md b/docs/development/core/server/kibana-plugin-server.savedobjectstype.migrations.md
new file mode 100644
index 0000000000000..a7f933ef6e3f7
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectstype.migrations.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsType](./kibana-plugin-server.savedobjectstype.md) > [migrations](./kibana-plugin-server.savedobjectstype.migrations.md)
+
+## SavedObjectsType.migrations property
+
+An optional map of [migrations](./kibana-plugin-server.savedobjectmigrationfn.md) to be used to migrate the type.
+
+Signature:
+
+```typescript
+migrations?: SavedObjectMigrationMap;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectstype.name.md b/docs/development/core/server/kibana-plugin-server.savedobjectstype.name.md
new file mode 100644
index 0000000000000..444152d239cdf
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectstype.name.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsType](./kibana-plugin-server.savedobjectstype.md) > [name](./kibana-plugin-server.savedobjectstype.name.md)
+
+## SavedObjectsType.name property
+
+The name of the type, which is also used as the internal id.
+
+Signature:
+
+```typescript
+name: string;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectstype.namespaceagnostic.md b/docs/development/core/server/kibana-plugin-server.savedobjectstype.namespaceagnostic.md
new file mode 100644
index 0000000000000..5c68942276ec7
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectstype.namespaceagnostic.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsType](./kibana-plugin-server.savedobjectstype.md) > [namespaceAgnostic](./kibana-plugin-server.savedobjectstype.namespaceagnostic.md)
+
+## SavedObjectsType.namespaceAgnostic property
+
+Is the type global (true), or namespaced (false).
+
+Signature:
+
+```typescript
+namespaceAgnostic: boolean;
+```
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.md b/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.md
new file mode 100644
index 0000000000000..99983d3a9f02b
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.md
@@ -0,0 +1,45 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsTypeMappingDefinition](./kibana-plugin-server.savedobjectstypemappingdefinition.md)
+
+## SavedObjectsTypeMappingDefinition interface
+
+Describe a saved object type mapping.
+
+Signature:
+
+```typescript
+export interface SavedObjectsTypeMappingDefinition
+```
+
+## Example
+
+
+```ts
+const typeDefinition: SavedObjectsTypeMappingDefinition = {
+ properties: {
+ enabled: {
+ type: "boolean"
+ },
+ sendUsageFrom: {
+ ignore_above: 256,
+ type: "keyword"
+ },
+ lastReported: {
+ type: "date"
+ },
+ lastVersionChecked: {
+ ignore_above: 256,
+ type: "keyword"
+ },
+ }
+}
+
+```
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| [properties](./kibana-plugin-server.savedobjectstypemappingdefinition.properties.md) | SavedObjectsMappingProperties | |
+
diff --git a/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.properties.md b/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.properties.md
new file mode 100644
index 0000000000000..555870c3fdd7d
--- /dev/null
+++ b/docs/development/core/server/kibana-plugin-server.savedobjectstypemappingdefinition.properties.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [SavedObjectsTypeMappingDefinition](./kibana-plugin-server.savedobjectstypemappingdefinition.md) > [properties](./kibana-plugin-server.savedobjectstypemappingdefinition.properties.md)
+
+## SavedObjectsTypeMappingDefinition.properties property
+
+Signature:
+
+```typescript
+properties: SavedObjectsMappingProperties;
+```
diff --git a/docs/images/management-index-patterns.png b/docs/images/management-index-patterns.png
new file mode 100644
index 0000000000000..232d32893b96d
Binary files /dev/null and b/docs/images/management-index-patterns.png differ
diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc
index 695a4d4f45b02..d4d766c1f5442 100644
--- a/docs/management/advanced-options.asciidoc
+++ b/docs/management/advanced-options.asciidoc
@@ -1,7 +1,7 @@
[[advanced-options]]
-== Setting advanced options
+== Advanced Settings
-The *Advanced Settings* page enables you to directly edit settings that control the behavior of the Kibana application.
+The *Advanced Settings* UI enables you to edit settings that control the behavior of Kibana.
For example, you can change the format used to display dates, specify the default index pattern, and set the precision
for displayed decimal values.
diff --git a/docs/management/index-lifecycle-policies/intro-to-lifecycle-policies.asciidoc b/docs/management/index-lifecycle-policies/intro-to-lifecycle-policies.asciidoc
index 79bd0b8be3ce9..ba1d79710de05 100644
--- a/docs/management/index-lifecycle-policies/intro-to-lifecycle-policies.asciidoc
+++ b/docs/management/index-lifecycle-policies/intro-to-lifecycle-policies.asciidoc
@@ -1,30 +1,30 @@
[role="xpack"]
[[index-lifecycle-policies]]
-== Index lifecycle policies
+== Index Lifecycle Policies
-If you're working with time series data, you don't want to continually dump
-everything into a single index. Instead, you might periodically roll over the
-data to a new index to keep it from growing so big it's slow and expensive.
-As the index ages and you query it less frequently, you’ll likely move it to
+If you're working with time series data, you don't want to continually dump
+everything into a single index. Instead, you might periodically roll over the
+data to a new index to keep it from growing so big it's slow and expensive.
+As the index ages and you query it less frequently, you’ll likely move it to
less expensive hardware and reduce the number of shards and replicas.
-To automatically move an index through its lifecycle, you can create a policy
-to define actions to perform on the index as it ages. Index lifecycle policies
-are especially useful when working with {beats-ref}/beats-reference.html[Beats]
-data shippers, which continually
-send operational data, such as metrics and logs, to Elasticsearch. You can
-automate a rollover to a new index when the existing index reaches a specified
-size or age. This ensures that all indices have a similar size instead of having
-daily indices where size can vary based on the number of Beats and the number
+To automatically move an index through its lifecycle, you can create a policy
+to define actions to perform on the index as it ages. Index lifecycle policies
+are especially useful when working with {beats-ref}/beats-reference.html[Beats]
+data shippers, which continually
+send operational data, such as metrics and logs, to Elasticsearch. You can
+automate a rollover to a new index when the existing index reaches a specified
+size or age. This ensures that all indices have a similar size instead of having
+daily indices where size can vary based on the number of Beats and the number
of events sent.
-{kib}’s *Index Lifecycle Policies* walks you through the process for creating
-and configuring a policy. Before using this feature, you should be familiar
+{kib}’s *Index Lifecycle Policies* walks you through the process for creating
+and configuring a policy. Before using this feature, you should be familiar
with index lifecycle management:
-* For an introduction, see
-{ref}/getting-started-index-lifecycle-management.html[Getting started with index
-lifecycle management].
-* To dig into the concepts and technical details, see
+* For an introduction, refer to
+{ref}/getting-started-index-lifecycle-management.html[Getting started with index
+lifecycle management].
+* To dig into the concepts and technical details, see
{ref}/index-lifecycle-management.html[Managing the index lifecycle].
* To check out the APIs, see {ref}/index-lifecycle-management-api.html[Index lifecycle management API].
diff --git a/docs/management/index-patterns.asciidoc b/docs/management/index-patterns.asciidoc
index 8e687f641c92b..d8073e4590c3c 100644
--- a/docs/management/index-patterns.asciidoc
+++ b/docs/management/index-patterns.asciidoc
@@ -89,39 +89,11 @@ pattern: `*:logstash-*`.
Once an index pattern is configured using the {ccs} syntax, all searches and
aggregations using that index pattern in {kib} take advantage of {ccs}.
+
[float]
+[[reload-fields]]
=== Manage your index pattern
-Once you create an index pattern, manually or with a sample data set,
-you can look at its fields and associated data types.
-You can also perform housekeeping tasks, such as making the
-index pattern the default or deleting it when you longer need it.
-To drill down into the details of an index pattern, click its name in
-the *Index patterns* overview.
-
-[role="screenshot"]
-image:management/index-patterns/images/new-index-pattern.png["Index files and data types"]
-
-From the detailed view, you can perform the following actions:
-
-* *Manage the index fields.* You can add formatters to format values and create
-scripted fields.
-See <
@@ -207,26 +207,26 @@ class TypeSelection extends React.Component
-