master docs are broken (#93405)

elastic · Mar 3, 2021 · e2fb476 · e2fb476
1 parent 1c01902
commit e2fb476
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 100 deletions.
diff --git a/api_docs/data.json b/api_docs/data.json
@@ -26207,106 +26207,6 @@
         "returnComment": [],
         "initialIsOpen": false
       },
-      {
-        "id": "def-common.getConvertedValueForField",
-        "type": "Function",
-        "children": [
-          {
-            "type": "Object",
-            "label": "field",
-            "isRequired": true,
-            "signature": [
-              {
-                "pluginId": "data",
-                "scope": "common",
-                "docId": "kibDataIndexPatternsPluginApi",
-                "section": "def-common.IFieldType",
-                "text": "IFieldType"
-              }
-            ],
-            "description": [],
-            "source": {
-              "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
-              "lineNumber": 107,
-              "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L107"
-            }
-          },
-          {
-            "type": "Any",
-            "label": "value",
-            "isRequired": true,
-            "signature": [
-              "any"
-            ],
-            "description": [],
-            "source": {
-              "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
-              "lineNumber": 107,
-              "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L107"
-            }
-          }
-        ],
-        "signature": [
-          "(field: ",
-          {
-            "pluginId": "data",
-            "scope": "common",
-            "docId": "kibDataIndexPatternsPluginApi",
-            "section": "def-common.IFieldType",
-            "text": "IFieldType"
-          },
-          ", value: any) => any"
-        ],
-        "description": [
-          "\nSee issues bellow for the reason behind this change.\nValues need to be converted to correct types for boolean \\ numeric fields.\nhttps://github.com/elastic/kibana/issues/74301\nhttps://github.com/elastic/kibana/issues/8677\nhttps://github.com/elastic/elasticsearch/issues/20941\nhttps://github.com/elastic/elasticsearch/pull/22201"
-        ],
-        "label": "getConvertedValueForField",
-        "source": {
-          "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
-          "lineNumber": 107,
-          "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L107"
-        },
-        "tags": [],
-        "returnComment": [],
-        "initialIsOpen": false
-      },
-      {
-        "id": "def-common.buildInlineScriptForPhraseFilter",
-        "type": "Function",
-        "children": [
-          {
-            "type": "Any",
-            "label": "scriptedField",
-            "isRequired": true,
-            "signature": [
-              "any"
-            ],
-            "description": [],
-            "source": {
-              "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
-              "lineNumber": 132,
-              "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L132"
-            }
-          }
-        ],
-        "signature": [
-          "(scriptedField: any) => string"
-        ],
-        "description": [
-          "\nTakes a scripted field and returns an inline script appropriate for use in a script query.\nHandles lucene expression and Painless scripts. Other langs aren't guaranteed to generate valid\nscripts.\n"
-        ],
-        "label": "buildInlineScriptForPhraseFilter",
-        "source": {
-          "path": "src/plugins/data/common/es_query/filters/phrase_filter.ts",
-          "lineNumber": 132,
-          "link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L132"
-        },
-        "tags": [],
-        "returnComment": [
-          "The inline script string"
-        ],
-        "initialIsOpen": false
-      },
       {
         "id": "def-common.isPhrasesFilter",
         "type": "Function",

diff --git a/src/plugins/data/common/es_query/filters/phrase_filter.ts b/src/plugins/data/common/es_query/filters/phrase_filter.ts
@@ -97,6 +97,7 @@ export const getPhraseScript = (field: IFieldType, value: string) => {
 };
 
 /**
+ * @internal
  * See issues bellow for the reason behind this change.
  * Values need to be converted to correct types for boolean \ numeric fields.
  * https://github.com/elastic/kibana/issues/74301
@@ -122,6 +123,7 @@ export const getConvertedValueForField = (field: IFieldType, value: any) => {
 };
 
 /**
+ * @internal
  * Takes a scripted field and returns an inline script appropriate for use in a script query.
  * Handles lucene expression and Painless scripts. Other langs aren't guaranteed to generate valid
  * scripts.