kibana/api_docs/maps_legacy.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

599 lines
19 KiB
JSON

{
"id": "mapsLegacy",
"client": {
"classes": [
{
"parentPluginId": "mapsLegacy",
"id": "def-public.KibanaMapLayer",
"type": "Class",
"tags": [],
"label": "KibanaMapLayer",
"description": [],
"path": "src/plugins/maps_legacy/public/map/kibana_map_layer.d.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "mapsLegacy",
"id": "def-public.KibanaMapLayer.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/maps_legacy/public/map/kibana_map_layer.d.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.KibanaMapLayer.getBounds",
"type": "Function",
"tags": [],
"label": "getBounds",
"description": [],
"signature": [
"() => Promise<unknown>"
],
"path": "src/plugins/maps_legacy/public/map/kibana_map_layer.d.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.KibanaMapLayer.addToLeafletMap",
"type": "Function",
"tags": [],
"label": "addToLeafletMap",
"description": [],
"signature": [
"(leafletMap: unknown) => void"
],
"path": "src/plugins/maps_legacy/public/map/kibana_map_layer.d.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "mapsLegacy",
"id": "def-public.KibanaMapLayer.addToLeafletMap.$1",
"type": "Unknown",
"tags": [],
"label": "leafletMap",
"description": [],
"signature": [
"unknown"
],
"path": "src/plugins/maps_legacy/public/map/kibana_map_layer.d.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.KibanaMapLayer.removeFromLeafletMap",
"type": "Function",
"tags": [],
"label": "removeFromLeafletMap",
"description": [],
"signature": [
"(leafletMap: unknown) => void"
],
"path": "src/plugins/maps_legacy/public/map/kibana_map_layer.d.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "mapsLegacy",
"id": "def-public.KibanaMapLayer.removeFromLeafletMap.$1",
"type": "Unknown",
"tags": [],
"label": "leafletMap",
"description": [],
"signature": [
"unknown"
],
"path": "src/plugins/maps_legacy/public/map/kibana_map_layer.d.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.KibanaMapLayer.appendLegendContents",
"type": "Function",
"tags": [],
"label": "appendLegendContents",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/maps_legacy/public/map/kibana_map_layer.d.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.KibanaMapLayer.updateExtent",
"type": "Function",
"tags": [],
"label": "updateExtent",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/maps_legacy/public/map/kibana_map_layer.d.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.KibanaMapLayer.movePointer",
"type": "Function",
"tags": [],
"label": "movePointer",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/maps_legacy/public/map/kibana_map_layer.d.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.KibanaMapLayer.getAttributions",
"type": "Function",
"tags": [],
"label": "getAttributions",
"description": [],
"signature": [
"() => unknown"
],
"path": "src/plugins/maps_legacy/public/map/kibana_map_layer.d.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "mapsLegacy",
"id": "def-public.lazyLoadMapsLegacyModules",
"type": "Function",
"tags": [],
"label": "lazyLoadMapsLegacyModules",
"description": [],
"signature": [
"() => Promise<LazyLoadedMapsLegacyModules>"
],
"path": "src/plugins/maps_legacy/public/lazy_load_bundle/index.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.LegacyMapDeprecationMessage",
"type": "Function",
"tags": [],
"label": "LegacyMapDeprecationMessage",
"description": [],
"signature": [
"(props: Props) => JSX.Element"
],
"path": "src/plugins/maps_legacy/public/components/legacy_map_deprecation_message.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "mapsLegacy",
"id": "def-public.LegacyMapDeprecationMessage.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"Props"
],
"path": "src/plugins/maps_legacy/public/components/legacy_map_deprecation_message.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.mapTooltipProvider",
"type": "Function",
"tags": [],
"label": "mapTooltipProvider",
"description": [],
"signature": [
"(element: unknown, formatter: unknown) => () => unknown"
],
"path": "src/plugins/maps_legacy/public/tooltip_provider.d.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "mapsLegacy",
"id": "def-public.mapTooltipProvider.$1",
"type": "Unknown",
"tags": [],
"label": "element",
"description": [],
"signature": [
"unknown"
],
"path": "src/plugins/maps_legacy/public/tooltip_provider.d.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.mapTooltipProvider.$2",
"type": "Unknown",
"tags": [],
"label": "formatter",
"description": [],
"signature": [
"unknown"
],
"path": "src/plugins/maps_legacy/public/tooltip_provider.d.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.WmsOptions",
"type": "Function",
"tags": [],
"label": "WmsOptions",
"description": [],
"signature": [
"({ stateParams, setValue, tmsLayers }: Props<K>) => JSX.Element"
],
"path": "src/plugins/maps_legacy/public/components/wms_options.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "mapsLegacy",
"id": "def-public.WmsOptions.$1",
"type": "Object",
"tags": [],
"label": "{ stateParams, setValue, tmsLayers }",
"description": [],
"signature": [
"Props<K>"
],
"path": "src/plugins/maps_legacy/public/components/wms_options.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "mapsLegacy",
"id": "def-public.WMSOptions",
"type": "Interface",
"tags": [],
"label": "WMSOptions",
"description": [],
"path": "src/plugins/maps_legacy/public/common/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "mapsLegacy",
"id": "def-public.WMSOptions.selectedTmsLayer",
"type": "Object",
"tags": [],
"label": "selectedTmsLayer",
"description": [],
"signature": [
{
"pluginId": "mapsEms",
"scope": "public",
"docId": "kibMapsEmsPluginApi",
"section": "def-public.TmsLayer",
"text": "TmsLayer"
},
" | undefined"
],
"path": "src/plugins/maps_legacy/public/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.WMSOptions.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"path": "src/plugins/maps_legacy/public/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.WMSOptions.url",
"type": "string",
"tags": [],
"label": "url",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/plugins/maps_legacy/public/common/types.ts",
"deprecated": false
},
{
"parentPluginId": "mapsLegacy",
"id": "def-public.WMSOptions.options",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
"{ version?: string | undefined; layers?: string | undefined; format: string; transparent: boolean; attribution?: string | undefined; styles?: string | undefined; }"
],
"path": "src/plugins/maps_legacy/public/common/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "mapsLegacy",
"id": "def-public.MapsLegacyPluginSetup",
"type": "Type",
"tags": [],
"label": "MapsLegacyPluginSetup",
"description": [],
"signature": [
"{ getZoomPrecision: () => any; getPrecision: (val: string) => number; getBaseMapsVis: () => any; }"
],
"path": "src/plugins/maps_legacy/public/index.ts",
"deprecated": false,
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "mapsLegacy",
"id": "def-public.MapsLegacyPluginStart",
"type": "Type",
"tags": [],
"label": "MapsLegacyPluginStart",
"description": [],
"signature": [
"void"
],
"path": "src/plugins/maps_legacy/public/index.ts",
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [
{
"parentPluginId": "mapsLegacy",
"id": "def-server.MapsLegacyPlugin",
"type": "Class",
"tags": [],
"label": "MapsLegacyPlugin",
"description": [],
"signature": [
{
"pluginId": "mapsLegacy",
"scope": "server",
"docId": "kibMapsLegacyPluginApi",
"section": "def-server.MapsLegacyPlugin",
"text": "MapsLegacyPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "mapsLegacy",
"scope": "server",
"docId": "kibMapsLegacyPluginApi",
"section": "def-server.MapsLegacyPluginSetup",
"text": "MapsLegacyPluginSetup"
},
", void, object, object>"
],
"path": "src/plugins/maps_legacy/server/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "mapsLegacy",
"id": "def-server.MapsLegacyPlugin._initializerContext",
"type": "Object",
"tags": [],
"label": "_initializerContext",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<Readonly<{} & {}>>"
],
"path": "src/plugins/maps_legacy/server/index.ts",
"deprecated": false
},
{
"parentPluginId": "mapsLegacy",
"id": "def-server.MapsLegacyPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/maps_legacy/server/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "mapsLegacy",
"id": "def-server.MapsLegacyPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initializerContext",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<Readonly<{} & {}>>"
],
"path": "src/plugins/maps_legacy/server/index.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "mapsLegacy",
"id": "def-server.MapsLegacyPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>) => { config: Readonly<{} & {}>; }"
],
"path": "src/plugins/maps_legacy/server/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "mapsLegacy",
"id": "def-server.MapsLegacyPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>"
],
"path": "src/plugins/maps_legacy/server/index.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "mapsLegacy",
"id": "def-server.MapsLegacyPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/maps_legacy/server/index.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "mapsLegacy",
"id": "def-server.MapsLegacyPluginSetup",
"type": "Interface",
"tags": [],
"label": "MapsLegacyPluginSetup",
"description": [],
"path": "src/plugins/maps_legacy/server/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "mapsLegacy",
"id": "def-server.MapsLegacyPluginSetup.config",
"type": "Object",
"tags": [],
"label": "config",
"description": [],
"signature": [
"{}"
],
"path": "src/plugins/maps_legacy/server/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}