Skip to content

Commit c686719

Browse files
Allow Saved Object type mappings to set a field's doc_values property (#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]>
1 parent 0066c4b commit c686719

6 files changed

+30
-0
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[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)
4+
5+
## SavedObjectsComplexFieldMapping.doc\_values property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
doc_values?: boolean;
11+
```

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ export interface SavedObjectsComplexFieldMapping
1818

1919
| Property | Type | Description |
2020
| --- | --- | --- |
21+
| [doc\_values](./kibana-plugin-core-server.savedobjectscomplexfieldmapping.doc_values.md) | <code>boolean</code> | |
2122
| [properties](./kibana-plugin-core-server.savedobjectscomplexfieldmapping.properties.md) | <code>SavedObjectsMappingProperties</code> | |
2223
| [type](./kibana-plugin-core-server.savedobjectscomplexfieldmapping.type.md) | <code>string</code> | |
2324

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[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)
4+
5+
## SavedObjectsCoreFieldMapping.doc\_values property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
doc_values?: boolean;
11+
```

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ export interface SavedObjectsCoreFieldMapping
1616

1717
| Property | Type | Description |
1818
| --- | --- | --- |
19+
| [doc\_values](./kibana-plugin-core-server.savedobjectscorefieldmapping.doc_values.md) | <code>boolean</code> | |
1920
| [enabled](./kibana-plugin-core-server.savedobjectscorefieldmapping.enabled.md) | <code>boolean</code> | |
2021
| [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> | |
2122
| [index](./kibana-plugin-core-server.savedobjectscorefieldmapping.index.md) | <code>boolean</code> | |

src/core/server/saved_objects/mappings/types.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ export interface SavedObjectsCoreFieldMapping {
133133
type: string;
134134
null_value?: number | boolean | string;
135135
index?: boolean;
136+
doc_values?: boolean;
136137
enabled?: boolean;
137138
fields?: {
138139
[subfield: string]: {
@@ -153,6 +154,7 @@ export interface SavedObjectsCoreFieldMapping {
153154
* @public
154155
*/
155156
export interface SavedObjectsComplexFieldMapping {
157+
doc_values?: boolean;
156158
type?: string;
157159
properties: SavedObjectsMappingProperties;
158160
}

src/core/server/server.api.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1978,6 +1978,8 @@ export interface SavedObjectsClientWrapperOptions {
19781978

19791979
// @public
19801980
export interface SavedObjectsComplexFieldMapping {
1981+
// (undocumented)
1982+
doc_values?: boolean;
19811983
// (undocumented)
19821984
properties: SavedObjectsMappingProperties;
19831985
// (undocumented)
@@ -1986,6 +1988,8 @@ export interface SavedObjectsComplexFieldMapping {
19861988

19871989
// @public
19881990
export interface SavedObjectsCoreFieldMapping {
1991+
// (undocumented)
1992+
doc_values?: boolean;
19891993
// (undocumented)
19901994
enabled?: boolean;
19911995
// (undocumented)

0 commit comments

Comments
 (0)