kibana/api_docs/vis_type_timelion.json
Stacey Gammon 53fa5ff3fd
API Doc Fixes (#109685) (#110466)
* Fixes

- Fix bad formatting of deprecated apis by plugin
- Collect deprecated apis recursively
- Include unreferenced apis in Deprecated apis by API page.

* Fix unreferenced dep list

* check in updated docs

* Fix the issue with saved objects management plugin docs not being included

* adding the new docs after fixing some docs missing

* update api docs
# Conflicts:
#	api_docs/apm.json
#	api_docs/charts.mdx
#	api_docs/core.mdx
#	api_docs/core_application.mdx
#	api_docs/core_chrome.json
#	api_docs/core_chrome.mdx
#	api_docs/core_http.mdx
#	api_docs/core_saved_objects.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_index_patterns.json
#	api_docs/data_index_patterns.mdx
#	api_docs/data_query.mdx
#	api_docs/data_search.json
#	api_docs/data_search.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations_by_api.mdx
#	api_docs/deprecations_by_plugin.mdx
#	api_docs/expression_shape.json
#	api_docs/expression_shape.mdx
#	api_docs/expressions.json
#	api_docs/field_formats.json
#	api_docs/fleet.json
#	api_docs/kibana_react.json
#	api_docs/kibana_react.mdx
#	api_docs/lists.json
#	api_docs/observability.json
#	api_docs/reporting.json
#	api_docs/rule_registry.json
#	api_docs/rule_registry.mdx
#	api_docs/security_solution.json
#	api_docs/security_solution.mdx
#	api_docs/timelines.json
#	api_docs/timelines.mdx
#	api_docs/visualizations.mdx
2021-08-30 11:02:04 -04:00

354 lines
12 KiB
JSON

{
"id": "visTypeTimelion",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [
{
"parentPluginId": "visTypeTimelion",
"id": "def-public._LEGACY_",
"type": "Object",
"tags": [],
"label": "_LEGACY_",
"description": [],
"path": "src/plugins/vis_type_timelion/public/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "visTypeTimelion",
"id": "def-public._LEGACY_.DEFAULT_TIME_FORMAT",
"type": "string",
"tags": [],
"label": "DEFAULT_TIME_FORMAT",
"description": [],
"path": "src/plugins/vis_type_timelion/public/index.ts",
"deprecated": false
},
{
"parentPluginId": "visTypeTimelion",
"id": "def-public._LEGACY_.calculateInterval",
"type": "Function",
"tags": [],
"label": "calculateInterval",
"description": [],
"signature": [
"(from: number, to: number, size: number, interval: string, min: string) => string"
],
"path": "src/plugins/vis_type_timelion/public/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "visTypeTimelion",
"id": "def-public.from",
"type": "number",
"tags": [],
"label": "from",
"description": [],
"path": "src/plugins/vis_type_timelion/common/lib/calculate_interval.ts",
"deprecated": false
},
{
"parentPluginId": "visTypeTimelion",
"id": "def-public.to",
"type": "number",
"tags": [],
"label": "to",
"description": [],
"path": "src/plugins/vis_type_timelion/common/lib/calculate_interval.ts",
"deprecated": false
},
{
"parentPluginId": "visTypeTimelion",
"id": "def-public.size",
"type": "number",
"tags": [],
"label": "size",
"description": [],
"path": "src/plugins/vis_type_timelion/common/lib/calculate_interval.ts",
"deprecated": false
},
{
"parentPluginId": "visTypeTimelion",
"id": "def-public.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [],
"path": "src/plugins/vis_type_timelion/common/lib/calculate_interval.ts",
"deprecated": false
},
{
"parentPluginId": "visTypeTimelion",
"id": "def-public.min",
"type": "string",
"tags": [],
"label": "min",
"description": [],
"path": "src/plugins/vis_type_timelion/common/lib/calculate_interval.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "visTypeTimelion",
"id": "def-public._LEGACY_.parseTimelionExpressionAsync",
"type": "Function",
"tags": [],
"label": "parseTimelionExpressionAsync",
"description": [],
"signature": [
"(input: string) => Promise<",
"ParsedExpression",
">"
],
"path": "src/plugins/vis_type_timelion/public/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "visTypeTimelion",
"id": "def-public.input",
"type": "string",
"tags": [],
"label": "input",
"description": [],
"path": "src/plugins/vis_type_timelion/common/parser_async.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "visTypeTimelion",
"id": "def-public._LEGACY_.tickFormatters",
"type": "Function",
"tags": [],
"label": "tickFormatters",
"description": [],
"signature": [
"() => { bits: (val: number) => string; 'bits/s': (val: number) => string; bytes: (val: number) => string; 'bytes/s': (val: number) => string; currency(val: number, axis: ",
"LegacyAxis",
"): string; percent(val: number, axis: ",
"LegacyAxis",
"): string; custom(val: number, axis: ",
"LegacyAxis",
"): string; }"
],
"path": "src/plugins/vis_type_timelion/public/index.ts",
"deprecated": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "visTypeTimelion",
"id": "def-public._LEGACY_.getTimezone",
"type": "Function",
"tags": [],
"label": "getTimezone",
"description": [],
"signature": [
"(config: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.IUiSettingsClient",
"text": "IUiSettingsClient"
},
") => string"
],
"path": "src/plugins/vis_type_timelion/public/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "visTypeTimelion",
"id": "def-public.config",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.IUiSettingsClient",
"text": "IUiSettingsClient"
}
],
"path": "src/plugins/vis_type_timelion/public/helpers/get_timezone.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "visTypeTimelion",
"id": "def-public._LEGACY_.xaxisFormatterProvider",
"type": "Function",
"tags": [],
"label": "xaxisFormatterProvider",
"description": [],
"signature": [
"(config: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.IUiSettingsClient",
"text": "IUiSettingsClient"
},
") => (esInterval: any) => any"
],
"path": "src/plugins/vis_type_timelion/public/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "visTypeTimelion",
"id": "def-public.config",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.IUiSettingsClient",
"text": "IUiSettingsClient"
}
],
"path": "src/plugins/vis_type_timelion/public/helpers/xaxis_formatter.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "visTypeTimelion",
"id": "def-public._LEGACY_.generateTicksProvider",
"type": "Function",
"tags": [],
"label": "generateTicksProvider",
"description": [],
"signature": [
"() => (axis: ",
"IAxis",
") => number[]"
],
"path": "src/plugins/vis_type_timelion/public/index.ts",
"deprecated": false,
"returnComment": [],
"children": []
}
],
"initialIsOpen": false
}
],
"start": {
"parentPluginId": "visTypeTimelion",
"id": "def-public.VisTypeTimelionPluginStart",
"type": "Interface",
"tags": [],
"label": "VisTypeTimelionPluginStart",
"description": [],
"path": "src/plugins/vis_type_timelion/public/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "visTypeTimelion",
"id": "def-public.VisTypeTimelionPluginStart.getArgValueSuggestions",
"type": "Function",
"tags": [],
"label": "getArgValueSuggestions",
"description": [],
"signature": [
"() => { hasDynamicSuggestionsForArgument: (functionName: string, argName: string) => any; getDynamicSuggestionsForArgument: (functionName: string, argName: string, functionArgs: ",
"TimelionExpressionArgument",
"[], partialInput?: string) => Promise<any>; getStaticSuggestionsForInput: (partialInput?: string, staticSuggestions?: ",
"TimelionFunctionArgsSuggestion",
"[] | undefined) => ",
"TimelionFunctionArgsSuggestion",
"[]; }"
],
"path": "src/plugins/vis_type_timelion/public/plugin.ts",
"deprecated": false,
"returnComment": [],
"children": []
}
],
"lifecycle": "start",
"initialIsOpen": true
},
"setup": {
"parentPluginId": "visTypeTimelion",
"id": "def-public.VisTypeTimelionPluginSetup",
"type": "Interface",
"tags": [],
"label": "VisTypeTimelionPluginSetup",
"description": [],
"path": "src/plugins/vis_type_timelion/public/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "visTypeTimelion",
"id": "def-public.VisTypeTimelionPluginSetup.isUiEnabled",
"type": "boolean",
"tags": [],
"label": "isUiEnabled",
"description": [],
"path": "src/plugins/vis_type_timelion/public/plugin.ts",
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "visTypeTimelion",
"id": "def-server.PluginSetupContract",
"type": "Interface",
"tags": [],
"label": "PluginSetupContract",
"description": [
"\nDescribes public Timelion plugin contract returned at the `setup` stage."
],
"path": "src/plugins/vis_type_timelion/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "visTypeTimelion",
"id": "def-server.PluginSetupContract.uiEnabled",
"type": "boolean",
"tags": [],
"label": "uiEnabled",
"description": [],
"path": "src/plugins/vis_type_timelion/server/plugin.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}