kibana/api_docs/banners.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

156 lines
4.1 KiB
JSON

{
"id": "banners",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"id": "def-common.BannerConfiguration",
"type": "Interface",
"label": "BannerConfiguration",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.BannerConfiguration.placement",
"type": "CompoundType",
"label": "placement",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 16
},
"signature": [
{
"pluginId": "banners",
"scope": "common",
"docId": "kibBannersPluginApi",
"section": "def-common.BannerPlacement",
"text": "BannerPlacement"
}
]
},
{
"tags": [],
"id": "def-common.BannerConfiguration.textContent",
"type": "string",
"label": "textContent",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 17
}
},
{
"tags": [],
"id": "def-common.BannerConfiguration.textColor",
"type": "string",
"label": "textColor",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 18
}
},
{
"tags": [],
"id": "def-common.BannerConfiguration.backgroundColor",
"type": "string",
"label": "backgroundColor",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 19
}
}
],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 15
},
"initialIsOpen": false
},
{
"id": "def-common.BannerInfoResponse",
"type": "Interface",
"label": "BannerInfoResponse",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-common.BannerInfoResponse.allowed",
"type": "boolean",
"label": "allowed",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 9
}
},
{
"tags": [],
"id": "def-common.BannerInfoResponse.banner",
"type": "Object",
"label": "banner",
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 10
},
"signature": [
{
"pluginId": "banners",
"scope": "common",
"docId": "kibBannersPluginApi",
"section": "def-common.BannerConfiguration",
"text": "BannerConfiguration"
}
]
}
],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 8
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"id": "def-common.BannerPlacement",
"type": "Type",
"label": "BannerPlacement",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/banners/common/types.ts",
"lineNumber": 13
},
"signature": [
"\"disabled\" | \"header\""
],
"initialIsOpen": false
}
],
"objects": []
}
}