github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[api-docs] Daily api_docs build (#140871)

Browse source
This commit is contained in:
Kibana Machine 2022-09-15 22:50:49 -06:00 • committed by GitHub
parent ed7b869640
commit 997caf021c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
448 changed files with 7081 additions and 1975 deletions
Download patch file Download diff file Expand all files Collapse all files

831
api_docs/actions.devdocs.json
View file

@ -1444,6 +1444,20 @@
"path": "x-pack/plugins/actions/server/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionTypeExecutorOptions.configurationUtilities",
"type": "Object",
"tags": [],
"label": "configurationUtilities",
"description": [],
"signature": [
"ActionsConfigurationUtilities"
],
"path": "x-pack/plugins/actions/server/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -1667,171 +1681,6 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionParamsType",
"type": "Type",
"tags": [],
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly subAction: \"pushToService\"; readonly subActionParams: Readonly<{} & { incident: Readonly<{} & { tags: string[] | null; title: string; description: string | null; externalId: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/cases_webhook/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionParamsType",
"type": "Type",
"tags": [],
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly message: string; readonly to: string[]; readonly subject: string; readonly cc: string[]; readonly bcc: string[]; readonly kibanaFooterLink: Readonly<{} & { path: string; text: string; }>; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/email.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionParamsType",
"type": "Type",
"tags": [],
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly documents: Record<string, any>[]; readonly indexOverride: string | null; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionParamsType",
"type": "Type",
"tags": [],
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly group?: string | undefined; readonly component?: string | undefined; readonly timestamp?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"error\" | \"warning\" | \"info\" | \"critical\" | undefined; readonly class?: string | undefined; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionParamsType",
"type": "Type",
"tags": [],
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly message: string; readonly level: \"error\" | \"info\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionParamsType",
"type": "Type",
"tags": [],
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly message: string; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionParamsType",
"type": "Type",
"tags": [],
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly body?: string | undefined; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionParamsType",
"type": "Type",
"tags": [],
"label": "ActionParamsType",
"description": [],
"signature": [
"Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; externalId: string | null; severity: string | null; urgency: string | null; impact: string | null; short_description: string; subcategory: string | null; correlation_id: string | null; correlation_display: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }> | Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; externalId: string | null; short_description: string; subcategory: string | null; correlation_id: string | null; correlation_display: string | null; dest_ip: string | string[] | null; malware_hash: string | string[] | null; malware_url: string | string[] | null; source_ip: string | string[] | null; priority: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }>"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionParamsType",
"type": "Type",
"tags": [],
"label": "ActionParamsType",
"description": [],
"signature": [
"Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; parent: string | null; summary: string; externalId: string | null; priority: string | null; issueType: string | null; labels: string[] | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"issueTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"fieldsByIssueType\"; subActionParams: Readonly<{} & { id: string; }>; }> | Readonly<{} & { subAction: \"issues\"; subActionParams: Readonly<{} & { title: string; }>; }> | Readonly<{} & { subAction: \"issue\"; subActionParams: Readonly<{} & { id: string; }>; }>"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionParamsType",
"type": "Type",
"tags": [],
"label": "ActionParamsType",
"description": [],
"signature": [
"Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; name: string; externalId: string | null; incidentTypes: number[] | null; severityCode: number | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"incidentTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"severity\"; subActionParams: Readonly<{} & {}>; }>"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionParamsType",
"type": "Type",
"tags": [],
"label": "ActionParamsType",
"description": [],
"signature": [
"{ readonly message: string; }"
],
"path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionsAuthorization",
@ -1947,186 +1796,6 @@
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionTypeId",
"type": "string",
"tags": [],
"label": "ActionTypeId",
"description": [],
"signature": [
"\".cases-webhook\""
],
"path": "x-pack/plugins/actions/server/builtin_action_types/cases_webhook/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionTypeId",
"type": "string",
"tags": [],
"label": "ActionTypeId",
"description": [],
"signature": [
"\".email\""
],
"path": "x-pack/plugins/actions/server/builtin_action_types/email.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionTypeId",
"type": "string",
"tags": [],
"label": "ActionTypeId",
"description": [],
"signature": [
"\".index\""
],
"path": "x-pack/plugins/actions/server/builtin_action_types/es_index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionTypeId",
"type": "string",
"tags": [],
"label": "ActionTypeId",
"description": [],
"signature": [
"\".pagerduty\""
],
"path": "x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionTypeId",
"type": "string",
"tags": [],
"label": "ActionTypeId",
"description": [],
"signature": [
"\".server-log\""
],
"path": "x-pack/plugins/actions/server/builtin_action_types/server_log.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionTypeId",
"type": "string",
"tags": [],
"label": "ActionTypeId",
"description": [],
"signature": [
"\".slack\""
],
"path": "x-pack/plugins/actions/server/builtin_action_types/slack.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionTypeId",
"type": "string",
"tags": [],
"label": "ActionTypeId",
"description": [],
"signature": [
"\".webhook\""
],
"path": "x-pack/plugins/actions/server/builtin_action_types/webhook.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionTypeId",
"type": "string",
"tags": [],
"label": "ActionTypeId",
"description": [],
"signature": [
"\".jira\""
],
"path": "x-pack/plugins/actions/server/builtin_action_types/jira/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionTypeId",
"type": "string",
"tags": [],
"label": "ActionTypeId",
"description": [],
"signature": [
"\".resilient\""
],
"path": "x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ActionTypeId",
"type": "string",
"tags": [],
"label": "ActionTypeId",
"description": [],
"signature": [
"\".teams\""
],
"path": "x-pack/plugins/actions/server/builtin_action_types/teams.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ServiceNowITSMActionTypeId",
"type": "string",
"tags": [],
"label": "ServiceNowITSMActionTypeId",
"description": [],
"signature": [
"\".servicenow\""
],
"path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-server.ServiceNowSIRActionTypeId",
"type": "string",
"tags": [],
"label": "ServiceNowSIRActionTypeId",
"description": [],
"signature": [
"\".servicenow-sir\""
],
"path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
@ -3386,89 +3055,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.SNProductsConfigValue",
"type": "Interface",
"tags": [],
"label": "SNProductsConfigValue",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "actions",
"id": "def-common.SNProductsConfigValue.table",
"type": "string",
"tags": [],
"label": "table",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.SNProductsConfigValue.appScope",
"type": "string",
"tags": [],
"label": "appScope",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.SNProductsConfigValue.useImportAPI",
"type": "boolean",
"tags": [],
"label": "useImportAPI",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.SNProductsConfigValue.importSetTable",
"type": "string",
"tags": [],
"label": "importSetTable",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.SNProductsConfigValue.commentFieldKey",
"type": "string",
"tags": [],
"label": "commentFieldKey",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.SNProductsConfigValue.appId",
"type": "string",
"tags": [],
"label": "appId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.ValidatedEmail",
@ -3560,18 +3146,6 @@
}
],
"enums": [
{
"parentPluginId": "actions",
"id": "def-common.AdditionalEmailServices",
"type": "Enum",
"tags": [],
"label": "AdditionalEmailServices",
"description": [],
"path": "x-pack/plugins/actions/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.InvalidEmailReason",
@ -3740,36 +3314,6 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.DEFAULT_ALERTS_GROUPING_KEY",
"type": "string",
"tags": [],
"label": "DEFAULT_ALERTS_GROUPING_KEY",
"description": [],
"signature": [
"\"{{rule.id}}:{{alert.id}}\""
],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.FIELD_PREFIX",
"type": "string",
"tags": [],
"label": "FIELD_PREFIX",
"description": [],
"signature": [
"\"u_\""
],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.INTERNAL_BASE_ACTION_API_PATH",
@ -3888,104 +3432,6 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.ServiceNowITOMActionTypeId",
"type": "string",
"tags": [],
"label": "ServiceNowITOMActionTypeId",
"description": [],
"signature": [
"\".servicenow-itom\""
],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.ServiceNowITSMActionTypeId",
"type": "string",
"tags": [],
"label": "ServiceNowITSMActionTypeId",
"description": [],
"signature": [
"\".servicenow\""
],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.serviceNowITSMTable",
"type": "string",
"tags": [],
"label": "serviceNowITSMTable",
"description": [],
"signature": [
"\"incident\""
],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.ServiceNowSIRActionTypeId",
"type": "string",
"tags": [],
"label": "ServiceNowSIRActionTypeId",
"description": [],
"signature": [
"\".servicenow-sir\""
],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.serviceNowSIRTable",
"type": "string",
"tags": [],
"label": "serviceNowSIRTable",
"description": [],
"signature": [
"\"sn_si_incident\""
],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.SNProductsConfig",
"type": "Type",
"tags": [],
"label": "SNProductsConfig",
"description": [],
"signature": [
"{ [x: string]: ",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.SNProductsConfigValue",
"text": "SNProductsConfigValue"
},
"; }"
],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.UptimeConnectorFeatureId",
@ -4159,255 +3605,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig",
"type": "Object",
"tags": [],
"label": "snExternalServiceConfig",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenow",
"type": "Object",
"tags": [],
"label": "'.servicenow'",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenow.importSetTable",
"type": "string",
"tags": [],
"label": "importSetTable",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenow.appScope",
"type": "string",
"tags": [],
"label": "appScope",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenow.table",
"type": "string",
"tags": [],
"label": "table",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenow.useImportAPI",
"type": "boolean",
"tags": [],
"label": "useImportAPI",
"description": [],
"signature": [
"true"
],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenow.commentFieldKey",
"type": "string",
"tags": [],
"label": "commentFieldKey",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenow.appId",
"type": "string",
"tags": [],
"label": "appId",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenowsir",
"type": "Object",
"tags": [],
"label": "'.servicenow-sir'",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenowsir.importSetTable",
"type": "string",
"tags": [],
"label": "importSetTable",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenowsir.appScope",
"type": "string",
"tags": [],
"label": "appScope",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenowsir.table",
"type": "string",
"tags": [],
"label": "table",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenowsir.useImportAPI",
"type": "boolean",
"tags": [],
"label": "useImportAPI",
"description": [],
"signature": [
"true"
],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenowsir.commentFieldKey",
"type": "string",
"tags": [],
"label": "commentFieldKey",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenowsir.appId",
"type": "string",
"tags": [],
"label": "appId",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenowitom",
"type": "Object",
"tags": [],
"label": "'.servicenow-itom'",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenowitom.importSetTable",
"type": "string",
"tags": [],
"label": "importSetTable",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenowitom.appScope",
"type": "string",
"tags": [],
"label": "appScope",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenowitom.table",
"type": "string",
"tags": [],
"label": "table",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenowitom.useImportAPI",
"type": "boolean",
"tags": [],
"label": "useImportAPI",
"description": [],
"signature": [
"false"
],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "actions",
"id": "def-common.snExternalServiceConfig..servicenowitom.commentFieldKey",
"type": "string",
"tags": [],
"label": "commentFieldKey",
"description": [],
"path": "x-pack/plugins/actions/common/servicenow_config.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "actions",
"id": "def-common.UptimeConnectorFeature",

4
api_docs/actions.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/actions
title: "actions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the actions plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';
@ -21,7 +21,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 273 | 0 | 268 | 19 |
| 214 | 0 | 209 | 19 |
## Client

194
api_docs/advanced_settings.devdocs.json
View file

@ -294,9 +294,201 @@
}
],
"initialIsOpen": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.toEditableConfig",
"type": "Function",
"tags": [],
"label": "toEditableConfig",
"description": [],
"signature": [
"({\n def,\n name,\n value,\n isCustom,\n isOverridden,\n}: { def: ",
"PublicUiSettingsParams",
" & ",
"UserProvidedValues",
"<any>; name: string; value: ",
"SavedObjectAttribute",
"; isCustom: boolean; isOverridden: boolean; }) => ",
"FieldSetting"
],
"path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.toEditableConfig.$1",
"type": "Object",
"tags": [],
"label": "{\n def,\n name,\n value,\n isCustom,\n isOverridden,\n}",
"description": [],
"path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.toEditableConfig.$1.def",
"type": "CompoundType",
"tags": [],
"label": "def",
"description": [],
"signature": [
"PublicUiSettingsParams",
" & ",
"UserProvidedValues",
"<any>"
],
"path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.toEditableConfig.$1.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.toEditableConfig.$1.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"SavedObjectAttributeSingle",
" | ",
"SavedObjectAttributeSingle",
"[]"
],
"path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.toEditableConfig.$1.isCustom",
"type": "boolean",
"tags": [],
"label": "isCustom",
"description": [],
"path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.toEditableConfig.$1.isOverridden",
"type": "boolean",
"tags": [],
"label": "isOverridden",
"description": [],
"path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": [
"the editable config object"
],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.FieldState",
"type": "Interface",
"tags": [],
"label": "FieldState",
"description": [],
"path": "src/plugins/advanced_settings/public/management_app/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "advancedSettings",
"id": "def-public.FieldState.value",
"type": "Any",
"tags": [],
"label": "value",
"description": [],
"signature": [
"any"
],
"path": "src/plugins/advanced_settings/public/management_app/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.FieldState.changeImage",
"type": "CompoundType",
"tags": [],
"label": "changeImage",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/advanced_settings/public/management_app/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.FieldState.loading",
"type": "CompoundType",
"tags": [],
"label": "loading",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/advanced_settings/public/management_app/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.FieldState.isInvalid",
"type": "CompoundType",
"tags": [],
"label": "isInvalid",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/advanced_settings/public/management_app/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "advancedSettings",
"id": "def-public.FieldState.error",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "src/plugins/advanced_settings/public/management_app/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],

7
api_docs/advanced_settings.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/advancedSettings
title: "advancedSettings"
image: https://source.unsplash.com/400x175/?github
description: API docs for the advancedSettings plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
---
import advancedSettingsObj from './advanced_settings.devdocs.json';
@ -21,7 +21,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 23 | 0 | 19 | 1 |
| 36 | 1 | 32 | 2 |
## Client
@ -37,3 +37,6 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
### Classes
<DocDefinitionList data={advancedSettingsObj.client.classes}/>
### Interfaces
<DocDefinitionList data={advancedSettingsObj.client.interfaces}/>

2
api_docs/aiops.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiops
title: "aiops"
image: https://source.unsplash.com/400x175/?github
description: API docs for the aiops plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';

12
api_docs/alerting.devdocs.json
View file

@ -44,7 +44,7 @@
"The rule to view"
],
"signature": [
"{ params: never; tags: string[]; id: string; monitoring?: ",
"{ name: string; params: never; tags: string[]; id: string; monitoring?: ",
{
"pluginId": "alerting",
"scope": "common",
@ -52,7 +52,7 @@
"section": "def-common.RuleMonitoring",
"text": "RuleMonitoring"
},
" | undefined; name: string; enabled: boolean; actions: ",
" | undefined; enabled: boolean; actions: ",
{
"pluginId": "alerting",
"scope": "common",
@ -1819,7 +1819,7 @@
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<never>, \"tags\" | \"name\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
"<never>, \"name\" | \"tags\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
],
"path": "x-pack/plugins/alerting/server/types.ts",
"deprecated": false,
@ -6193,7 +6193,7 @@
"label": "SanitizedRule",
"description": [],
"signature": [
"{ params: Params; tags: string[]; id: string; monitoring?: ",
"{ name: string; params: Params; tags: string[]; id: string; monitoring?: ",
{
"pluginId": "alerting",
"scope": "common",
@ -6201,7 +6201,7 @@
"section": "def-common.RuleMonitoring",
"text": "RuleMonitoring"
},
" | undefined; name: string; enabled: boolean; actions: ",
" | undefined; enabled: boolean; actions: ",
{
"pluginId": "alerting",
"scope": "common",
@ -6264,7 +6264,7 @@
"section": "def-common.SanitizedRule",
"text": "SanitizedRule"
},
"<never>, \"tags\" | \"name\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
"<never>, \"name\" | \"tags\" | \"enabled\" | \"actions\" | \"throttle\" | \"consumer\" | \"schedule\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"notifyWhen\"> & { producer: string; ruleTypeId: string; ruleTypeName: string; }"
],
"path": "x-pack/plugins/alerting/common/rule.ts",
"deprecated": false,

2
api_docs/alerting.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/alerting
title: "alerting"
image: https://source.unsplash.com/400x175/?github
description: API docs for the alerting plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';

30
api_docs/apm.devdocs.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/apm.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apm
title: "apm"
image: https://source.unsplash.com/400x175/?github
description: API docs for the apm plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.devdocs.json';

2
api_docs/banners.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/banners
title: "banners"
image: https://source.unsplash.com/400x175/?github
description: API docs for the banners plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
---
import bannersObj from './banners.devdocs.json';

2
api_docs/bfetch.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/bfetch
title: "bfetch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the bfetch plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
---
import bfetchObj from './bfetch.devdocs.json';

2
api_docs/canvas.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/canvas
title: "canvas"
image: https://source.unsplash.com/400x175/?github
description: API docs for the canvas plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
---
import canvasObj from './canvas.devdocs.json';

2
api_docs/cases.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cases
title: "cases"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cases plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
import casesObj from './cases.devdocs.json';

2
api_docs/charts.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/charts
title: "charts"
image: https://source.unsplash.com/400x175/?github
description: API docs for the charts plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.devdocs.json';

2
api_docs/cloud.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloud
title: "cloud"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloud plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
---
import cloudObj from './cloud.devdocs.json';

2
api_docs/cloud_security_posture.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
title: "cloudSecurityPosture"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudSecurityPosture plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
---
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';

2
api_docs/console.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/console
title: "console"
image: https://source.unsplash.com/400x175/?github
description: API docs for the console plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
---
import consoleObj from './console.devdocs.json';

2
api_docs/controls.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/controls
title: "controls"
image: https://source.unsplash.com/400x175/?github
description: API docs for the controls plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
---
import controlsObj from './controls.devdocs.json';

44
api_docs/core.devdocs.json
View file

@ -15237,11 +15237,11 @@
"\nA sub-set of {@link UiSettingsParams} exposed to the client-side."
],
"signature": [
"{ options?: string[] | number[] | undefined; type?: ",
"{ name?: string | undefined; value?: unknown; description?: string | undefined; category?: string[] | undefined; options?: string[] | number[] | undefined; optionLabels?: Record<string, string> | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; type?: ",
"UiSettingsType",
" | undefined; metric?: { type: string; name: string; } | undefined; value?: unknown; description?: string | undefined; name?: string | undefined; order?: number | undefined; category?: string[] | undefined; optionLabels?: Record<string, string> | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ",
" | undefined; deprecation?: ",
"DeprecationSettings",
" | undefined; }"
" | undefined; order?: number | undefined; metric?: { type: string; name: string; } | undefined; }"
],
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
"deprecated": false,
@ -27010,7 +27010,7 @@
"\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user"
],
"signature": [
"{ get: { <TDocument = unknown>(this: That, params: ",
"{ name: string | symbol; get: { <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
@ -27128,7 +27128,7 @@
"default",
"; security: ",
"default",
"; name: string | symbol; index: { <TDocument = unknown>(this: That, params: ",
"; index: { <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
@ -32152,7 +32152,7 @@
"\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the internal Kibana user."
],
"signature": [
"{ get: { <TDocument = unknown>(this: That, params: ",
"{ name: string | symbol; get: { <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
@ -32270,7 +32270,7 @@
"default",
"; security: ",
"default",
"; name: string | symbol; index: { <TDocument = unknown>(this: That, params: ",
"; index: { <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
@ -33356,7 +33356,7 @@
"\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the user that initiated the request to the Kibana server."
],
"signature": [
"{ get: { <TDocument = unknown>(this: That, params: ",
"{ name: string | symbol; get: { <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
@ -33474,7 +33474,7 @@
"default",
"; security: ",
"default",
"; name: string | symbol; index: { <TDocument = unknown>(this: That, params: ",
"; index: { <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
@ -35381,7 +35381,7 @@
"label": "options",
"description": [],
"signature": [
"Method extends \"get\" | \"options\" ? Required<Omit<",
"Method extends \"options\" | \"get\" ? Required<Omit<",
"RouteConfigOptions",
"<Method>, \"body\">> : Required<",
"RouteConfigOptions",
@ -35839,7 +35839,7 @@
"label": "level",
"description": [],
"signature": [
"\"error\" | \"all\" | \"info\" | \"debug\" | \"off\" | \"trace\" | \"warn\" | \"fatal\""
"\"error\" | \"all\" | \"info\" | \"debug\" | \"off\" | \"warn\" | \"trace\" | \"fatal\""
],
"path": "node_modules/@types/kbn__core-logging-server/index.d.ts",
"deprecated": false,
@ -37894,7 +37894,7 @@
"label": "internalClient",
"description": [],
"signature": [
"{ get: { <TDocument = unknown>(this: That, params: ",
"{ name: string | symbol; get: { <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
@ -38012,7 +38012,7 @@
"default",
"; security: ",
"default",
"; name: string | symbol; index: { <TDocument = unknown>(this: That, params: ",
"; index: { <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
@ -39520,7 +39520,7 @@
"\nAdditional body options {@link RouteConfigOptionsBody}."
],
"signature": [
"(Method extends \"get\" | \"options\" ? undefined : ",
"(Method extends \"options\" | \"get\" ? undefined : ",
"RouteConfigOptionsBody",
") | undefined"
],
@ -39538,7 +39538,7 @@
"\nDefines per-route timeouts."
],
"signature": [
"{ payload?: (Method extends \"get\" | \"options\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined"
"{ payload?: (Method extends \"options\" | \"get\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined"
],
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
"deprecated": false,
@ -49921,7 +49921,7 @@
"\nClient used to query the elasticsearch cluster.\n"
],
"signature": [
"{ get: { <TDocument = unknown>(this: That, params: ",
"{ name: string | symbol; get: { <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
@ -50039,7 +50039,7 @@
"default",
"; security: ",
"default",
"; name: string | symbol; index: { <TDocument = unknown>(this: That, params: ",
"; index: { <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
@ -51623,7 +51623,7 @@
"\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned."
],
"signature": [
"Method extends \"get\" | \"options\" ? Required<Omit<",
"Method extends \"options\" | \"get\" ? Required<Omit<",
"RouteConfigOptions",
"<Method>, \"body\">> : Required<",
"RouteConfigOptions",
@ -52418,11 +52418,11 @@
"\nA sub-set of {@link UiSettingsParams} exposed to the client-side."
],
"signature": [
"{ options?: string[] | number[] | undefined; type?: ",
"{ name?: string | undefined; value?: unknown; description?: string | undefined; category?: string[] | undefined; options?: string[] | number[] | undefined; optionLabels?: Record<string, string> | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; type?: ",
"UiSettingsType",
" | undefined; metric?: { type: string; name: string; } | undefined; value?: unknown; description?: string | undefined; name?: string | undefined; order?: number | undefined; category?: string[] | undefined; optionLabels?: Record<string, string> | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: ",
" | undefined; deprecation?: ",
"DeprecationSettings",
" | undefined; }"
" | undefined; order?: number | undefined; metric?: { type: string; name: string; } | undefined; }"
],
"path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts",
"deprecated": false,
@ -52923,7 +52923,7 @@
"\nSet of HTTP methods not changing the state of the server."
],
"signature": [
"\"get\" | \"options\""
"\"options\" | \"get\""
],
"path": "node_modules/@types/kbn__core-http-server/index.d.ts",
"deprecated": false,

2
api_docs/core.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/core
title: "core"
image: https://source.unsplash.com/400x175/?github
description: API docs for the core plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core']
---
import coreObj from './core.devdocs.json';

2
api_docs/custom_integrations.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/customIntegrations
title: "customIntegrations"
image: https://source.unsplash.com/400x175/?github
description: API docs for the customIntegrations plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
---
import customIntegrationsObj from './custom_integrations.devdocs.json';

2
api_docs/dashboard.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboard
title: "dashboard"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboard plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
---
import dashboardObj from './dashboard.devdocs.json';

2
api_docs/dashboard_enhanced.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced
title: "dashboardEnhanced"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dashboardEnhanced plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
---
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';

8
api_docs/data.devdocs.json
View file

@ -8612,7 +8612,7 @@
"label": "AggConfigOptions",
"description": [],
"signature": [
"{ type: ",
"{ schema?: string | undefined; type: ",
{
"pluginId": "data",
"scope": "common",
@ -8622,7 +8622,7 @@
},
"; params?: {} | ",
"SerializableRecord",
" | undefined; id?: string | undefined; enabled?: boolean | undefined; schema?: string | undefined; }"
" | undefined; id?: string | undefined; enabled?: boolean | undefined; }"
],
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"deprecated": false,
@ -15425,7 +15425,7 @@
"label": "elasticsearchClient",
"description": [],
"signature": [
"{ get: { <TDocument = unknown>(this: That, params: ",
"{ name: string | symbol; get: { <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
@ -15543,7 +15543,7 @@
"default",
"; security: ",
"default",
"; name: string | symbol; index: { <TDocument = unknown>(this: That, params: ",
"; index: { <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",

2
api_docs/data.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data
title: "data"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
---
import dataObj from './data.devdocs.json';

2
api_docs/data_query.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-query
title: "data.query"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.query plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
---
import dataQueryObj from './data_query.devdocs.json';

8
api_docs/data_search.devdocs.json
View file

@ -27979,7 +27979,7 @@
"label": "AggConfigOptions",
"description": [],
"signature": [
"{ type: ",
"{ schema?: string | undefined; type: ",
{
"pluginId": "data",
"scope": "common",
@ -27989,7 +27989,7 @@
},
"; params?: {} | ",
"SerializableRecord",
" | undefined; id?: string | undefined; enabled?: boolean | undefined; schema?: string | undefined; }"
" | undefined; id?: string | undefined; enabled?: boolean | undefined; }"
],
"path": "src/plugins/data/common/search/aggs/agg_config.ts",
"deprecated": false,
@ -28841,7 +28841,7 @@
"label": "CreateAggConfigParams",
"description": [],
"signature": [
"{ type: string | ",
"{ schema?: string | undefined; type: string | ",
{
"pluginId": "data",
"scope": "common",
@ -28851,7 +28851,7 @@
},
"; params?: {} | ",
"SerializableRecord",
" | undefined; id?: string | undefined; enabled?: boolean | undefined; schema?: string | undefined; }"
" | undefined; id?: string | undefined; enabled?: boolean | undefined; }"
],
"path": "src/plugins/data/common/search/aggs/agg_configs.ts",
"deprecated": false,

2
api_docs/data_search.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/data-search
title: "data.search"
image: https://source.unsplash.com/400x175/?github
description: API docs for the data.search plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
---
import dataSearchObj from './data_search.devdocs.json';

2
api_docs/data_view_editor.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewEditor
title: "dataViewEditor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewEditor plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
---
import dataViewEditorObj from './data_view_editor.devdocs.json';

2
api_docs/data_view_field_editor.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor
title: "dataViewFieldEditor"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewFieldEditor plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
---
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';

2
api_docs/data_view_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViewManagement
title: "dataViewManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViewManagement plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
---
import dataViewManagementObj from './data_view_management.devdocs.json';

6
api_docs/data_views.devdocs.json
View file

@ -11480,7 +11480,7 @@
"label": "elasticsearchClient",
"description": [],
"signature": [
"{ get: { <TDocument = unknown>(this: That, params: ",
"{ name: string | symbol; get: { <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
@ -11598,7 +11598,7 @@
"default",
"; security: ",
"default",
"; name: string | symbol; index: { <TDocument = unknown>(this: That, params: ",
"; index: { <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",
@ -20758,7 +20758,7 @@
"label": "DataViewSavedObjectAttrs",
"description": [],
"signature": [
"{ type?: string | undefined; title: string; name?: string | undefined; typeMeta?: string | undefined; }"
"{ name?: string | undefined; type?: string | undefined; title: string; typeMeta?: string | undefined; }"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,

2
api_docs/data_views.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataViews
title: "dataViews"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataViews plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
---
import dataViewsObj from './data_views.devdocs.json';

2
api_docs/data_visualizer.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/dataVisualizer
title: "dataVisualizer"
image: https://source.unsplash.com/400x175/?github
description: API docs for the dataVisualizer plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
---
import dataVisualizerObj from './data_visualizer.devdocs.json';

2
api_docs/deprecations_by_api.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByApi
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
title: Deprecated API usage by API
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

6
api_docs/deprecations_by_plugin.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsByPlugin
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
title: Deprecated API usage by plugin
description: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -633,9 +633,9 @@ This is relied on by the reporting feature, and should be removed once reporting
migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 |
| <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getKibanaFeatures" text="getKibanaFeatures"/> | [app_authorization.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.ts#:~:text=getKibanaFeatures), [privileges.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.ts#:~:text=getKibanaFeatures), [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getKibanaFeatures), [app_authorization.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/app_authorization.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures), [privileges.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/privileges/privileges.test.ts#:~:text=getKibanaFeatures)+ 14 more | 8.8.0 |
| <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getElasticsearchFeatures) | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/plugin.tsx#:~:text=license%24) | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 |
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/plugin.ts#:~:text=license%24) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 |
| <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=onAppLeave) | 8.8.0 |

6
api_docs/deprecations_by_team.mdx
View file

@ -7,7 +7,7 @@ id: kibDevDocsDeprecationsDueByTeam
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
title: Deprecated APIs due to be removed, by team
description: Lists the teams that are referencing deprecated APIs with a remove by date.
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -144,9 +144,9 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
This is relied on by the reporting feature, and should be removed once reporting
migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/issues/19914 |
| security | <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getElasticsearchFeatures" text="getElasticsearchFeatures"/> | [authorization_service.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/server/authorization/authorization_service.tsx#:~:text=getElasticsearchFeatures) | 8.8.0 |
| security | <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 |
| security | <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 |
| security | <DocLink id="kibLicensingPluginApi" section="def-public.LicensingPluginSetup.license$" text="license$"/> | [plugin.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/plugin.tsx#:~:text=license%24) | 8.8.0 |
| security | <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 |
| security | <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode), [license_service.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/common/licensing/license_service.test.ts#:~:text=mode) | 8.8.0 |
| security | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.appBasePath" text="appBasePath"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=appBasePath) | 8.8.0 |
| security | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [logout_app.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/security/public/authentication/logout/logout_app.test.ts#:~:text=onAppLeave) | 8.8.0 |

2
api_docs/dev_tools.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/devTools
title: "devTools"
image: https://source.unsplash.com/400x175/?github
description: API docs for the devTools plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
---
import devToolsObj from './dev_tools.devdocs.json';

15
api_docs/discover.devdocs.json
View file

@ -1873,6 +1873,21 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SHOW_LEGACY_FIELD_TOP_VALUES",
"type": "string",
"tags": [],
"label": "SHOW_LEGACY_FIELD_TOP_VALUES",
"description": [],
"signature": [
"\"discover:showLegacyFieldTopValues\""
],
"path": "src/plugins/discover/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-common.SHOW_MULTIFIELDS",

4
api_docs/discover.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discover
title: "discover"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discover plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
---
import discoverObj from './discover.devdocs.json';
@ -21,7 +21,7 @@ Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-disco
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 95 | 0 | 78 | 4 |
| 96 | 0 | 79 | 4 |
## Client

2
api_docs/discover_enhanced.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced
title: "discoverEnhanced"
image: https://source.unsplash.com/400x175/?github
description: API docs for the discoverEnhanced plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
---
import discoverEnhancedObj from './discover_enhanced.devdocs.json';

2
api_docs/embeddable.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddable
title: "embeddable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddable plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
---
import embeddableObj from './embeddable.devdocs.json';

2
api_docs/embeddable_enhanced.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced
title: "embeddableEnhanced"
image: https://source.unsplash.com/400x175/?github
description: API docs for the embeddableEnhanced plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
---
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';

2
api_docs/encrypted_saved_objects.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects
title: "encryptedSavedObjects"
image: https://source.unsplash.com/400x175/?github
description: API docs for the encryptedSavedObjects plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
---
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';

15
api_docs/enterprise_search.devdocs.json
View file

@ -118,6 +118,21 @@
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "enterpriseSearch",
"id": "def-server.CURRENT_CONNECTORS_INDEX",
"type": "string",
"tags": [],
"label": "CURRENT_CONNECTORS_INDEX",
"description": [],
"signature": [
"\".elastic-connectors-v1\""
],
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [

4
api_docs/enterprise_search.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch
title: "enterpriseSearch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the enterpriseSearch plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
---
import enterpriseSearchObj from './enterprise_search.devdocs.json';
@ -21,7 +21,7 @@ Contact [Enterprise Search](https://github.com/orgs/elastic/teams/enterprise-sea
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 8 | 0 | 8 | 0 |
| 9 | 0 | 9 | 0 |
## Server

2
api_docs/es_ui_shared.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/esUiShared
title: "esUiShared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the esUiShared plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
---
import esUiSharedObj from './es_ui_shared.devdocs.json';

2
api_docs/event_annotation.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
title: "eventAnnotation"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotation plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
---
import eventAnnotationObj from './event_annotation.devdocs.json';

6
api_docs/event_log.devdocs.json
View file

@ -1312,7 +1312,7 @@
"label": "data",
"description": [],
"signature": [
"(Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]"
"(Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; created?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined)[]"
],
"path": "x-pack/plugins/event_log/server/es/cluster_client_adapter.ts",
"deprecated": false,
@ -1332,7 +1332,7 @@
"label": "IEvent",
"description": [],
"signature": [
"DeepPartial<DeepWriteable<Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined"
"DeepPartial<DeepWriteable<Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; created?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}>>> | undefined"
],
"path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false,
@ -1347,7 +1347,7 @@
"label": "IValidatedEvent",
"description": [],
"signature": [
"Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ id?: string | undefined; description?: string | undefined; name?: string | undefined; version?: string | undefined; license?: string | undefined; category?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; created?: string | undefined; category?: string[] | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined"
"Readonly<{ error?: Readonly<{ type?: string | undefined; id?: string | undefined; message?: string | undefined; code?: string | undefined; stack_trace?: string | undefined; } & {}> | undefined; tags?: string[] | undefined; log?: Readonly<{ logger?: string | undefined; level?: string | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; message?: string | undefined; kibana?: Readonly<{ alert?: Readonly<{ rule?: Readonly<{ consumer?: string | undefined; execution?: Readonly<{ status?: string | undefined; metrics?: Readonly<{ number_of_triggered_actions?: string | number | undefined; number_of_generated_actions?: string | number | undefined; alert_counts?: Readonly<{ recovered?: string | number | undefined; active?: string | number | undefined; new?: string | number | undefined; } & {}> | undefined; number_of_searches?: string | number | undefined; total_indexing_duration_ms?: string | number | undefined; es_search_duration_ms?: string | number | undefined; total_search_duration_ms?: string | number | undefined; execution_gap_duration_s?: string | number | undefined; rule_type_run_duration_ms?: string | number | undefined; process_alerts_duration_ms?: string | number | undefined; trigger_actions_duration_ms?: string | number | undefined; process_rule_duration_ms?: string | number | undefined; claim_to_start_duration_ms?: string | number | undefined; prepare_rule_duration_ms?: string | number | undefined; total_run_duration_ms?: string | number | undefined; } & {}> | undefined; uuid?: string | undefined; status_order?: string | number | undefined; } & {}> | undefined; rule_type_id?: string | undefined; } & {}> | undefined; } & {}> | undefined; version?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; server_uuid?: string | undefined; task?: Readonly<{ id?: string | undefined; schedule_delay?: string | number | undefined; scheduled?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; namespace?: string | undefined; rel?: string | undefined; type_id?: string | undefined; } & {}>[] | undefined; space_ids?: string[] | undefined; } & {}> | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; rule?: Readonly<{ name?: string | undefined; description?: string | undefined; category?: string | undefined; id?: string | undefined; version?: string | undefined; license?: string | undefined; reference?: string | undefined; author?: string[] | undefined; ruleset?: string | undefined; uuid?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; category?: string[] | undefined; type?: string[] | undefined; id?: string | undefined; outcome?: string | undefined; created?: string | undefined; end?: string | undefined; original?: string | undefined; duration?: string | number | undefined; code?: string | undefined; url?: string | undefined; action?: string | undefined; kind?: string | undefined; hash?: string | undefined; severity?: string | number | undefined; dataset?: string | undefined; ingested?: string | undefined; module?: string | undefined; provider?: string | undefined; reason?: string | undefined; reference?: string | undefined; risk_score?: number | undefined; risk_score_norm?: number | undefined; sequence?: string | number | undefined; timezone?: string | undefined; } & {}> | undefined; '@timestamp'?: string | undefined; } & {}> | undefined"
],
"path": "x-pack/plugins/event_log/generated/schemas.ts",
"deprecated": false,

2
api_docs/event_log.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventLog
title: "eventLog"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventLog plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
---
import eventLogObj from './event_log.devdocs.json';

2
api_docs/expression_error.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionError
title: "expressionError"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionError plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
---
import expressionErrorObj from './expression_error.devdocs.json';

2
api_docs/expression_gauge.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionGauge
title: "expressionGauge"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionGauge plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
---
import expressionGaugeObj from './expression_gauge.devdocs.json';

2
api_docs/expression_heatmap.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap
title: "expressionHeatmap"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionHeatmap plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
---
import expressionHeatmapObj from './expression_heatmap.devdocs.json';

2
api_docs/expression_image.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionImage
title: "expressionImage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionImage plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
---
import expressionImageObj from './expression_image.devdocs.json';

2
api_docs/expression_legacy_metric_vis.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis
title: "expressionLegacyMetricVis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionLegacyMetricVis plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
---
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';

2
api_docs/expression_metric.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetric
title: "expressionMetric"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetric plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
---
import expressionMetricObj from './expression_metric.devdocs.json';

2
api_docs/expression_metric_vis.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis
title: "expressionMetricVis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionMetricVis plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
---
import expressionMetricVisObj from './expression_metric_vis.devdocs.json';

2
api_docs/expression_partition_vis.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis
title: "expressionPartitionVis"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionPartitionVis plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
---
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';

2
api_docs/expression_repeat_image.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage
title: "expressionRepeatImage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRepeatImage plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
---
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';

2
api_docs/expression_reveal_image.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage
title: "expressionRevealImage"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionRevealImage plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
---
import expressionRevealImageObj from './expression_reveal_image.devdocs.json';

2
api_docs/expression_shape.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionShape
title: "expressionShape"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionShape plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
---
import expressionShapeObj from './expression_shape.devdocs.json';

2
api_docs/expression_tagcloud.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud
title: "expressionTagcloud"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionTagcloud plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
---
import expressionTagcloudObj from './expression_tagcloud.devdocs.json';

2
api_docs/expression_x_y.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressionXY
title: "expressionXY"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressionXY plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
---
import expressionXYObj from './expression_x_y.devdocs.json';

2
api_docs/expressions.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/expressions
title: "expressions"
image: https://source.unsplash.com/400x175/?github
description: API docs for the expressions plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
---
import expressionsObj from './expressions.devdocs.json';

2
api_docs/features.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/features
title: "features"
image: https://source.unsplash.com/400x175/?github
description: API docs for the features plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
---
import featuresObj from './features.devdocs.json';

2
api_docs/field_formats.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fieldFormats
title: "fieldFormats"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fieldFormats plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
---
import fieldFormatsObj from './field_formats.devdocs.json';

2
api_docs/file_upload.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fileUpload
title: "fileUpload"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fileUpload plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
---
import fileUploadObj from './file_upload.devdocs.json';

4
api_docs/files.devdocs.json
View file

@ -972,7 +972,7 @@
"\nAn elasticsearch client that will be used to interact with the cluster"
],
"signature": [
"{ get: { <TDocument = unknown>(this: That, params: ",
"{ name: string | symbol; get: { <TDocument = unknown>(this: That, params: ",
"GetRequest",
" | ",
"GetRequest",
@ -1090,7 +1090,7 @@
"default",
"; security: ",
"default",
"; name: string | symbol; index: { <TDocument = unknown>(this: That, params: ",
"; index: { <TDocument = unknown>(this: That, params: ",
"IndexRequest",
"<TDocument> | ",
"IndexRequest",

2
api_docs/files.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/files
title: "files"
image: https://source.unsplash.com/400x175/?github
description: API docs for the files plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
---
import filesObj from './files.devdocs.json';

199
api_docs/fleet.devdocs.json
View file

@ -12178,12 +12178,12 @@
{
"parentPluginId": "fleet",
"id": "def-common.PackageSpecManifest.type",
"type": "string",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"integration\" | undefined"
"\"input\" | \"integration\" | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/package_spec.ts",
"deprecated": false,
@ -12939,180 +12939,6 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.RegistryPolicyTemplate",
"type": "Interface",
"tags": [],
"label": "RegistryPolicyTemplate",
"description": [],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.name",
"type": "string",
"tags": [],
"label": "[RegistryPolicyTemplateKeys.name]",
"description": [],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.title",
"type": "string",
"tags": [],
"label": "[RegistryPolicyTemplateKeys.title]",
"description": [],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.description",
"type": "string",
"tags": [],
"label": "[RegistryPolicyTemplateKeys.description]",
"description": [],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.icons",
"type": "Array",
"tags": [],
"label": "[RegistryPolicyTemplateKeys.icons]",
"description": [],
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryImage",
"text": "RegistryImage"
},
"[] | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.screenshots",
"type": "Array",
"tags": [],
"label": "[RegistryPolicyTemplateKeys.screenshots]",
"description": [],
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryImage",
"text": "RegistryImage"
},
"[] | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.categories",
"type": "Array",
"tags": [],
"label": "[RegistryPolicyTemplateKeys.categories]",
"description": [],
"signature": [
"(",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackageSpecCategory",
"text": "PackageSpecCategory"
},
" | undefined)[] | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.data_streams",
"type": "Array",
"tags": [],
"label": "[RegistryPolicyTemplateKeys.data_streams]",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.inputs",
"type": "Array",
"tags": [],
"label": "[RegistryPolicyTemplateKeys.inputs]",
"description": [],
"signature": [
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.RegistryInput",
"text": "RegistryInput"
},
"[] | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.readme",
"type": "string",
"tags": [],
"label": "[RegistryPolicyTemplateKeys.readme]",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.multiple",
"type": "CompoundType",
"tags": [],
"label": "[RegistryPolicyTemplateKeys.multiple]",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.RegistryStream",
@ -15021,6 +14847,23 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.RegistryPolicyTemplate",
"type": "Type",
"tags": [],
"label": "RegistryPolicyTemplate",
"description": [],
"signature": [
"RegistryPolicyIntegrationTemplate",
" | ",
"RegistryPolicyInputOnlyTemplate"
],
"path": "x-pack/plugins/fleet/common/types/models/epm.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.RegistrySearchResult",
@ -15029,7 +14872,7 @@
"label": "RegistrySearchResult",
"description": [],
"signature": [
"{ type?: \"integration\" | undefined; path: string; download: string; title: string; description: string; icons?: (",
"{ name: string; description: string; type?: \"input\" | \"integration\" | undefined; path: string; download: string; title: string; icons?: (",
{
"pluginId": "fleet",
"scope": "common",
@ -15053,7 +14896,7 @@
"section": "def-common.PackageSpecCategory",
"text": "PackageSpecCategory"
},
" | undefined)[] | undefined; name: string; version: string; internal?: boolean | undefined; release?: \"experimental\" | \"beta\" | \"ga\" | undefined; policy_templates?: ",
" | undefined)[] | undefined; version: string; internal?: boolean | undefined; release?: \"experimental\" | \"beta\" | \"ga\" | undefined; policy_templates?: ",
{
"pluginId": "fleet",
"scope": "common",

4
api_docs/fleet.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/fleet
title: "fleet"
image: https://source.unsplash.com/400x175/?github
description: API docs for the fleet plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
---
import fleetObj from './fleet.devdocs.json';
@ -21,7 +21,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 979 | 3 | 880 | 15 |
| 969 | 3 | 870 | 17 |
## Client

2
api_docs/global_search.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/globalSearch
title: "globalSearch"
image: https://source.unsplash.com/400x175/?github
description: API docs for the globalSearch plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
---
import globalSearchObj from './global_search.devdocs.json';

208
api_docs/guided_onboarding.devdocs.json Normal file
View file

@ -0,0 +1,208 @@
{
"id": "guidedOnboarding",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "guidedOnboarding",
"id": "def-public.GuidedOnboardingState",
"type": "Interface",
"tags": [],
"label": "GuidedOnboardingState",
"description": [],
"path": "src/plugins/guided_onboarding/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "guidedOnboarding",
"id": "def-public.GuidedOnboardingState.activeGuide",
"type": "CompoundType",
"tags": [],
"label": "activeGuide",
"description": [],
"signature": [
{
"pluginId": "guidedOnboarding",
"scope": "public",
"docId": "kibGuidedOnboardingPluginApi",
"section": "def-public.UseCase",
"text": "UseCase"
},
" | \"unset\""
],
"path": "src/plugins/guided_onboarding/public/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "guidedOnboarding",
"id": "def-public.GuidedOnboardingState.activeStep",
"type": "string",
"tags": [],
"label": "activeStep",
"description": [],
"path": "src/plugins/guided_onboarding/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "guidedOnboarding",
"id": "def-public.UseCase",
"type": "Type",
"tags": [],
"label": "UseCase",
"description": [],
"signature": [
"\"search\" | \"security\" | \"observability\""
],
"path": "src/plugins/guided_onboarding/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "guidedOnboarding",
"id": "def-public.GuidedOnboardingPluginSetup",
"type": "Interface",
"tags": [],
"label": "GuidedOnboardingPluginSetup",
"description": [],
"path": "src/plugins/guided_onboarding/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "guidedOnboarding",
"id": "def-public.GuidedOnboardingPluginStart",
"type": "Interface",
"tags": [],
"label": "GuidedOnboardingPluginStart",
"description": [],
"path": "src/plugins/guided_onboarding/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "guidedOnboarding",
"id": "def-public.GuidedOnboardingPluginStart.guidedOnboardingApi",
"type": "Object",
"tags": [],
"label": "guidedOnboardingApi",
"description": [],
"signature": [
"ApiService",
" | undefined"
],
"path": "src/plugins/guided_onboarding/public/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "guidedOnboarding",
"id": "def-server.GuidedOnboardingPluginSetup",
"type": "Interface",
"tags": [],
"label": "GuidedOnboardingPluginSetup",
"description": [],
"path": "src/plugins/guided_onboarding/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "guidedOnboarding",
"id": "def-server.GuidedOnboardingPluginStart",
"type": "Interface",
"tags": [],
"label": "GuidedOnboardingPluginStart",
"description": [],
"path": "src/plugins/guided_onboarding/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "guidedOnboarding",
"id": "def-common.API_BASE_PATH",
"type": "string",
"tags": [],
"label": "API_BASE_PATH",
"description": [],
"signature": [
"\"/api/guided_onboarding\""
],
"path": "src/plugins/guided_onboarding/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "guidedOnboarding",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"guidedOnboarding\""
],
"path": "src/plugins/guided_onboarding/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "guidedOnboarding",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"guidedOnboarding\""
],
"path": "src/plugins/guided_onboarding/common/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}

52
api_docs/guided_onboarding.mdx Normal file
View file

@ -0,0 +1,52 @@
---
####
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
#### Reach out in #docs-engineering for more info.
####
id: kibGuidedOnboardingPluginApi
slug: /kibana-dev-docs/api/guidedOnboarding
title: "guidedOnboarding"
image: https://source.unsplash.com/400x175/?github
description: API docs for the guidedOnboarding plugin
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
---
import guidedOnboardingObj from './guided_onboarding.devdocs.json';
Guided onboarding framework
Contact [Journey Onboarding](https://github.com/orgs/elastic/teams/platform-onboarding) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 12 | 0 | 12 | 1 |
## Client
### Setup
<DocDefinitionList data={[guidedOnboardingObj.client.setup]}/>
### Start
<DocDefinitionList data={[guidedOnboardingObj.client.start]}/>
### Interfaces
<DocDefinitionList data={guidedOnboardingObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={guidedOnboardingObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[guidedOnboardingObj.server.setup]}/>
### Start
<DocDefinitionList data={[guidedOnboardingObj.server.start]}/>
## Common
### Consts, variables and types
<DocDefinitionList data={guidedOnboardingObj.common.misc}/>

10
api_docs/home.devdocs.json
View file

@ -1738,7 +1738,7 @@
"signature": [
"{ getSampleDatasets: () => ",
"Writable",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { name: string; description: string; id: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"SavedObject",
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ",
{
@ -1773,7 +1773,7 @@
"signature": [
"() => ",
"Writable",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>"
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { name: string; description: string; id: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>"
],
"path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts",
"deprecated": false,
@ -1830,7 +1830,7 @@
"section": "def-server.TutorialContext",
"text": "TutorialContext"
},
") => Readonly<{ isBeta?: boolean | undefined; savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { id: string; name: string; category: \"other\" | \"security\" | \"metrics\" | \"logging\"; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
") => Readonly<{ isBeta?: boolean | undefined; savedObjects?: any[] | undefined; euiIconType?: string | undefined; previewImagePath?: string | undefined; moduleName?: string | undefined; completionTimeMinutes?: number | undefined; elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; savedObjectsInstallMsg?: string | undefined; customStatusCheckName?: string | undefined; integrationBrowserCategories?: string[] | undefined; eprPackageOverlap?: string | undefined; } & { name: string; category: \"other\" | \"security\" | \"metrics\" | \"logging\"; id: string; shortDescription: string; longDescription: string; onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }>"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
"deprecated": false,
@ -1868,7 +1868,7 @@
"label": "TutorialSchema",
"description": [],
"signature": [
"{ readonly isBeta?: boolean | undefined; readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly id: string; readonly name: string; readonly category: \"other\" | \"security\" | \"metrics\" | \"logging\"; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }"
"{ readonly isBeta?: boolean | undefined; readonly savedObjects?: any[] | undefined; readonly euiIconType?: string | undefined; readonly previewImagePath?: string | undefined; readonly moduleName?: string | undefined; readonly completionTimeMinutes?: number | undefined; readonly elasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly onPremElasticCloud?: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }> | undefined; readonly artifacts?: Readonly<{ application?: Readonly<{} & { path: string; label: string; }> | undefined; exportedFields?: Readonly<{} & { documentationUrl: string; }> | undefined; } & { dashboards: Readonly<{ linkLabel?: string | undefined; } & { id: string; isOverview: boolean; }>[]; }> | undefined; readonly savedObjectsInstallMsg?: string | undefined; readonly customStatusCheckName?: string | undefined; readonly integrationBrowserCategories?: string[] | undefined; readonly eprPackageOverlap?: string | undefined; readonly name: string; readonly category: \"other\" | \"security\" | \"metrics\" | \"logging\"; readonly id: string; readonly shortDescription: string; readonly longDescription: string; readonly onPrem: Readonly<{ params?: Readonly<{ defaultValue?: any; } & { type: \"string\" | \"number\"; id: string; label: string; }>[] | undefined; } & { instructionSets: Readonly<{ title?: string | undefined; callOut?: Readonly<{ message?: string | undefined; iconType?: string | undefined; } & { title: string; }> | undefined; statusCheck?: Readonly<{ error?: string | undefined; success?: string | undefined; text?: string | undefined; title?: string | undefined; btnLabel?: string | undefined; } & { esHitsCheck: Readonly<{} & { query: Record<string, any>; index: string | string[]; }>; }> | undefined; } & { instructionVariants: Readonly<{ initialSelected?: boolean | undefined; } & { id: string; instructions: Readonly<{ title?: string | undefined; commands?: string[] | undefined; textPre?: string | undefined; textPost?: string | undefined; customComponentName?: string | undefined; } & {}>[]; }>[]; }>[]; }>; }"
],
"path": "src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts",
"deprecated": false,
@ -2160,7 +2160,7 @@
"signature": [
"{ getSampleDatasets: () => ",
"Writable",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; description: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { name: string; description: string; id: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"SavedObject",
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ",
{

2
api_docs/home.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/home
title: "home"
image: https://source.unsplash.com/400x175/?github
description: API docs for the home plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
---
import homeObj from './home.devdocs.json';

2
api_docs/index_lifecycle_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement
title: "indexLifecycleManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexLifecycleManagement plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
---
import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json';

2
api_docs/index_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/indexManagement
title: "indexManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the indexManagement plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
---
import indexManagementObj from './index_management.devdocs.json';

2
api_docs/infra.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/infra
title: "infra"
image: https://source.unsplash.com/400x175/?github
description: API docs for the infra plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
---
import infraObj from './infra.devdocs.json';

2
api_docs/inspector.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/inspector
title: "inspector"
image: https://source.unsplash.com/400x175/?github
description: API docs for the inspector plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
---
import inspectorObj from './inspector.devdocs.json';

2
api_docs/interactive_setup.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/interactiveSetup
title: "interactiveSetup"
image: https://source.unsplash.com/400x175/?github
description: API docs for the interactiveSetup plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
---
import interactiveSetupObj from './interactive_setup.devdocs.json';

2
api_docs/kbn_ace.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ace
title: "@kbn/ace"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ace plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
---
import kbnAceObj from './kbn_ace.devdocs.json';

2
api_docs/kbn_aiops_components.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-components
title: "@kbn/aiops-components"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-components plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components']
---
import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json';

34
api_docs/kbn_aiops_utils.devdocs.json
View file

@ -190,7 +190,7 @@
"Headers",
", logger: ",
"Logger",
") => StreamFactoryReturnType<T>"
", flushFix: boolean | undefined) => StreamFactoryReturnType<T>"
],
"path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts",
"deprecated": false,
@ -227,6 +227,21 @@
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.streamFactory.$3",
"type": "CompoundType",
"tags": [],
"label": "flushFix",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [
@ -248,7 +263,7 @@
"Headers",
", logger: ",
"Logger",
") => StreamFactoryReturnType<T>"
", flushFix: boolean) => StreamFactoryReturnType<T>"
],
"path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts",
"deprecated": false,
@ -285,6 +300,21 @@
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/aiops-utils",
"id": "def-common.streamFactory.$3",
"type": "boolean",
"tags": [],
"label": "flushFix",
"description": [],
"signature": [
"boolean"
],
"path": "x-pack/packages/ml/aiops_utils/src/stream_factory.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [

4
api_docs/kbn_aiops_utils.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils
title: "@kbn/aiops-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/aiops-utils plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils']
---
import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json';
@ -21,7 +21,7 @@ Contact Machine Learning UI for questions regarding this plugin.
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 49 | 0 | 24 | 0 |
| 51 | 0 | 26 | 0 |
## Common

2
api_docs/kbn_alerts.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts
title: "@kbn/alerts"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts']
---
import kbnAlertsObj from './kbn_alerts.devdocs.json';

2
api_docs/kbn_analytics.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics
title: "@kbn/analytics"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics']
---
import kbnAnalyticsObj from './kbn_analytics.devdocs.json';

2
api_docs/kbn_analytics_client.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client
title: "@kbn/analytics-client"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-client plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client']
---
import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json';

2
api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-browser
title: "@kbn/analytics-shippers-elastic-v3-browser"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser']
---
import kbnAnalyticsShippersElasticV3BrowserObj from './kbn_analytics_shippers_elastic_v3_browser.devdocs.json';

2
api_docs/kbn_analytics_shippers_elastic_v3_common.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-common
title: "@kbn/analytics-shippers-elastic-v3-common"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common']
---
import kbnAnalyticsShippersElasticV3CommonObj from './kbn_analytics_shippers_elastic_v3_common.devdocs.json';

2
api_docs/kbn_analytics_shippers_elastic_v3_server.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-elastic-v3-server
title: "@kbn/analytics-shippers-elastic-v3-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server']
---
import kbnAnalyticsShippersElasticV3ServerObj from './kbn_analytics_shippers_elastic_v3_server.devdocs.json';

2
api_docs/kbn_analytics_shippers_fullstory.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory
title: "@kbn/analytics-shippers-fullstory"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-fullstory plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory']
---
import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json';

2
api_docs/kbn_apm_config_loader.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader
title: "@kbn/apm-config-loader"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-config-loader plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader']
---
import kbnApmConfigLoaderObj from './kbn_apm_config_loader.devdocs.json';

38
api_docs/kbn_apm_synthtrace.devdocs.json
View file

@ -1024,7 +1024,7 @@
},
"[]; 'error.grouping_name': string; 'error.grouping_key': string; 'host.name': string; 'host.hostname': string; 'kubernetes.pod.uid': string; 'kubernetes.pod.name': string; 'metricset.name': string; observer: ",
"Observer",
"; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.version': string; 'service.environment': string; 'service.node.name': string; 'service.runtime.name': string; 'service.runtime.version': string; 'service.framework.name': string; 'service.target.name': string; 'service.target.type': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; 'span.self_time.count': number; 'span.self_time.sum.us': number; 'span.links': { trace: { id: string; }; span: { id: string; }; }[]; 'cloud.provider': string; 'cloud.project.name': string; 'cloud.service.name': string; 'cloud.availability_zone': string; 'cloud.machine.type': string; 'cloud.region': string; 'host.os.platform': string; 'faas.id': string; 'faas.coldstart': boolean; 'faas.execution': string; 'faas.trigger.type': string; 'faas.trigger.request_id': string; }> & Partial<{ 'system.process.memory.size': number; 'system.memory.actual.free': number; 'system.memory.total': number; 'system.cpu.total.norm.pct': number; 'system.process.memory.rss.bytes': number; 'system.process.cpu.total.norm.pct': number; 'jvm.memory.heap.used': number; 'jvm.memory.non_heap.used': number; 'jvm.thread.count': number; }>"
"; 'parent.id': string; 'processor.event': string; 'processor.name': string; 'trace.id': string; 'transaction.name': string; 'transaction.type': string; 'transaction.id': string; 'transaction.duration.us': number; 'transaction.duration.histogram': { values: number[]; counts: number[]; }; 'transaction.sampled': true; 'service.name': string; 'service.version': string; 'service.environment': string; 'service.node.name': string; 'service.runtime.name': string; 'service.runtime.version': string; 'service.framework.name': string; 'service.target.name': string; 'service.target.type': string; 'span.id': string; 'span.name': string; 'span.type': string; 'span.subtype': string; 'span.duration.us': number; 'span.destination.service.name': string; 'span.destination.service.resource': string; 'span.destination.service.type': string; 'span.destination.service.response_time.sum.us': number; 'span.destination.service.response_time.count': number; 'span.self_time.count': number; 'span.self_time.sum.us': number; 'span.links': { trace: { id: string; }; span: { id: string; }; }[]; 'cloud.provider': string; 'cloud.project.name': string; 'cloud.service.name': string; 'cloud.availability_zone': string; 'cloud.machine.type': string; 'cloud.region': string; 'host.os.platform': string; 'faas.id': string; 'faas.name': string; 'faas.coldstart': boolean; 'faas.execution': string; 'faas.trigger.type': string; 'faas.trigger.request_id': string; }> & Partial<{ 'system.process.memory.size': number; 'system.memory.actual.free': number; 'system.memory.total': number; 'system.cpu.total.norm.pct': number; 'system.process.memory.rss.bytes': number; 'system.process.cpu.total.norm.pct': number; 'jvm.memory.heap.used': number; 'jvm.memory.non_heap.used': number; 'jvm.thread.count': number; 'faas.billed_duration': number; 'faas.timeout': number; 'faas.coldstart_duration': number; 'faas.duration': number; }>"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/apm_fields.ts",
"deprecated": false,
@ -1134,7 +1134,7 @@
},
"[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.name'?: string | undefined; 'host.hostname'?: string | undefined; 'kubernetes.pod.uid'?: string | undefined; 'kubernetes.pod.name'?: string | undefined; observer?: ",
"Observer",
" | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'service.target.name'?: string | undefined; 'service.target.type'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.destination.service.response_time.sum.us'?: number | undefined; 'span.destination.service.response_time.count'?: number | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; }[]"
" | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'service.target.name'?: string | undefined; 'service.target.type'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.destination.service.response_time.sum.us'?: number | undefined; 'span.destination.service.response_time.count'?: number | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.name'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; 'faas.billed_duration'?: number | undefined; 'faas.timeout'?: number | undefined; 'faas.coldstart_duration'?: number | undefined; 'faas.duration'?: number | undefined; }[]"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts",
"deprecated": false,
@ -1190,7 +1190,7 @@
},
"[] | undefined; 'error.grouping_name'?: string | undefined; 'error.grouping_key'?: string | undefined; 'host.name'?: string | undefined; 'host.hostname'?: string | undefined; 'kubernetes.pod.uid'?: string | undefined; 'kubernetes.pod.name'?: string | undefined; observer?: ",
"Observer",
" | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.duration.histogram'?: { values: number[]; counts: number[]; } | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'service.target.name'?: string | undefined; 'service.target.type'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; }[]"
" | undefined; 'parent.id'?: string | undefined; 'processor.event'?: string | undefined; 'processor.name'?: string | undefined; 'trace.id'?: string | undefined; 'transaction.name'?: string | undefined; 'transaction.type'?: string | undefined; 'transaction.id'?: string | undefined; 'transaction.duration.us'?: number | undefined; 'transaction.duration.histogram'?: { values: number[]; counts: number[]; } | undefined; 'transaction.sampled'?: true | undefined; 'service.name'?: string | undefined; 'service.version'?: string | undefined; 'service.environment'?: string | undefined; 'service.node.name'?: string | undefined; 'service.runtime.name'?: string | undefined; 'service.runtime.version'?: string | undefined; 'service.framework.name'?: string | undefined; 'service.target.name'?: string | undefined; 'service.target.type'?: string | undefined; 'span.id'?: string | undefined; 'span.name'?: string | undefined; 'span.type'?: string | undefined; 'span.subtype'?: string | undefined; 'span.duration.us'?: number | undefined; 'span.destination.service.name'?: string | undefined; 'span.destination.service.resource'?: string | undefined; 'span.destination.service.type'?: string | undefined; 'span.self_time.count'?: number | undefined; 'span.self_time.sum.us'?: number | undefined; 'span.links'?: { trace: { id: string; }; span: { id: string; }; }[] | undefined; 'cloud.provider'?: string | undefined; 'cloud.project.name'?: string | undefined; 'cloud.service.name'?: string | undefined; 'cloud.availability_zone'?: string | undefined; 'cloud.machine.type'?: string | undefined; 'cloud.region'?: string | undefined; 'host.os.platform'?: string | undefined; 'faas.id'?: string | undefined; 'faas.name'?: string | undefined; 'faas.coldstart'?: boolean | undefined; 'faas.execution'?: string | undefined; 'faas.trigger.type'?: string | undefined; 'faas.trigger.request_id'?: string | undefined; 'system.process.memory.size'?: number | undefined; 'system.memory.actual.free'?: number | undefined; 'system.memory.total'?: number | undefined; 'system.cpu.total.norm.pct'?: number | undefined; 'system.process.memory.rss.bytes'?: number | undefined; 'system.process.cpu.total.norm.pct'?: number | undefined; 'jvm.memory.heap.used'?: number | undefined; 'jvm.memory.non_heap.used'?: number | undefined; 'jvm.thread.count'?: number | undefined; 'faas.billed_duration'?: number | undefined; 'faas.timeout'?: number | undefined; 'faas.coldstart_duration'?: number | undefined; 'faas.duration'?: number | undefined; }[]"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts",
"deprecated": false,
@ -1362,6 +1362,38 @@
"path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.apm.serverlessFunction",
"type": "Function",
"tags": [],
"label": "serverlessFunction",
"description": [],
"signature": [
"({ functionName, serviceName, environment, agentName, }: { functionName: string; environment: string; agentName: string; serviceName?: string | undefined; }) => ",
"ServerlessFunction"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/index.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/apm-synthtrace",
"id": "def-server.apm.serverlessFunction.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ functionName: string; environment: string; agentName: string; serviceName?: string | undefined; }"
],
"path": "packages/kbn-apm-synthtrace/src/lib/apm/serverless_function.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false

4
api_docs/kbn_apm_synthtrace.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace
title: "@kbn/apm-synthtrace"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-synthtrace plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace']
---
import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json';
@ -21,7 +21,7 @@ Contact [Owner missing] for questions regarding this plugin.
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 72 | 0 | 72 | 12 |
| 74 | 0 | 74 | 13 |
## Server

2
api_docs/kbn_apm_utils.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils
title: "@kbn/apm-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-utils plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils']
---
import kbnApmUtilsObj from './kbn_apm_utils.devdocs.json';

2
api_docs/kbn_axe_config.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config
title: "@kbn/axe-config"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/axe-config plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config']
---
import kbnAxeConfigObj from './kbn_axe_config.devdocs.json';

2
api_docs/kbn_chart_icons.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-chart-icons
title: "@kbn/chart-icons"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/chart-icons plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/chart-icons']
---
import kbnChartIconsObj from './kbn_chart_icons.devdocs.json';

2
api_docs/kbn_ci_stats_core.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core
title: "@kbn/ci-stats-core"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ci-stats-core plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-core']
---
import kbnCiStatsCoreObj from './kbn_ci_stats_core.devdocs.json';

2
api_docs/kbn_ci_stats_performance_metrics.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-performance-metrics
title: "@kbn/ci-stats-performance-metrics"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/ci-stats-performance-metrics plugin
date: 2022-09-15
date: 2022-09-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-performance-metrics']
---
import kbnCiStatsPerformanceMetricsObj from './kbn_ci_stats_performance_metrics.devdocs.json';

Some files were not shown because too many files have changed in this diff Show more