kibana/api_docs/custom_integrations.json
2021-09-30 13:13:54 -04:00

864 lines
31 KiB
JSON

{
"id": "customIntegrations",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "customIntegrations",
"id": "def-public.CustomIntegrationsSetup",
"type": "Interface",
"tags": [],
"label": "CustomIntegrationsSetup",
"description": [],
"path": "src/plugins/custom_integrations/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "customIntegrations",
"id": "def-public.CustomIntegrationsSetup.getAppendCustomIntegrations",
"type": "Function",
"tags": [],
"label": "getAppendCustomIntegrations",
"description": [],
"signature": [
"() => Promise<",
{
"pluginId": "customIntegrations",
"scope": "common",
"docId": "kibCustomIntegrationsPluginApi",
"section": "def-common.CustomIntegration",
"text": "CustomIntegration"
},
"[]>"
],
"path": "src/plugins/custom_integrations/public/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "customIntegrations",
"id": "def-public.CustomIntegrationsStart",
"type": "Interface",
"tags": [],
"label": "CustomIntegrationsStart",
"description": [],
"path": "src/plugins/custom_integrations/public/types.ts",
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "customIntegrations",
"id": "def-server.CategoryCount",
"type": "Interface",
"tags": [],
"label": "CategoryCount",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "customIntegrations",
"id": "def-server.CategoryCount.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-server.CategoryCount.id",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"sample_data\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"updates_available\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegration",
"type": "Interface",
"tags": [],
"label": "CustomIntegration",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegration.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegration.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegration.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegration.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"ui_link\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegration.uiInternalPath",
"type": "string",
"tags": [],
"label": "uiInternalPath",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegration.isBeta",
"type": "boolean",
"tags": [],
"label": "isBeta",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegration.icons",
"type": "Array",
"tags": [],
"label": "icons",
"description": [],
"signature": [
{
"pluginId": "customIntegrations",
"scope": "common",
"docId": "kibCustomIntegrationsPluginApi",
"section": "def-common.CustomIntegrationIcon",
"text": "CustomIntegrationIcon"
},
"[]"
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegration.categories",
"type": "Array",
"tags": [],
"label": "categories",
"description": [],
"signature": [
"(\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"sample_data\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"updates_available\")[]"
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegration.shipper",
"type": "string",
"tags": [],
"label": "shipper",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "customIntegrations",
"id": "def-server.Category",
"type": "Type",
"tags": [],
"label": "Category",
"description": [],
"signature": [
"\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"sample_data\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"updates_available\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegrationsPluginSetup",
"type": "Interface",
"tags": [],
"label": "CustomIntegrationsPluginSetup",
"description": [],
"path": "src/plugins/custom_integrations/server/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegrationsPluginSetup.registerCustomIntegration",
"type": "Function",
"tags": [],
"label": "registerCustomIntegration",
"description": [],
"signature": [
"(customIntegration: Pick<",
{
"pluginId": "customIntegrations",
"scope": "common",
"docId": "kibCustomIntegrationsPluginApi",
"section": "def-common.CustomIntegration",
"text": "CustomIntegration"
},
", \"id\" | \"title\" | \"description\" | \"uiInternalPath\" | \"isBeta\" | \"icons\" | \"categories\" | \"shipper\">) => void"
],
"path": "src/plugins/custom_integrations/server/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegrationsPluginSetup.registerCustomIntegration.$1",
"type": "Object",
"tags": [],
"label": "customIntegration",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "customIntegrations",
"scope": "common",
"docId": "kibCustomIntegrationsPluginApi",
"section": "def-common.CustomIntegration",
"text": "CustomIntegration"
},
", \"id\" | \"title\" | \"description\" | \"uiInternalPath\" | \"isBeta\" | \"icons\" | \"categories\" | \"shipper\">"
],
"path": "src/plugins/custom_integrations/server/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegrationsPluginSetup.getAppendCustomIntegrations",
"type": "Function",
"tags": [],
"label": "getAppendCustomIntegrations",
"description": [],
"signature": [
"() => ",
{
"pluginId": "customIntegrations",
"scope": "common",
"docId": "kibCustomIntegrationsPluginApi",
"section": "def-common.CustomIntegration",
"text": "CustomIntegration"
},
"[]"
],
"path": "src/plugins/custom_integrations/server/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "customIntegrations",
"id": "def-server.CustomIntegrationsPluginStart",
"type": "Interface",
"tags": [],
"label": "CustomIntegrationsPluginStart",
"description": [],
"path": "src/plugins/custom_integrations/server/types.ts",
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "customIntegrations",
"id": "def-common.CategoryCount",
"type": "Interface",
"tags": [],
"label": "CategoryCount",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "customIntegrations",
"id": "def-common.CategoryCount.count",
"type": "number",
"tags": [],
"label": "count",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CategoryCount.id",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"sample_data\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"updates_available\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegration",
"type": "Interface",
"tags": [],
"label": "CustomIntegration",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegration.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegration.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegration.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegration.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"ui_link\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegration.uiInternalPath",
"type": "string",
"tags": [],
"label": "uiInternalPath",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegration.isBeta",
"type": "boolean",
"tags": [],
"label": "isBeta",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegration.icons",
"type": "Array",
"tags": [],
"label": "icons",
"description": [],
"signature": [
{
"pluginId": "customIntegrations",
"scope": "common",
"docId": "kibCustomIntegrationsPluginApi",
"section": "def-common.CustomIntegrationIcon",
"text": "CustomIntegrationIcon"
},
"[]"
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegration.categories",
"type": "Array",
"tags": [],
"label": "categories",
"description": [],
"signature": [
"(\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"sample_data\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"updates_available\")[]"
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegration.shipper",
"type": "string",
"tags": [],
"label": "shipper",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegrationIcon",
"type": "Interface",
"tags": [],
"label": "CustomIntegrationIcon",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegrationIcon.src",
"type": "string",
"tags": [],
"label": "src",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CustomIntegrationIcon.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"eui\" | \"svg\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "customIntegrations",
"id": "def-common.Category",
"type": "Type",
"tags": [],
"label": "Category",
"description": [],
"signature": [
"\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"sample_data\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | \"upload_file\" | \"updates_available\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"customIntegrations\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"customIntegrations\""
],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.ROUTES_ADDABLECUSTOMINTEGRATIONS",
"type": "string",
"tags": [],
"label": "ROUTES_ADDABLECUSTOMINTEGRATIONS",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY",
"type": "Object",
"tags": [],
"label": "CATEGORY_DISPLAY",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.aws",
"type": "string",
"tags": [],
"label": "aws",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.azure",
"type": "string",
"tags": [],
"label": "azure",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.cloud",
"type": "string",
"tags": [],
"label": "cloud",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.config_management",
"type": "string",
"tags": [],
"label": "config_management",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.containers",
"type": "string",
"tags": [],
"label": "containers",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.crm",
"type": "string",
"tags": [],
"label": "crm",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.custom",
"type": "string",
"tags": [],
"label": "custom",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.datastore",
"type": "string",
"tags": [],
"label": "datastore",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.elastic_stack",
"type": "string",
"tags": [],
"label": "elastic_stack",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.google_cloud",
"type": "string",
"tags": [],
"label": "google_cloud",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.kubernetes",
"type": "string",
"tags": [],
"label": "kubernetes",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.languages",
"type": "string",
"tags": [],
"label": "languages",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.message_queue",
"type": "string",
"tags": [],
"label": "message_queue",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.monitoring",
"type": "string",
"tags": [],
"label": "monitoring",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.network",
"type": "string",
"tags": [],
"label": "network",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.notification",
"type": "string",
"tags": [],
"label": "notification",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.os_system",
"type": "string",
"tags": [],
"label": "os_system",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.productivity",
"type": "string",
"tags": [],
"label": "productivity",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.security",
"type": "string",
"tags": [],
"label": "security",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.sample_data",
"type": "string",
"tags": [],
"label": "sample_data",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.support",
"type": "string",
"tags": [],
"label": "support",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.ticketing",
"type": "string",
"tags": [],
"label": "ticketing",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.version_control",
"type": "string",
"tags": [],
"label": "version_control",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.web",
"type": "string",
"tags": [],
"label": "web",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.upload_file",
"type": "string",
"tags": [],
"label": "upload_file",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "customIntegrations",
"id": "def-common.CATEGORY_DISPLAY.updates_available",
"type": "string",
"tags": [],
"label": "updates_available",
"description": [],
"path": "src/plugins/custom_integrations/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
]
}
}