2117e1324c
* 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
165 lines
5 KiB
JSON
165 lines
5 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.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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/banners/common/types.ts#L9"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.BannerInfoResponse.banner",
|
|
"type": "Object",
|
|
"label": "banner",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/banners/common/types.ts",
|
|
"lineNumber": 10,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/banners/common/types.ts#L10"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "banners",
|
|
"scope": "common",
|
|
"docId": "kibBannersPluginApi",
|
|
"section": "def-common.BannerConfiguration",
|
|
"text": "BannerConfiguration"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/banners/common/types.ts",
|
|
"lineNumber": 8,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/banners/common/types.ts#L8"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/banners/common/types.ts#L16"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/banners/common/types.ts#L17"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.BannerConfiguration.textColor",
|
|
"type": "string",
|
|
"label": "textColor",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/banners/common/types.ts",
|
|
"lineNumber": 18,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/banners/common/types.ts#L18"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.BannerConfiguration.backgroundColor",
|
|
"type": "string",
|
|
"label": "backgroundColor",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/banners/common/types.ts",
|
|
"lineNumber": 19,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/banners/common/types.ts#L19"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/banners/common/types.ts",
|
|
"lineNumber": 15,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/banners/common/types.ts#L15"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xx-pack/plugins/banners/common/types.ts#L13"
|
|
},
|
|
"signature": [
|
|
"\"disabled\" | \"header\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |