kibana/api_docs/management.json
Stacey Gammon 5d1916baae
Add a plugin directory page to the docs build (#112862) (#113314)
* Write plugin directory doc as part of api docs build.

* Replace service folder with the new name for index patterns

* Updated docs

* small update

* update docs
# Conflicts:
#	api_docs/actions.mdx
#	api_docs/apm.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_data_views.json
#	api_docs/data_data_views.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/event_log.mdx
#	api_docs/maps.json
#	api_docs/maps.mdx
#	api_docs/maps_ems.json
#	api_docs/maps_ems.mdx
#	api_docs/observability.mdx
#	api_docs/saved_objects.json
#	api_docs/security_solution.mdx
2021-09-28 16:58:56 -04:00

760 lines
24 KiB
JSON

{
"id": "management",
"client": {
"classes": [
{
"parentPluginId": "management",
"id": "def-public.ManagementApp",
"type": "Class",
"tags": [],
"label": "ManagementApp",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementApp",
"text": "ManagementApp"
},
" extends ",
"ManagementItem"
],
"path": "src/plugins/management/public/utils/management_app.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementApp.mount",
"type": "Function",
"tags": [],
"label": "mount",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementAppMountParams",
"text": "ManagementAppMountParams"
},
") => ",
"Unmount",
" | Promise<",
"Unmount",
">"
],
"path": "src/plugins/management/public/utils/management_app.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementApp.mount.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementAppMountParams",
"text": "ManagementAppMountParams"
}
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "management",
"id": "def-public.ManagementApp.basePath",
"type": "string",
"tags": [],
"label": "basePath",
"description": [],
"path": "src/plugins/management/public/utils/management_app.ts",
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.ManagementApp.keywords",
"type": "Array",
"tags": [],
"label": "keywords",
"description": [],
"signature": [
"string[]"
],
"path": "src/plugins/management/public/utils/management_app.ts",
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.ManagementApp.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/management/public/utils/management_app.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementApp.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.RegisterManagementAppArgs",
"text": "RegisterManagementAppArgs"
}
],
"path": "src/plugins/management/public/utils/management_app.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "management",
"id": "def-public.ManagementSection",
"type": "Class",
"tags": [],
"label": "ManagementSection",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
},
" extends ",
"ManagementItem"
],
"path": "src/plugins/management/public/utils/management_section.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.apps",
"type": "Array",
"tags": [],
"label": "apps",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementApp",
"text": "ManagementApp"
},
"[]"
],
"path": "src/plugins/management/public/utils/management_section.ts",
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/management/public/utils/management_section.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"Pick<Pick<",
"CreateManagementItemArgs",
", \"title\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\"> & Pick<{ id: string; }, \"id\"> & Pick<{ id: string; }, never>, \"id\" | \"title\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\">"
],
"path": "src/plugins/management/public/utils/management_section.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.registerApp",
"type": "Function",
"tags": [],
"label": "registerApp",
"description": [],
"signature": [
"(args: Pick<",
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.RegisterManagementAppArgs",
"text": "RegisterManagementAppArgs"
},
", \"id\" | \"title\" | \"order\" | \"mount\" | \"keywords\" | \"euiIconType\" | \"icon\" | \"tip\">) => ",
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementApp",
"text": "ManagementApp"
}
],
"path": "src/plugins/management/public/utils/management_section.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.registerApp.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.RegisterManagementAppArgs",
"text": "RegisterManagementAppArgs"
},
", \"id\" | \"title\" | \"order\" | \"mount\" | \"keywords\" | \"euiIconType\" | \"icon\" | \"tip\">"
],
"path": "src/plugins/management/public/utils/management_section.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.getApp",
"type": "Function",
"tags": [],
"label": "getApp",
"description": [],
"signature": [
"(id: string) => ",
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementApp",
"text": "ManagementApp"
},
" | undefined"
],
"path": "src/plugins/management/public/utils/management_section.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.getApp.$1",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string"
],
"path": "src/plugins/management/public/utils/management_section.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "management",
"id": "def-public.ManagementSection.getAppsEnabled",
"type": "Function",
"tags": [],
"label": "getAppsEnabled",
"description": [],
"signature": [
"() => ",
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementApp",
"text": "ManagementApp"
},
"[]"
],
"path": "src/plugins/management/public/utils/management_section.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "management",
"id": "def-public.DefinedSections",
"type": "Interface",
"tags": [],
"label": "DefinedSections",
"description": [],
"path": "src/plugins/management/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.DefinedSections.ingest",
"type": "Object",
"tags": [],
"label": "ingest",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.DefinedSections.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.DefinedSections.insightsAndAlerting",
"type": "Object",
"tags": [],
"label": "insightsAndAlerting",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.DefinedSections.security",
"type": "Object",
"tags": [],
"label": "security",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.DefinedSections.kibana",
"type": "Object",
"tags": [],
"label": "kibana",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.DefinedSections.stack",
"type": "Object",
"tags": [],
"label": "stack",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementSection",
"text": "ManagementSection"
}
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "management",
"id": "def-public.ManagementAppMountParams",
"type": "Interface",
"tags": [],
"label": "ManagementAppMountParams",
"description": [],
"path": "src/plugins/management/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementAppMountParams.basePath",
"type": "string",
"tags": [],
"label": "basePath",
"description": [],
"path": "src/plugins/management/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.ManagementAppMountParams.element",
"type": "Object",
"tags": [],
"label": "element",
"description": [],
"signature": [
"HTMLElement"
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.ManagementAppMountParams.setBreadcrumbs",
"type": "Function",
"tags": [],
"label": "setBreadcrumbs",
"description": [],
"signature": [
"(crumbs: ",
"EuiBreadcrumb",
"[]) => void"
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementAppMountParams.setBreadcrumbs.$1",
"type": "Array",
"tags": [],
"label": "crumbs",
"description": [],
"signature": [
"EuiBreadcrumb",
"[]"
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "management",
"id": "def-public.ManagementAppMountParams.history",
"type": "Object",
"tags": [],
"label": "history",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "public",
"docId": "kibCoreApplicationPluginApi",
"section": "def-public.ScopedHistory",
"text": "ScopedHistory"
},
"<unknown>"
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "management",
"id": "def-public.RegisterManagementAppArgs",
"type": "Interface",
"tags": [],
"label": "RegisterManagementAppArgs",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.RegisterManagementAppArgs",
"text": "RegisterManagementAppArgs"
},
" extends ",
"CreateManagementItemArgs"
],
"path": "src/plugins/management/public/utils/management_app.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.RegisterManagementAppArgs.mount",
"type": "Function",
"tags": [],
"label": "mount",
"description": [],
"signature": [
"(params: ",
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementAppMountParams",
"text": "ManagementAppMountParams"
},
") => ",
"Unmount",
" | Promise<",
"Unmount",
">"
],
"path": "src/plugins/management/public/utils/management_app.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "management",
"id": "def-public.RegisterManagementAppArgs.mount.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
{
"pluginId": "management",
"scope": "public",
"docId": "kibManagementPluginApi",
"section": "def-public.ManagementAppMountParams",
"text": "ManagementAppMountParams"
}
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "management",
"id": "def-public.RegisterManagementAppArgs.basePath",
"type": "string",
"tags": [],
"label": "basePath",
"description": [],
"path": "src/plugins/management/public/utils/management_app.ts",
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.RegisterManagementAppArgs.keywords",
"type": "Array",
"tags": [],
"label": "keywords",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/management/public/utils/management_app.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "management",
"id": "def-public.MANAGEMENT_APP_ID",
"type": "string",
"tags": [],
"label": "MANAGEMENT_APP_ID",
"description": [],
"signature": [
"\"management\""
],
"path": "src/plugins/management/common/contants.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "management",
"id": "def-public.ManagementSetup",
"type": "Interface",
"tags": [],
"label": "ManagementSetup",
"description": [],
"path": "src/plugins/management/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "management",
"id": "def-public.ManagementSetup.sections",
"type": "Object",
"tags": [],
"label": "sections",
"description": [],
"signature": [
"SectionsServiceSetup"
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "management",
"id": "def-public.ManagementSetup.locator",
"type": "Object",
"tags": [],
"label": "locator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"ManagementAppLocatorParams",
">"
],
"path": "src/plugins/management/public/types.ts",
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "management",
"id": "def-public.ManagementStart",
"type": "Interface",
"tags": [],
"label": "ManagementStart",
"description": [],
"path": "src/plugins/management/public/types.ts",
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "management",
"id": "def-common.ManagementAppLocator",
"type": "Type",
"tags": [],
"label": "ManagementAppLocator",
"description": [],
"signature": [
{
"pluginId": "share",
"scope": "common",
"docId": "kibSharePluginApi",
"section": "def-common.LocatorPublic",
"text": "LocatorPublic"
},
"<",
"ManagementAppLocatorParams",
">"
],
"path": "src/plugins/management/common/locator.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}