kibana/api_docs/canvas.json
Stacey Gammon 2117e1324c
API DOCS Step 3/3 (#92929) (#93530)
* 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
2021-03-03 20:12:24 -05:00

120 lines
3.3 KiB
JSON

{
"id": "canvas",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-public.WithKibanaProps",
"type": "Interface",
"label": "WithKibanaProps",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.WithKibanaProps.kibana",
"type": "Object",
"label": "kibana",
"description": [],
"source": {
"path": "x-pack/plugins/canvas/public/index.ts",
"lineNumber": 16,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/canvas/public/index.ts#L16"
},
"signature": [
"{ services: ",
{
"pluginId": "core",
"scope": "public",
"docId": "kibCorePluginApi",
"section": "def-public.CoreStart",
"text": "CoreStart"
},
" & ",
{
"pluginId": "canvas",
"scope": "public",
"docId": "kibCanvasPluginApi",
"section": "def-public.CanvasStartDeps",
"text": "CanvasStartDeps"
},
" & { canvas: ",
{
"pluginId": "canvas",
"scope": "public",
"docId": "kibCanvasPluginApi",
"section": "def-public.CanvasServices",
"text": "CanvasServices"
},
"; }; }"
]
}
],
"source": {
"path": "x-pack/plugins/canvas/public/index.ts",
"lineNumber": 15,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/canvas/public/index.ts#L15"
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-public.CanvasSetup",
"type": "Type",
"label": "CanvasSetup",
"tags": [
"public"
],
"description": [
"\nThese are the interfaces with your public contracts. You should export these\nfor other plugins to use in _their_ `SetupDeps`/`StartDeps` interfaces."
],
"source": {
"path": "x-pack/plugins/canvas/public/plugin.tsx",
"lineNumber": 63,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/canvas/public/plugin.tsx#L63"
},
"signature": [
"CanvasApi"
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.CanvasStart",
"type": "Type",
"label": "CanvasStart",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/canvas/public/plugin.tsx",
"lineNumber": 64,
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/canvas/public/plugin.tsx#L64"
},
"signature": [
"void"
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}