* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # api_docs/core.json # api_docs/core_application.json # api_docs/core_http.json # api_docs/core_saved_objects.json
438 lines
16 KiB
JSON
438 lines
16 KiB
JSON
{
|
|
"id": "data.autocomplete",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.QuerySuggestionGetFnArgs",
|
|
"type": "Interface",
|
|
"label": "QuerySuggestionGetFnArgs",
|
|
"description": [],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionGetFnArgs.language",
|
|
"type": "string",
|
|
"label": "language",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L25"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionGetFnArgs.indexPatterns",
|
|
"type": "Array",
|
|
"label": "indexPatterns",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L26"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IIndexPattern",
|
|
"text": "IIndexPattern"
|
|
},
|
|
"[]"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionGetFnArgs.query",
|
|
"type": "string",
|
|
"label": "query",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L27"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionGetFnArgs.selectionStart",
|
|
"type": "number",
|
|
"label": "selectionStart",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L28"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionGetFnArgs.selectionEnd",
|
|
"type": "number",
|
|
"label": "selectionEnd",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L29"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionGetFnArgs.signal",
|
|
"type": "Object",
|
|
"label": "signal",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L30"
|
|
},
|
|
"signature": [
|
|
"AbortSignal | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionGetFnArgs.useTimeRange",
|
|
"type": "CompoundType",
|
|
"label": "useTimeRange",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L31"
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionGetFnArgs.boolFilter",
|
|
"type": "Any",
|
|
"label": "boolFilter",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L32"
|
|
},
|
|
"signature": [
|
|
"any"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 24,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L24"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.QuerySuggestionBasic",
|
|
"type": "Interface",
|
|
"label": "QuerySuggestionBasic",
|
|
"description": [],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionBasic.type",
|
|
"type": "Enum",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 37,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L37"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataAutocompletePluginApi",
|
|
"section": "def-public.QuerySuggestionTypes",
|
|
"text": "QuerySuggestionTypes"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionBasic.description",
|
|
"type": "CompoundType",
|
|
"label": "description",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 38,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L38"
|
|
},
|
|
"signature": [
|
|
"string | JSX.Element | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionBasic.end",
|
|
"type": "number",
|
|
"label": "end",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 39,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L39"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionBasic.start",
|
|
"type": "number",
|
|
"label": "start",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 40,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L40"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionBasic.text",
|
|
"type": "string",
|
|
"label": "text",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 41,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L41"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionBasic.cursorIndex",
|
|
"type": "number",
|
|
"label": "cursorIndex",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 42,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L42"
|
|
},
|
|
"signature": [
|
|
"number | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 36,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L36"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.QuerySuggestionField",
|
|
"type": "Interface",
|
|
"label": "QuerySuggestionField",
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataAutocompletePluginApi",
|
|
"section": "def-public.QuerySuggestionField",
|
|
"text": "QuerySuggestionField"
|
|
},
|
|
" extends ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataAutocompletePluginApi",
|
|
"section": "def-public.QuerySuggestionBasic",
|
|
"text": "QuerySuggestionBasic"
|
|
}
|
|
],
|
|
"description": [],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionField.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 47,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L47"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataAutocompletePluginApi",
|
|
"section": "def-public.QuerySuggestionTypes",
|
|
"text": "QuerySuggestionTypes"
|
|
},
|
|
".Field"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.QuerySuggestionField.field",
|
|
"type": "Object",
|
|
"label": "field",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 48,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L48"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IFieldType",
|
|
"text": "IFieldType"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 46,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L46"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [
|
|
{
|
|
"id": "def-public.QuerySuggestionTypes",
|
|
"type": "Enum",
|
|
"label": "QuerySuggestionTypes",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 11,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L11"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"misc": [
|
|
{
|
|
"id": "def-public.QuerySuggestion",
|
|
"type": "Type",
|
|
"label": "QuerySuggestion",
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 52,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L52"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataAutocompletePluginApi",
|
|
"section": "def-public.QuerySuggestionBasic",
|
|
"text": "QuerySuggestionBasic"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataAutocompletePluginApi",
|
|
"section": "def-public.QuerySuggestionField",
|
|
"text": "QuerySuggestionField"
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.QuerySuggestionGetFn",
|
|
"type": "Type",
|
|
"label": "QuerySuggestionGetFn",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L19"
|
|
},
|
|
"signature": [
|
|
"(args: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataAutocompletePluginApi",
|
|
"section": "def-public.QuerySuggestionGetFnArgs",
|
|
"text": "QuerySuggestionGetFnArgs"
|
|
},
|
|
") => Promise<",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataAutocompletePluginApi",
|
|
"section": "def-public.QuerySuggestion",
|
|
"text": "QuerySuggestion"
|
|
},
|
|
"[]> | undefined"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.AutocompleteStart",
|
|
"type": "Type",
|
|
"label": "AutocompleteStart",
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/data/public/autocomplete/autocomplete_service.ts",
|
|
"lineNumber": 93,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/data/public/autocomplete/autocomplete_service.ts#L93"
|
|
},
|
|
"signature": [
|
|
"{ getQuerySuggestions: QuerySuggestionGetFn; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ValueSuggestionsGetFn; }"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |