[data views] Support include_unmapped in field caps request (#146953)

## Summary Allows data views API `getFieldsForWildcard` to support `include_unmapped` param. Closes #144772
elastic · Dec 6, 2022 · bf103ef · bf103ef
1 parent 556d2a4
commit bf103ef
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 5 deletions.
diff --git a/packages/kbn-optimizer/limits.yml b/packages/kbn-optimizer/limits.yml
@@ -28,7 +28,7 @@ pageLoadAssetSize:
   dataViewEditor: 12000
   dataViewFieldEditor: 27000
   dataViewManagement: 5000
-  dataViews: 46600
+  dataViews: 47000
   dataVisualizer: 27530
   devTools: 38637
   discover: 99999

diff --git a/src/plugins/data_views/common/types.ts b/src/plugins/data_views/common/types.ts
@@ -314,6 +314,7 @@ export interface GetFieldsOptions {
   rollupIndex?: string;
   allowNoIndex?: boolean;
   filter?: QueryDslQueryContainer;
+  includeUnmapped?: boolean;
 }
 
 /**

diff --git a/src/plugins/data_views/public/data_views/data_views_api_client.ts b/src/plugins/data_views/public/data_views/data_views_api_client.ts
@@ -49,7 +49,8 @@ export class DataViewsApiClient implements IDataViewsApiClient {
    * @param options options for fields request
    */
   getFieldsForWildcard(options: GetFieldsOptions) {
-    const { pattern, metaFields, type, rollupIndex, allowNoIndex, filter } = options;
+    const { pattern, metaFields, type, rollupIndex, allowNoIndex, filter, includeUnmapped } =
+      options;
     return this._request<FieldsForWildcardResponse>(
       this._getUrl(['_fields_for_wildcard']),
       {
@@ -58,6 +59,7 @@ export class DataViewsApiClient implements IDataViewsApiClient {
         type,
         rollup_index: rollupIndex,
         allow_no_index: allowNoIndex,
+        include_unmapped: includeUnmapped,
       },
       filter ? JSON.stringify({ index_filter: filter }) : undefined
     ).then((response) => {

diff --git a/src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts b/src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts
@@ -57,7 +57,7 @@ export class IndexPatternsFetcher {
   async getFieldsForWildcard(options: {
     pattern: string | string[];
     metaFields?: string[];
-    fieldCapsOptions?: { allow_no_indices: boolean };
+    fieldCapsOptions?: { allow_no_indices: boolean; includeUnmapped?: boolean };
     type?: string;
     rollupIndex?: string;
     filter?: QueryDslQueryContainer;
@@ -78,6 +78,7 @@ export class IndexPatternsFetcher {
       metaFields,
       fieldCapsOptions: {
         allow_no_indices: allowNoIndices,
+        include_unmapped: fieldCapsOptions?.includeUnmapped,
       },
       filter,
     });

diff --git a/src/plugins/data_views/server/fetcher/lib/es_api.ts b/src/plugins/data_views/server/fetcher/lib/es_api.ts
@@ -42,7 +42,7 @@ export async function callIndexAliasApi(
 interface FieldCapsApiParams {
   callCluster: ElasticsearchClient;
   indices: string[] | string;
-  fieldCapsOptions?: { allow_no_indices: boolean };
+  fieldCapsOptions?: { allow_no_indices: boolean; include_unmapped?: boolean };
   filter?: QueryDslQueryContainer;
 }
 
@@ -65,6 +65,7 @@ export async function callFieldCapsApi(params: FieldCapsApiParams) {
     filter,
     fieldCapsOptions = {
       allow_no_indices: false,
+      include_unmapped: false,
     },
   } = params;
   try {

diff --git a/src/plugins/data_views/server/fetcher/lib/field_capabilities/field_capabilities.ts b/src/plugins/data_views/server/fetcher/lib/field_capabilities/field_capabilities.ts
@@ -19,7 +19,7 @@ interface FieldCapabilitiesParams {
   callCluster: ElasticsearchClient;
   indices: string | string[];
   metaFields: string[];
-  fieldCapsOptions?: { allow_no_indices: boolean };
+  fieldCapsOptions?: { allow_no_indices: boolean; include_unmapped?: boolean };
   filter?: QueryDslQueryContainer;
 }
 

diff --git a/src/plugins/data_views/server/routes/fields_for.ts b/src/plugins/data_views/server/routes/fields_for.ts
@@ -36,6 +36,7 @@ interface IQuery {
   type?: string;
   rollup_index?: string;
   allow_no_index?: boolean;
+  include_unmapped?: boolean;
 }
 
 const validate: RouteValidatorFullConfig<{}, IQuery, IBody> = {
@@ -47,6 +48,7 @@ const validate: RouteValidatorFullConfig<{}, IQuery, IBody> = {
     type: schema.maybe(schema.string()),
     rollup_index: schema.maybe(schema.string()),
     allow_no_index: schema.maybe(schema.boolean()),
+    include_unmapped: schema.maybe(schema.boolean()),
   }),
   // not available to get request
   body: schema.maybe(schema.object({ index_filter: schema.any() })),
@@ -60,6 +62,7 @@ const handler: RequestHandler<{}, IQuery, IBody> = async (context, request, resp
     type,
     rollup_index: rollupIndex,
     allow_no_index: allowNoIndex,
+    include_unmapped: includeUnmapped,
   } = request.query;
 
   // not available to get request
@@ -80,6 +83,7 @@ const handler: RequestHandler<{}, IQuery, IBody> = async (context, request, resp
       rollupIndex,
       fieldCapsOptions: {
         allow_no_indices: allowNoIndex || false,
+        includeUnmapped,
       },
       filter,
     });

diff --git a/test/api_integration/apis/data_views/fields_for_wildcard_route/params.js b/test/api_integration/apis/data_views/fields_for_wildcard_route/params.js
@@ -31,6 +31,15 @@ export default function ({ getService }) {
         })
         .expect(200));
 
+    it('accepts include_unmapped param', () =>
+      supertest
+        .get('/api/index_patterns/_fields_for_wildcard')
+        .query({
+          pattern: '*',
+          include_unmapped: true,
+        })
+        .expect(200));
+
     it('accepts meta_fields query param in string array', () =>
       supertest
         .get('/api/index_patterns/_fields_for_wildcard')