[Index patterns] Deprecate scripted field API functions (#100907)

* deprecate scripted field functions in index patterns api
elastic · Jun 1, 2021 · 9734d1c · 9734d1c
1 parent 6759977
commit 9734d1c
Show file tree

Hide file tree

Showing 11 changed files with 50 additions and 4 deletions.
diff --git a/.../data/public/kibana-plugin-plugins-data-public.indexpattern.addscriptedfield.md b/.../data/public/kibana-plugin-plugins-data-public.indexpattern.addscriptedfield.md
@@ -4,6 +4,10 @@
 
 ## IndexPattern.addScriptedField() method
 
+> Warning: This API is now obsolete.
+> 
+> 
+
 Add scripted field to field list
 
 <b>Signature:</b>

diff --git a/...a/public/kibana-plugin-plugins-data-public.indexpattern.getnonscriptedfields.md b/...a/public/kibana-plugin-plugins-data-public.indexpattern.getnonscriptedfields.md
@@ -4,6 +4,10 @@
 
 ## IndexPattern.getNonScriptedFields() method
 
+> Warning: This API is now obsolete.
+> 
+> 
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/...data/public/kibana-plugin-plugins-data-public.indexpattern.getscriptedfields.md b/...data/public/kibana-plugin-plugins-data-public.indexpattern.getscriptedfields.md
@@ -4,6 +4,10 @@
 
 ## IndexPattern.getScriptedFields() method
 
+> Warning: This API is now obsolete.
+> 
+> 
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/...ta/public/kibana-plugin-plugins-data-public.indexpattern.removescriptedfield.md b/...ta/public/kibana-plugin-plugins-data-public.indexpattern.removescriptedfield.md
@@ -4,6 +4,10 @@
 
 ## IndexPattern.removeScriptedField() method
 
+> Warning: This API is now obsolete.
+> 
+> 
+
 Remove scripted field from field list
 
 <b>Signature:</b>

diff --git a/.../data/server/kibana-plugin-plugins-data-server.indexpattern.addscriptedfield.md b/.../data/server/kibana-plugin-plugins-data-server.indexpattern.addscriptedfield.md
@@ -4,6 +4,10 @@
 
 ## IndexPattern.addScriptedField() method
 
+> Warning: This API is now obsolete.
+> 
+> 
+
 Add scripted field to field list
 
 <b>Signature:</b>

diff --git a/...a/server/kibana-plugin-plugins-data-server.indexpattern.getnonscriptedfields.md b/...a/server/kibana-plugin-plugins-data-server.indexpattern.getnonscriptedfields.md
@@ -4,6 +4,10 @@
 
 ## IndexPattern.getNonScriptedFields() method
 
+> Warning: This API is now obsolete.
+> 
+> 
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/...data/server/kibana-plugin-plugins-data-server.indexpattern.getscriptedfields.md b/...data/server/kibana-plugin-plugins-data-server.indexpattern.getscriptedfields.md
@@ -4,6 +4,10 @@
 
 ## IndexPattern.getScriptedFields() method
 
+> Warning: This API is now obsolete.
+> 
+> 
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/...ta/server/kibana-plugin-plugins-data-server.indexpattern.removescriptedfield.md b/...ta/server/kibana-plugin-plugins-data-server.indexpattern.removescriptedfield.md
@@ -4,6 +4,10 @@
 
 ## IndexPattern.removeScriptedField() method
 
+> Warning: This API is now obsolete.
+> 
+> 
+
 Remove scripted field from field list
 
 <b>Signature:</b>

diff --git a/src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts b/src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts
@@ -240,6 +240,7 @@ export class IndexPattern implements IIndexPattern {
    * @param script script code
    * @param fieldType
    * @param lang
+   * @deprecated use runtime field instead
    */
   async addScriptedField(name: string, script: string, fieldType: string = 'string') {
     const scriptedFields = this.getScriptedFields();
@@ -265,6 +266,7 @@ export class IndexPattern implements IIndexPattern {
   /**
    * Remove scripted field from field list
    * @param fieldName
+   * @deprecated use runtime field instead
    */
 
   removeScriptedField(fieldName: string) {
@@ -274,10 +276,18 @@ export class IndexPattern implements IIndexPattern {
     }
   }
 
+  /**
+   *
+   * @deprecated use runtime field instead
+   */
   getNonScriptedFields() {
     return [...this.fields.getAll().filter((field) => !field.scripted)];
   }
 
+  /**
+   *
+   * @deprecated use runtime field instead
+   */
   getScriptedFields() {
     return [...this.fields.getAll().filter((field) => field.scripted)];
   }

diff --git a/src/plugins/data/public/public.api.md b/src/plugins/data/public/public.api.md
@@ -1307,6 +1307,7 @@ export class IndexPattern implements IIndexPattern {
     // Warning: (ae-forgotten-export) The symbol "IndexPatternDeps" needs to be exported by the entry point index.d.ts
     constructor({ spec, fieldFormats, shortDotsEnable, metaFields, }: IndexPatternDeps);
     addRuntimeField(name: string, runtimeField: RuntimeField): void;
+    // @deprecated
     addScriptedField(name: string, script: string, fieldType?: string): Promise<void>;
     readonly allowNoIndex: boolean;
     // (undocumented)
@@ -1366,7 +1367,7 @@ export class IndexPattern implements IIndexPattern {
     getFieldByName(name: string): IndexPatternField | undefined;
     getFormatterForField(field: IndexPatternField | IndexPatternField['spec'] | IFieldType): FieldFormat;
     getFormatterForFieldNoDefault(fieldname: string): FieldFormat | undefined;
-    // (undocumented)
+    // @deprecated (undocumented)
     getNonScriptedFields(): IndexPatternField[];
     getOriginalSavedObjectBody: () => {
         fieldAttrs?: string | undefined;
@@ -1379,7 +1380,7 @@ export class IndexPattern implements IIndexPattern {
         typeMeta?: string | undefined;
         type?: string | undefined;
     };
-    // (undocumented)
+    // @deprecated (undocumented)
     getScriptedFields(): IndexPatternField[];
     getSourceFiltering(): {
         excludes: any[];
@@ -1397,6 +1398,7 @@ export class IndexPattern implements IIndexPattern {
     // (undocumented)
     metaFields: string[];
     removeRuntimeField(name: string): void;
+    // @deprecated
     removeScriptedField(fieldName: string): void;
     resetOriginalSavedObjectBody: () => void;
     // (undocumented)

diff --git a/src/plugins/data/server/server.api.md b/src/plugins/data/server/server.api.md
@@ -749,6 +749,7 @@ export class IndexPattern implements IIndexPattern {
     // Warning: (ae-forgotten-export) The symbol "IndexPatternDeps" needs to be exported by the entry point index.d.ts
     constructor({ spec, fieldFormats, shortDotsEnable, metaFields, }: IndexPatternDeps);
     addRuntimeField(name: string, runtimeField: RuntimeField): void;
+    // @deprecated
     addScriptedField(name: string, script: string, fieldType?: string): Promise<void>;
     readonly allowNoIndex: boolean;
     // (undocumented)
@@ -812,7 +813,7 @@ export class IndexPattern implements IIndexPattern {
     getFormatterForFieldNoDefault(fieldname: string): FieldFormat | undefined;
     // Warning: (ae-forgotten-export) The symbol "IndexPatternField" needs to be exported by the entry point index.d.ts
     //
-    // (undocumented)
+    // @deprecated (undocumented)
     getNonScriptedFields(): IndexPatternField[];
     getOriginalSavedObjectBody: () => {
         fieldAttrs?: string | undefined;
@@ -825,7 +826,7 @@ export class IndexPattern implements IIndexPattern {
         typeMeta?: string | undefined;
         type?: string | undefined;
     };
-    // (undocumented)
+    // @deprecated (undocumented)
     getScriptedFields(): IndexPatternField[];
     getSourceFiltering(): {
         excludes: any[];
@@ -843,6 +844,7 @@ export class IndexPattern implements IIndexPattern {
     // (undocumented)
     metaFields: string[];
     removeRuntimeField(name: string): void;
+    // @deprecated
     removeScriptedField(fieldName: string): void;
     resetOriginalSavedObjectBody: () => void;
     // (undocumented)