kibana/api_docs/uptime.json
Stacey Gammon cecdcc538e
API docs clean up (#93508)
* Fix links to github

* Fix links to github

* Update docs to latest

* Sort, remove unneccessary path info, reduce tags

* Go back to having DocDef create the link to avoid backport conflicts

* update api docs
2021-03-05 20:12:28 -05:00

136 lines
3.4 KiB
JSON

{
"id": "uptime",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [
{
"id": "def-server.initServerWithKibana",
"type": "Function",
"children": [
{
"type": "Object",
"label": "server",
"isRequired": true,
"signature": [
{
"pluginId": "uptime",
"scope": "server",
"docId": "kibUptimePluginApi",
"section": "def-server.UptimeCoreSetup",
"text": "UptimeCoreSetup"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 28
}
},
{
"type": "Object",
"label": "plugins",
"isRequired": true,
"signature": [
{
"pluginId": "uptime",
"scope": "server",
"docId": "kibUptimePluginApi",
"section": "def-server.UptimeCorePlugins",
"text": "UptimeCorePlugins"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 28
}
}
],
"signature": [
"(server: ",
"UptimeCoreSetup",
", plugins: ",
"UptimeCorePlugins",
") => void"
],
"description": [],
"label": "initServerWithKibana",
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 28
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"id": "def-server.KibanaServer",
"type": "Interface",
"label": "KibanaServer",
"signature": [
{
"pluginId": "uptime",
"scope": "server",
"docId": "kibUptimePluginApi",
"section": "def-server.KibanaServer",
"text": "KibanaServer"
},
" extends ",
"Server"
],
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.KibanaServer.route",
"type": "Function",
"label": "route",
"description": [],
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 25
},
"signature": [
"(options: ",
{
"pluginId": "uptime",
"scope": "server",
"docId": "kibUptimePluginApi",
"section": "def-server.KibanaRouteOptions",
"text": "KibanaRouteOptions"
},
") => void"
]
}
],
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 24
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}