503cfcf8c9
* Track stats and add extra output information * Update api docs output * Clean up id names * update api docs * Consolidate error messages and fix a bug * Update docs * Update get_declaration_nodes_for_plugin.ts * Fix bug with removeBrokenLinks not being recursive * Update docs Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
672 lines
20 KiB
JSON
672 lines
20 KiB
JSON
{
|
|
"id": "management",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"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"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ManagementApp.mount",
|
|
"type": "Function",
|
|
"label": "mount",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_app.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"signature": [
|
|
"Mount"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ManagementApp.basePath",
|
|
"type": "string",
|
|
"label": "basePath",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_app.ts",
|
|
"lineNumber": 21
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ManagementApp.meta",
|
|
"type": "Object",
|
|
"label": "meta",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_app.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.AppMeta",
|
|
"text": "AppMeta"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "def-public.ManagementApp.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-public.ManagementApp.Unnamed.$1",
|
|
"type": "Object",
|
|
"label": "args",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.RegisterManagementAppArgs",
|
|
"text": "RegisterManagementAppArgs"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_app.ts",
|
|
"lineNumber": 24
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_app.ts",
|
|
"lineNumber": 24
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_app.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ManagementSection.apps",
|
|
"type": "Array",
|
|
"label": "apps",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_section.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.ManagementApp",
|
|
"text": "ManagementApp"
|
|
},
|
|
"[]"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-public.ManagementSection.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-public.ManagementSection.Unnamed.$1",
|
|
"type": "Object",
|
|
"label": "args",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Pick<Pick<",
|
|
"CreateManagementItemArgs",
|
|
", \"title\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\"> & Pick<{ id: string; }, \"id\"> & Pick<{ id: string; }, never>, \"title\" | \"id\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_section.ts",
|
|
"lineNumber": 22
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_section.ts",
|
|
"lineNumber": 22
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.ManagementSection.registerApp",
|
|
"type": "Function",
|
|
"label": "registerApp",
|
|
"signature": [
|
|
"(args: Pick<",
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.RegisterManagementAppArgs",
|
|
"text": "RegisterManagementAppArgs"
|
|
},
|
|
", \"title\" | \"id\" | \"order\" | \"meta\" | \"mount\" | \"euiIconType\" | \"icon\" | \"tip\">) => ",
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.ManagementApp",
|
|
"text": "ManagementApp"
|
|
}
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-public.ManagementSection.registerApp.$1",
|
|
"type": "Object",
|
|
"label": "args",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"Pick<",
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.RegisterManagementAppArgs",
|
|
"text": "RegisterManagementAppArgs"
|
|
},
|
|
", \"title\" | \"id\" | \"order\" | \"meta\" | \"mount\" | \"euiIconType\" | \"icon\" | \"tip\">"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_section.ts",
|
|
"lineNumber": 26
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_section.ts",
|
|
"lineNumber": 26
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.ManagementSection.getApp",
|
|
"type": "Function",
|
|
"label": "getApp",
|
|
"signature": [
|
|
"(id: string) => ",
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.ManagementApp",
|
|
"text": "ManagementApp"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"id": "def-public.ManagementSection.getApp.$1",
|
|
"type": "string",
|
|
"label": "id",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_section.ts",
|
|
"lineNumber": 41
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_section.ts",
|
|
"lineNumber": 41
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.ManagementSection.getAppsEnabled",
|
|
"type": "Function",
|
|
"label": "getAppsEnabled",
|
|
"signature": [
|
|
"() => ",
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.ManagementApp",
|
|
"text": "ManagementApp"
|
|
},
|
|
"[]"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_section.ts",
|
|
"lineNumber": 45
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_section.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.DefinedSections",
|
|
"type": "Interface",
|
|
"label": "DefinedSections",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.DefinedSections.ingest",
|
|
"type": "Object",
|
|
"label": "ingest",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 18
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.ManagementSection",
|
|
"text": "ManagementSection"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.DefinedSections.data",
|
|
"type": "Object",
|
|
"label": "data",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 19
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.ManagementSection",
|
|
"text": "ManagementSection"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.DefinedSections.insightsAndAlerting",
|
|
"type": "Object",
|
|
"label": "insightsAndAlerting",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 20
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.ManagementSection",
|
|
"text": "ManagementSection"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.DefinedSections.security",
|
|
"type": "Object",
|
|
"label": "security",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 21
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.ManagementSection",
|
|
"text": "ManagementSection"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.DefinedSections.kibana",
|
|
"type": "Object",
|
|
"label": "kibana",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.ManagementSection",
|
|
"text": "ManagementSection"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.DefinedSections.stack",
|
|
"type": "Object",
|
|
"label": "stack",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 23
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.ManagementSection",
|
|
"text": "ManagementSection"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.ManagementAppMountParams",
|
|
"type": "Interface",
|
|
"label": "ManagementAppMountParams",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ManagementAppMountParams.basePath",
|
|
"type": "string",
|
|
"label": "basePath",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 59
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ManagementAppMountParams.element",
|
|
"type": "Object",
|
|
"label": "element",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 60
|
|
},
|
|
"signature": [
|
|
"HTMLElement"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ManagementAppMountParams.setBreadcrumbs",
|
|
"type": "Function",
|
|
"label": "setBreadcrumbs",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 61
|
|
},
|
|
"signature": [
|
|
"(crumbs: ",
|
|
"EuiBreadcrumb",
|
|
"[]) => void"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ManagementAppMountParams.history",
|
|
"type": "Object",
|
|
"label": "history",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.ScopedHistory",
|
|
"text": "ScopedHistory"
|
|
},
|
|
"<unknown>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 58
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.RegisterManagementAppArgs",
|
|
"type": "Interface",
|
|
"label": "RegisterManagementAppArgs",
|
|
"signature": [
|
|
{
|
|
"pluginId": "management",
|
|
"scope": "public",
|
|
"docId": "kibManagementPluginApi",
|
|
"section": "def-public.RegisterManagementAppArgs",
|
|
"text": "RegisterManagementAppArgs"
|
|
},
|
|
" extends ",
|
|
"CreateManagementItemArgs"
|
|
],
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RegisterManagementAppArgs.mount",
|
|
"type": "Function",
|
|
"label": "mount",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_app.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"signature": [
|
|
"Mount"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RegisterManagementAppArgs.basePath",
|
|
"type": "string",
|
|
"label": "basePath",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_app.ts",
|
|
"lineNumber": 15
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RegisterManagementAppArgs.meta",
|
|
"type": "Object",
|
|
"label": "meta",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_app.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCoreApplicationPluginApi",
|
|
"section": "def-public.AppMeta",
|
|
"text": "AppMeta"
|
|
},
|
|
" | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/management/public/utils/management_app.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.MANAGEMENT_APP_ID",
|
|
"type": "string",
|
|
"label": "MANAGEMENT_APP_ID",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/common/contants.ts",
|
|
"lineNumber": 9
|
|
},
|
|
"signature": [
|
|
"\"management\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-public.ManagementSetup",
|
|
"type": "Interface",
|
|
"label": "ManagementSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.ManagementSetup.sections",
|
|
"type": "Object",
|
|
"label": "sections",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"signature": [
|
|
"SectionsServiceSetup"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-public.ManagementStart",
|
|
"type": "Interface",
|
|
"label": "ManagementStart",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [],
|
|
"source": {
|
|
"path": "src/plugins/management/public/types.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |