87a5b22626
* 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>
243 lines
8.1 KiB
JSON
243 lines
8.1 KiB
JSON
{
|
|
"id": "devTools",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"id": "def-public.DevToolsPlugin",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "DevToolsPlugin",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "devTools",
|
|
"scope": "public",
|
|
"docId": "kibDevToolsPluginApi",
|
|
"section": "def-public.DevToolsPlugin",
|
|
"text": "DevToolsPlugin"
|
|
},
|
|
" implements ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.Plugin",
|
|
"text": "Plugin"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "devTools",
|
|
"scope": "public",
|
|
"docId": "kibDevToolsPluginApi",
|
|
"section": "def-public.DevToolsSetup",
|
|
"text": "DevToolsSetup"
|
|
},
|
|
", void, object, object>"
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-public.DevToolsPlugin.setup",
|
|
"type": "Function",
|
|
"label": "setup",
|
|
"signature": [
|
|
"(coreSetup: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>, { urlForwarding }: { urlForwarding: { forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }; }) => { register: (devToolArgs: ",
|
|
{
|
|
"pluginId": "devTools",
|
|
"scope": "public",
|
|
"docId": "kibDevToolsPluginApi",
|
|
"section": "def-public.CreateDevToolArgs",
|
|
"text": "CreateDevToolArgs"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "devTools",
|
|
"scope": "public",
|
|
"docId": "kibDevToolsPluginApi",
|
|
"section": "def-public.DevToolApp",
|
|
"text": "DevToolApp"
|
|
},
|
|
"; }"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "coreSetup",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/dev_tools/public/plugin.ts",
|
|
"lineNumber": 43,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.DevToolsPlugin.setup.{-urlForwarding }",
|
|
"type": "Object",
|
|
"label": "{ urlForwarding }",
|
|
"tags": [],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.DevToolsPlugin.setup.{-urlForwarding }.urlForwarding",
|
|
"type": "Object",
|
|
"label": "urlForwarding",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/dev_tools/public/plugin.ts",
|
|
"lineNumber": 43,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43"
|
|
},
|
|
"signature": [
|
|
"{ forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/dev_tools/public/plugin.ts",
|
|
"lineNumber": 43,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/dev_tools/public/plugin.ts",
|
|
"lineNumber": 43,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.DevToolsPlugin.start",
|
|
"type": "Function",
|
|
"label": "start",
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/dev_tools/public/plugin.ts",
|
|
"lineNumber": 84,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L84"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.DevToolsPlugin.stop",
|
|
"type": "Function",
|
|
"label": "stop",
|
|
"signature": [
|
|
"() => void"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/dev_tools/public/plugin.ts",
|
|
"lineNumber": 90,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L90"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/dev_tools/public/plugin.ts",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L35"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-public.DevToolsSetup",
|
|
"type": "Interface",
|
|
"label": "DevToolsSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.DevToolsSetup.register",
|
|
"type": "Function",
|
|
"label": "register",
|
|
"description": [
|
|
"\nRegister a developer tool. It will be available\nin the dev tools app under a separate tab.\n\nRegistering dev tools works almost similar to registering\napplications in the core application service,\nbut they will be rendered with a frame containing tabs\nto switch between the tools."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/dev_tools/public/plugin.ts",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L32"
|
|
},
|
|
"signature": [
|
|
"(devTool: ",
|
|
{
|
|
"pluginId": "devTools",
|
|
"scope": "public",
|
|
"docId": "kibDevToolsPluginApi",
|
|
"section": "def-public.CreateDevToolArgs",
|
|
"text": "CreateDevToolArgs"
|
|
},
|
|
") => ",
|
|
{
|
|
"pluginId": "devTools",
|
|
"scope": "public",
|
|
"docId": "kibDevToolsPluginApi",
|
|
"section": "def-public.DevToolApp",
|
|
"text": "DevToolApp"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/dev_tools/public/plugin.ts",
|
|
"lineNumber": 21,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L21"
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |