kibana/api_docs/uptime.json
Stacey Gammon 87a5b22626
API DOCS Step 3/3 (#92929)
* 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>
2021-03-02 22:02:17 -05:00

141 lines
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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/uptime/server/kibana.index.ts#L28"
}
},
{
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/uptime/server/kibana.index.ts#L28"
}
}
],
"signature": [
"(server: ",
"UptimeCoreSetup",
", plugins: ",
"UptimeCorePlugins",
") => void"
],
"description": [],
"label": "initServerWithKibana",
"source": {
"path": "x-pack/plugins/uptime/server/kibana.index.ts",
"lineNumber": 28,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/uptime/server/kibana.index.ts#L28"
},
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/uptime/server/kibana.index.ts#L25"
},
"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,
"link": "https://github.com/elastic/kibana/tree/masterx-pack/plugins/uptime/server/kibana.index.ts#L24"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}