Allow Saved Object type mappings to set a field's doc_values proper…

…ty (elastic#70433) * Allow doc_values to be disabled * Make doc_values optional * doc_values type for CoreFieldMapping * doc_values not doc_value * Update docs Co-authored-by: Elastic Machine <[email protected]>
rudolf · Jul 3, 2020 · f9aef61 · f9aef61
1 parent f7fe5f2
commit f9aef61
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 0 deletions.
diff --git a/.../server/kibana-plugin-core-server.savedobjectscomplexfieldmapping.doc_values.md b/.../server/kibana-plugin-core-server.savedobjectscomplexfieldmapping.doc_values.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsComplexFieldMapping](./kibana-plugin-core-server.savedobjectscomplexfieldmapping.md) &gt; [doc\_values](./kibana-plugin-core-server.savedobjectscomplexfieldmapping.doc_values.md)
+
+## SavedObjectsComplexFieldMapping.doc\_values property
+
+<b>Signature:</b>
+
+```typescript
+doc_values?: boolean;
+```
diff --git a/...opment/core/server/kibana-plugin-core-server.savedobjectscomplexfieldmapping.md b/...opment/core/server/kibana-plugin-core-server.savedobjectscomplexfieldmapping.md
@@ -18,6 +18,7 @@ export interface SavedObjectsComplexFieldMapping
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [doc\_values](./kibana-plugin-core-server.savedobjectscomplexfieldmapping.doc_values.md) | <code>boolean</code> |  |
 |  [properties](./kibana-plugin-core-server.savedobjectscomplexfieldmapping.properties.md) | <code>SavedObjectsMappingProperties</code> |  |
 |  [type](./kibana-plugin-core-server.savedobjectscomplexfieldmapping.type.md) | <code>string</code> |  |
 
diff --git a/...ore/server/kibana-plugin-core-server.savedobjectscorefieldmapping.doc_values.md b/...ore/server/kibana-plugin-core-server.savedobjectscorefieldmapping.doc_values.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [SavedObjectsCoreFieldMapping](./kibana-plugin-core-server.savedobjectscorefieldmapping.md) &gt; [doc\_values](./kibana-plugin-core-server.savedobjectscorefieldmapping.doc_values.md)
+
+## SavedObjectsCoreFieldMapping.doc\_values property
+
+<b>Signature:</b>
+
+```typescript
+doc_values?: boolean;
+```
diff --git a/...velopment/core/server/kibana-plugin-core-server.savedobjectscorefieldmapping.md b/...velopment/core/server/kibana-plugin-core-server.savedobjectscorefieldmapping.md
@@ -16,6 +16,7 @@ export interface SavedObjectsCoreFieldMapping
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [doc\_values](./kibana-plugin-core-server.savedobjectscorefieldmapping.doc_values.md) | <code>boolean</code> |  |
 |  [enabled](./kibana-plugin-core-server.savedobjectscorefieldmapping.enabled.md) | <code>boolean</code> |  |
 |  [fields](./kibana-plugin-core-server.savedobjectscorefieldmapping.fields.md) | <code>{</code><br/><code>        [subfield: string]: {</code><br/><code>            type: string;</code><br/><code>            ignore_above?: number;</code><br/><code>        };</code><br/><code>    }</code> |  |
 |  [index](./kibana-plugin-core-server.savedobjectscorefieldmapping.index.md) | <code>boolean</code> |  |

diff --git a/src/core/server/saved_objects/mappings/types.ts b/src/core/server/saved_objects/mappings/types.ts
@@ -133,6 +133,7 @@ export interface SavedObjectsCoreFieldMapping {
   type: string;
   null_value?: number | boolean | string;
   index?: boolean;
+  doc_values?: boolean;
   enabled?: boolean;
   fields?: {
     [subfield: string]: {
@@ -153,6 +154,7 @@ export interface SavedObjectsCoreFieldMapping {
  * @public
  */
 export interface SavedObjectsComplexFieldMapping {
+  doc_values?: boolean;
   type?: string;
   properties: SavedObjectsMappingProperties;
 }
diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -1978,6 +1978,8 @@ export interface SavedObjectsClientWrapperOptions {
 
 // @public
 export interface SavedObjectsComplexFieldMapping {
+    // (undocumented)
+    doc_values?: boolean;
     // (undocumented)
     properties: SavedObjectsMappingProperties;
     // (undocumented)
@@ -1986,6 +1988,8 @@ export interface SavedObjectsComplexFieldMapping {
 
 // @public
 export interface SavedObjectsCoreFieldMapping {
+    // (undocumented)
+    doc_values?: boolean;
     // (undocumented)
     enabled?: boolean;
     // (undocumented)