kibana/api_docs/dashboard_mode.json
Stacey Gammon d5ebbac4f7
Add support for building a deprecation list with usage (#99154)
* Add support for building a deprecation list with usage

* Update API docs
2021-05-06 15:29:47 -04:00

271 lines
8.2 KiB
JSON

{
"id": "dashboardMode",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin",
"type": "Class",
"tags": [],
"label": "DashboardModeServerPlugin",
"description": [],
"signature": [
{
"pluginId": "dashboardMode",
"scope": "server",
"docId": "kibDashboardModePluginApi",
"section": "def-server.DashboardModeServerPlugin",
"text": "DashboardModeServerPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.Plugin",
"text": "Plugin"
},
"<void, void, object, object>"
],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 26
},
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 30
},
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "initializerContext",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<unknown>"
],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 30
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>, { security }: DashboardModeServerSetupDependencies) => void"
],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 34
},
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.setup.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>"
],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 34
},
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.setup.$2",
"type": "Object",
"tags": [],
"label": "{ security }",
"description": [],
"signature": [
"DashboardModeServerSetupDependencies"
],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 34
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.start",
"type": "Function",
"tags": [],
"label": "start",
"description": [],
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
},
") => void"
],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 60
},
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.start.$1",
"type": "Object",
"tags": [],
"label": "core",
"description": [],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreStart",
"text": "CoreStart"
}
],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 60
},
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "dashboardMode",
"id": "def-server.DashboardModeServerPlugin.stop",
"type": "Function",
"tags": [],
"label": "stop",
"description": [],
"signature": [
"() => void"
],
"source": {
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
"lineNumber": 62
},
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [
{
"parentPluginId": "dashboardMode",
"id": "def-common.UI_SETTINGS",
"type": "Object",
"tags": [],
"label": "UI_SETTINGS",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/common/constants.ts",
"lineNumber": 8
},
"deprecated": false,
"children": [
{
"parentPluginId": "dashboardMode",
"id": "def-common.UI_SETTINGS.CONFIG_DASHBOARD_ONLY_MODE_ROLES",
"type": "string",
"tags": [],
"label": "CONFIG_DASHBOARD_ONLY_MODE_ROLES",
"description": [],
"source": {
"path": "x-pack/plugins/dashboard_mode/common/constants.ts",
"lineNumber": 9
},
"deprecated": false
}
],
"initialIsOpen": false
}
]
}
}