* Clean up api doc infra * updated docs * Update api dics # Conflicts: # api_docs/actions.mdx # api_docs/alerting.json # api_docs/core.mdx # api_docs/core_application.mdx # 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.mdx # api_docs/data_ui.mdx # api_docs/deprecations_by_api.mdx # api_docs/deprecations_by_plugin.mdx # api_docs/discover_enhanced.json # api_docs/expressions.mdx # api_docs/interactive_setup.json # api_docs/interactive_setup.mdx # api_docs/kibana_legacy.json # api_docs/kibana_legacy.mdx # api_docs/observability.json # api_docs/rule_registry.json # api_docs/saved_objects.json # api_docs/security_solution.json # api_docs/security_solution.mdx # api_docs/timelines.json # api_docs/timelines.mdx # api_docs/url_forwarding.json
221 lines
6.4 KiB
JSON
221 lines
6.4 KiB
JSON
{
|
|
"id": "console",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "console",
|
|
"id": "def-public.ConsoleUIPlugin",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "ConsoleUIPlugin",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "console",
|
|
"scope": "public",
|
|
"docId": "kibConsolePluginApi",
|
|
"section": "def-public.ConsoleUIPlugin",
|
|
"text": "ConsoleUIPlugin"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
"<void, void, ",
|
|
"AppSetupUIPluginDependencies",
|
|
", object>"
|
|
],
|
|
"path": "src/plugins/console/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "console",
|
|
"id": "def-public.ConsoleUIPlugin.setup",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setup",
|
|
"description": [],
|
|
"signature": [
|
|
"({ notifications, getStartServices, http }: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>, { devTools, home, share, usageCollection }: ",
|
|
"AppSetupUIPluginDependencies",
|
|
") => { locator: ",
|
|
{
|
|
"pluginId": "share",
|
|
"scope": "common",
|
|
"docId": "kibSharePluginApi",
|
|
"section": "def-common.LocatorPublic",
|
|
"text": "LocatorPublic"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "console",
|
|
"scope": "public",
|
|
"docId": "kibConsolePluginApi",
|
|
"section": "def-public.ConsoleUILocatorParams",
|
|
"text": "ConsoleUILocatorParams"
|
|
},
|
|
">; }"
|
|
],
|
|
"path": "src/plugins/console/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "console",
|
|
"id": "def-public.ConsoleUIPlugin.setup.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ notifications, getStartServices, http }",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>"
|
|
],
|
|
"path": "src/plugins/console/public/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "console",
|
|
"id": "def-public.ConsoleUIPlugin.setup.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ devTools, home, share, usageCollection }",
|
|
"description": [],
|
|
"signature": [
|
|
"AppSetupUIPluginDependencies"
|
|
],
|
|
"path": "src/plugins/console/public/plugin.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "console",
|
|
"id": "def-public.ConsoleUIPlugin.start",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "start",
|
|
"description": [],
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"path": "src/plugins/console/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "console",
|
|
"id": "def-public.ConsoleUILocatorParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ConsoleUILocatorParams",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "console",
|
|
"scope": "public",
|
|
"docId": "kibConsolePluginApi",
|
|
"section": "def-public.ConsoleUILocatorParams",
|
|
"text": "ConsoleUILocatorParams"
|
|
},
|
|
" extends ",
|
|
"SerializableRecord"
|
|
],
|
|
"path": "src/plugins/console/public/plugin.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "console",
|
|
"id": "def-public.ConsoleUILocatorParams.loadFrom",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "loadFrom",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/plugins/console/public/plugin.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"parentPluginId": "console",
|
|
"id": "def-server.ConsoleSetup",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ConsoleSetup",
|
|
"description": [],
|
|
"signature": [
|
|
"{ addExtensionSpecFilePath: (path: string) => void; }"
|
|
],
|
|
"path": "src/plugins/console/server/types.ts",
|
|
"deprecated": false,
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"parentPluginId": "console",
|
|
"id": "def-server.ConsoleStart",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ConsoleStart",
|
|
"description": [],
|
|
"signature": [
|
|
"{ addProcessorDefinition: (processor: unknown) => void; }"
|
|
],
|
|
"path": "src/plugins/console/server/types.ts",
|
|
"deprecated": false,
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |