2117e1324c
* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # api_docs/core.json # api_docs/core_application.json # api_docs/core_http.json # api_docs/core_saved_objects.json
252 lines
8.2 KiB
JSON
252 lines
8.2 KiB
JSON
{
|
|
"id": "dashboardMode",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"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>"
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-server.DashboardModeServerPlugin.Unnamed",
|
|
"type": "Function",
|
|
"label": "Constructor",
|
|
"signature": [
|
|
"any"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "initializerContext",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.PluginInitializerContext",
|
|
"text": "PluginInitializerContext"
|
|
},
|
|
"<unknown>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/dashboard_mode/server/plugin.ts#L30"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
|
|
"lineNumber": 30,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/dashboard_mode/server/plugin.ts#L30"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.DashboardModeServerPlugin.setup",
|
|
"type": "Function",
|
|
"label": "setup",
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>, { security }: DashboardModeServerSetupDependencies) => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "core",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/dashboard_mode/server/plugin.ts#L34"
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "{ security }",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"DashboardModeServerSetupDependencies"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/dashboard_mode/server/plugin.ts#L34"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
|
|
"lineNumber": 34,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/dashboard_mode/server/plugin.ts#L34"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.DashboardModeServerPlugin.start",
|
|
"type": "Function",
|
|
"label": "start",
|
|
"signature": [
|
|
"(core: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
},
|
|
") => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "core",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.CoreStart",
|
|
"text": "CoreStart"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
|
|
"lineNumber": 60,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/dashboard_mode/server/plugin.ts#L60"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
|
|
"lineNumber": 60,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/dashboard_mode/server/plugin.ts#L60"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.DashboardModeServerPlugin.stop",
|
|
"type": "Function",
|
|
"label": "stop",
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
|
|
"lineNumber": 62,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/dashboard_mode/server/plugin.ts#L62"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_mode/server/plugin.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/dashboard_mode/server/plugin.ts#L26"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [
|
|
{
|
|
"id": "def-common.UI_SETTINGS",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.UI_SETTINGS.CONFIG_DASHBOARD_ONLY_MODE_ROLES",
|
|
"type": "string",
|
|
"label": "CONFIG_DASHBOARD_ONLY_MODE_ROLES",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_mode/common/constants.ts",
|
|
"lineNumber": 9,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/dashboard_mode/common/constants.ts#L9"
|
|
}
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "UI_SETTINGS",
|
|
"source": {
|
|
"path": "x-pack/plugins/dashboard_mode/common/constants.ts",
|
|
"lineNumber": 8,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/dashboard_mode/common/constants.ts#L8"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
}
|
|
} |