kibana/api_docs/expression_reveal_image.json
Stacey Gammon e097adbb6a
API Doc Fixes (#109685)
* Fixes

- Fix bad formatting of deprecated apis by plugin
- Collect deprecated apis recursively
- Include unreferenced apis in Deprecated apis by API page.

* Fix unreferenced dep list

* check in updated docs

* Fix the issue with saved objects management plugin docs not being included

* adding the new docs after fixing some docs missing

* update api docs
2021-08-24 13:42:23 -04:00

202 lines
5.9 KiB
JSON

{
"id": "expressionRevealImage",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "expressionRevealImage",
"id": "def-public.revealImageRenderer",
"type": "Function",
"tags": [],
"label": "revealImageRenderer",
"description": [],
"signature": [
"() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionRenderDefinition",
"text": "ExpressionRenderDefinition"
},
"<",
"RevealImageRendererConfig",
">"
],
"path": "src/plugins/expression_reveal_image/public/expression_renderers/reveal_image_renderer.tsx",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "expressionRevealImage",
"id": "def-public.renderers",
"type": "Array",
"tags": [],
"label": "renderers",
"description": [],
"signature": [
"(() => ",
{
"pluginId": "expressions",
"scope": "common",
"docId": "kibExpressionsPluginApi",
"section": "def-common.ExpressionRenderDefinition",
"text": "ExpressionRenderDefinition"
},
"<",
"RevealImageRendererConfig",
">)[]"
],
"path": "src/plugins/expression_reveal_image/public/expression_renderers/index.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "expressionRevealImage",
"id": "def-public.ExpressionRevealImagePluginStart",
"type": "Type",
"tags": [],
"label": "ExpressionRevealImagePluginStart",
"description": [],
"signature": [
"void"
],
"path": "src/plugins/expression_reveal_image/public/plugin.ts",
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"start": {
"parentPluginId": "expressionRevealImage",
"id": "def-server.ExpressionRevealImagePluginStart",
"type": "Type",
"tags": [],
"label": "ExpressionRevealImagePluginStart",
"description": [],
"signature": [
"void"
],
"path": "src/plugins/expression_reveal_image/server/plugin.ts",
"deprecated": false,
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "expressionRevealImage",
"id": "def-common.revealImageFunction",
"type": "Function",
"tags": [],
"label": "revealImageFunction",
"description": [],
"signature": [
"() => { name: \"revealImage\"; aliases: never[]; type: \"render\"; inputTypes: \"number\"[]; help: string; args: { image: { types: (\"string\" | \"null\")[]; help: string; default: null; }; emptyImage: { types: (\"string\" | \"null\")[]; help: string; default: null; }; origin: { types: \"string\"[]; help: string; default: string; options: ",
"Origin",
"[]; }; }; fn: (percent: number, args: Arguments) => Promise<{ type: \"render\"; as: string; value: { image: string; emptyImage: string; origin: ",
"Origin",
"; percent: number; }; }>; }"
],
"path": "src/plugins/expression_reveal_image/common/expression_functions/reveal_image_function.ts",
"deprecated": false,
"children": [],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "expressionRevealImage",
"id": "def-common.BASE64",
"type": "string",
"tags": [],
"label": "BASE64",
"description": [],
"signature": [
"\"`base64`\""
],
"path": "src/plugins/expression_reveal_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRevealImage",
"id": "def-common.functions",
"type": "Array",
"tags": [],
"label": "functions",
"description": [],
"signature": [
"ExpressionRevealImageFunction",
"[]"
],
"path": "src/plugins/expression_reveal_image/common/expression_functions/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRevealImage",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"expressionRevealImage\""
],
"path": "src/plugins/expression_reveal_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRevealImage",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"expressionRevealImage\""
],
"path": "src/plugins/expression_reveal_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "expressionRevealImage",
"id": "def-common.URL",
"type": "string",
"tags": [],
"label": "URL",
"description": [],
"signature": [
"\"URL\""
],
"path": "src/plugins/expression_reveal_image/common/constants.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}