github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[api-docs] 2023-09-07 Daily api_docs build (#165925)

Browse source 
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/453
This commit is contained in:
Kibana Machine 2023-09-07 00:59:36 -04:00 • committed by GitHub
parent 962a027040
commit b46b356a90
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
587 changed files with 25940 additions and 955 deletions
Download patch file Download diff file Expand all files Collapse all files

2
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';

2
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
---
import advancedSettingsObj from './advanced_settings.devdocs.json';

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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';

56
api_docs/alerting.devdocs.json
View file

@ -3348,10 +3348,6 @@
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/server/rule_types/index_threshold/rule_type.ts"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/server/rule_types/index_threshold/rule_type.ts"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/server/rule_types/geo_containment/lib/get_entities_and_generate_alerts.ts"
@ -4354,7 +4350,7 @@
"label": "AlertingRulesConfig",
"description": [],
"signature": [
"Pick<Readonly<{} & { minimumScheduleInterval: Readonly<{} & { value: string; enforce: boolean; }>; run: Readonly<{ timeout?: string | undefined; ruleTypeOverrides?: Readonly<{ timeout?: string | undefined; } & { id: string; }>[] | undefined; } & { actions: Readonly<{ connectorTypeOverrides?: Readonly<{ max?: number | undefined; } & { id: string; }>[] | undefined; } & { max: number; }>; alerts: Readonly<{} & { max: number; }>; }>; }>, \"minimumScheduleInterval\"> & { isUsingSecurity: boolean; }"
"Pick<Readonly<{} & { minimumScheduleInterval: Readonly<{} & { value: string; enforce: boolean; }>; maxScheduledPerMinute: number; run: Readonly<{ timeout?: string | undefined; ruleTypeOverrides?: Readonly<{ timeout?: string | undefined; } & { id: string; }>[] | undefined; } & { actions: Readonly<{ connectorTypeOverrides?: Readonly<{ max?: number | undefined; } & { id: string; }>[] | undefined; } & { max: number; }>; alerts: Readonly<{} & { max: number; }>; }>; }>, \"minimumScheduleInterval\" | \"maxScheduledPerMinute\"> & { isUsingSecurity: boolean; }"
],
"path": "x-pack/plugins/alerting/server/config.ts",
"deprecated": false,
@ -4891,7 +4887,7 @@
},
" | undefined; getTags: (params: Readonly<{ search?: string | undefined; perPage?: number | undefined; } & { page: number; }>) => Promise<",
"GetTagsResult",
">; getAlertFromRaw: (params: ",
">; getScheduleFrequency: () => Promise<Readonly<{} & { totalScheduledPerMinute: number; remainingSchedulesPerMinute: number; }>>; getAlertFromRaw: (params: ",
"GetAlertFromRawParams",
") => ",
{
@ -5107,6 +5103,54 @@
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.convertDurationToFrequency",
"type": "Function",
"tags": [],
"label": "convertDurationToFrequency",
"description": [],
"signature": [
"(duration: string, denomination: number) => number"
],
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-common.convertDurationToFrequency.$1",
"type": "string",
"tags": [],
"label": "duration",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "alerting",
"id": "def-common.convertDurationToFrequency.$2",
"type": "number",
"tags": [],
"label": "denomination",
"description": [],
"signature": [
"number"
],
"path": "x-pack/plugins/alerting/common/parse_duration.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-common.formatDefaultAggregationResult",

4
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 790 | 1 | 759 | 49 |
| 793 | 1 | 762 | 49 |
## Client

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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.devdocs.json';

2
api_docs/apm_data_access.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/apmDataAccess
title: "apmDataAccess"
image: https://source.unsplash.com/400x175/?github
description: API docs for the apmDataAccess plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
---
import apmDataAccessObj from './apm_data_access.devdocs.json';

2
api_docs/asset_manager.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/assetManager
title: "assetManager"
image: https://source.unsplash.com/400x175/?github
description: API docs for the assetManager plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager']
---
import assetManagerObj from './asset_manager.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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
---
import cloudObj from './cloud.devdocs.json';

2
api_docs/cloud_chat.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChat
title: "cloudChat"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudChat plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChat']
---
import cloudChatObj from './cloud_chat.devdocs.json';

2
api_docs/cloud_chat_provider.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudChatProvider
title: "cloudChatProvider"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudChatProvider plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudChatProvider']
---
import cloudChatProviderObj from './cloud_chat_provider.devdocs.json';

2
api_docs/cloud_data_migration.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDataMigration
title: "cloudDataMigration"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDataMigration plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';

2
api_docs/cloud_defend.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudDefend
title: "cloudDefend"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudDefend plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
---
import cloudDefendObj from './cloud_defend.devdocs.json';

2
api_docs/cloud_experiments.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/cloudExperiments
title: "cloudExperiments"
image: https://source.unsplash.com/400x175/?github
description: API docs for the cloudExperiments plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
---
import cloudExperimentsObj from './cloud_experiments.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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
---
import consoleObj from './console.devdocs.json';

2
api_docs/content_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/contentManagement
title: "contentManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the contentManagement plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
---
import contentManagementObj from './content_management.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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
---
import controlsObj from './controls.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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
---
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';

66
api_docs/data.devdocs.json
View file

@ -12801,23 +12801,23 @@
"references": [
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/data_view_select.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx"
},
{
"plugin": "infra",
@ -13841,35 +13841,11 @@
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx"
},
{
"plugin": "stackAlerts",
@ -21606,35 +21582,11 @@
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx"
},
{
"plugin": "stackAlerts",

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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
---
import dataQueryObj from './data_query.devdocs.json';

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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
---
import dataViewManagementObj from './data_view_management.devdocs.json';

135
api_docs/data_views.devdocs.json
View file

@ -529,35 +529,11 @@
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx"
},
{
"plugin": "stackAlerts",
@ -5576,6 +5552,22 @@
}
],
"returnComment": []
},
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsServicePublic.getRollupsEnabled",
"type": "Function",
"tags": [],
"label": "getRollupsEnabled",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/data_views/public/data_views_service_public.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
@ -6550,6 +6542,22 @@
],
"returnComment": []
},
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsServicePublicDeps.getRollupsEnabled",
"type": "Function",
"tags": [],
"label": "getRollupsEnabled",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/data_views/public/data_views_service_public.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsServicePublicDeps.scriptedFieldsEnabled",
@ -7937,7 +7945,24 @@
"path": "src/plugins/data_views/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"children": [
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsPublicPluginSetup.enableRollups",
"type": "Function",
"tags": [],
"label": "enableRollups",
"description": [],
"signature": [
"() => void"
],
"path": "src/plugins/data_views/public/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
@ -8493,35 +8518,11 @@
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx"
},
{
"plugin": "stackAlerts",
@ -15567,35 +15568,11 @@
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/entity_index_expression.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
},
{
"plugin": "stackAlerts",
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx"
"path": "x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx"
},
{
"plugin": "stackAlerts",

4
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
---
import dataViewsObj from './data_views.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 1034 | 0 | 254 | 2 |
| 1037 | 0 | 257 | 2 |
## Client

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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

12
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---
@ -1539,14 +1539,14 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
| Deprecated API | Reference location(s) | Remove By |
| ---------------|-----------|-----------|
| <DocLink id="kibAlertingPluginApi" section="def-public.PluginSetupContract.registerNavigation" text="registerNavigation"/> | [index.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/es_query/index.ts#:~:text=registerNavigation) | - |
| <DocLink id="kibAlertingPluginApi" section="def-server.RuleExecutorServices.alertFactory" text="alertFactory"/> | [rule_type.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/index_threshold/rule_type.ts#:~:text=alertFactory), [rule_type.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/index_threshold/rule_type.ts#:~:text=alertFactory), [get_entities_and_generate_alerts.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/geo_containment/lib/get_entities_and_generate_alerts.ts#:~:text=alertFactory), [executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/geo_containment/executor.ts#:~:text=alertFactory), [executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/geo_containment/executor.ts#:~:text=alertFactory) | - |
| <DocLink id="kibAlertingPluginApi" section="def-server.RuleExecutorServices.alertFactory" text="alertFactory"/> | [rule_type.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/index_threshold/rule_type.ts#:~:text=alertFactory), [get_entities_and_generate_alerts.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/geo_containment/lib/get_entities_and_generate_alerts.ts#:~:text=alertFactory), [executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/geo_containment/executor.ts#:~:text=alertFactory), [executor.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/geo_containment/executor.ts#:~:text=alertFactory) | - |
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/es_query/rule_type.test.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/es_query/rule_type.test.ts#:~:text=fetch) | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [boundary_index_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx#:~:text=indexPatterns), [entity_index_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/entity_index_expression.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns) | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [data_view_select.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/data_view_select.tsx#:~:text=indexPatterns), [boundary_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx#:~:text=indexPatterns), [boundary_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx#:~:text=indexPatterns), [entity_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx#:~:text=indexPatterns), [entity_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx#:~:text=indexPatterns) | - |
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | [expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/threshold/expression.tsx#:~:text=fieldFormats) | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.title" text="title"/> | [boundary_index_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx#:~:text=title), [entity_index_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/entity_index_expression.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [data_view_select_popover.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx#:~:text=title), [boundary_index_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx#:~:text=title)+ 8 more | - |
| <DocLink id="kibDataPluginApi" section="def-common.DataView.title" text="title"/> | [boundary_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx#:~:text=title), [entity_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx#:~:text=title), [data_view_select_popover.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx#:~:text=title), [boundary_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx#:~:text=title), [entity_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx#:~:text=title), [data_view_select_popover.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx#:~:text=title) | - |
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/es_query/rule_type.test.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/server/rule_types/es_query/rule_type.test.ts#:~:text=fetch) | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | [boundary_index_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx#:~:text=title), [entity_index_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/entity_index_expression.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [data_view_select_popover.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx#:~:text=title), [boundary_index_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx#:~:text=title)+ 8 more | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | [boundary_index_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx#:~:text=title), [entity_index_expression.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/expressions/entity_index_expression.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [index.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/query_builder/index.tsx#:~:text=title), [data_view_select_popover.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx#:~:text=title) | - |
| <DocLink id="kibDataPluginApi" section="def-server.DataView.title" text="title"/> | [boundary_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx#:~:text=title), [entity_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx#:~:text=title), [data_view_select_popover.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx#:~:text=title), [boundary_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx#:~:text=title), [entity_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx#:~:text=title), [data_view_select_popover.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx#:~:text=title) | - |
| <DocLink id="kibDataViewsPluginApi" section="def-public.DataView.title" text="title"/> | [boundary_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/boundary_form.tsx#:~:text=title), [entity_form.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/geo_containment/rule_form/entity_form.tsx#:~:text=title), [data_view_select_popover.tsx](https://github.com/elastic/kibana/tree/main/x-pack/plugins/stack_alerts/public/rule_types/components/data_view_select_popover.tsx#:~:text=title) | - |

2
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
---
import devToolsObj from './dev_tools.devdocs.json';

274
api_docs/discover.devdocs.json
View file

@ -24,6 +24,280 @@
}
],
"interfaces": [
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState",
"type": "Interface",
"tags": [],
"label": "DiscoverAppState",
"description": [],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [
"\nColumns displayed in the table"
],
"signature": [
"string[] | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [
"\nArray of applied filters"
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.grid",
"type": "Object",
"tags": [],
"label": "grid",
"description": [
"\nData Grid related state"
],
"signature": [
{
"pluginId": "@kbn/unified-data-table",
"scope": "common",
"docId": "kibKbnUnifiedDataTablePluginApi",
"section": "def-common.UnifiedDataTableSettings",
"text": "UnifiedDataTableSettings"
},
" | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.hideChart",
"type": "CompoundType",
"tags": [],
"label": "hideChart",
"description": [
"\nHide chart"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.index",
"type": "string",
"tags": [],
"label": "index",
"description": [
"\nid of the used data view"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [
"\nUsed interval of the histogram"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.query",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [
"\nLucence or KQL query"
],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Query",
"text": "Query"
},
" | ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.AggregateQuery",
"text": "AggregateQuery"
},
" | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [
"\nArray of the used sorting [[field,direction],...]"
],
"signature": [
"string[][] | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.savedQuery",
"type": "string",
"tags": [],
"label": "savedQuery",
"description": [
"\nid of the used saved query"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.viewMode",
"type": "CompoundType",
"tags": [],
"label": "viewMode",
"description": [
"\nTable view: Documents vs Field Statistics"
],
"signature": [
{
"pluginId": "savedSearch",
"scope": "common",
"docId": "kibSavedSearchPluginApi",
"section": "def-common.VIEW_MODE",
"text": "VIEW_MODE"
},
" | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.hideAggregatedPreview",
"type": "CompoundType",
"tags": [],
"label": "hideAggregatedPreview",
"description": [
"\nHide mini distribution/preview charts when in Field Statistics mode"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.rowHeight",
"type": "number",
"tags": [],
"label": "rowHeight",
"description": [
"\nDocument explorer row height option"
],
"signature": [
"number | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.rowsPerPage",
"type": "number",
"tags": [],
"label": "rowsPerPage",
"description": [
"\nNumber of rows in the grid per page"
],
"signature": [
"number | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverAppState.breakdownField",
"type": "string",
"tags": [],
"label": "breakdownField",
"description": [
"\nBreakdown field of chart"
],
"signature": [
"string | undefined"
],
"path": "src/plugins/discover/public/application/main/services/discover_app_state_container.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "discover",
"id": "def-public.DiscoverCustomizationService",

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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
---
import discoverObj from './discover.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-data-discovery](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 98 | 0 | 71 | 15 |
| 113 | 0 | 72 | 15 |
## 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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
---
import discoverEnhancedObj from './discover_enhanced.devdocs.json';

2
api_docs/ecs_data_quality_dashboard.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/ecsDataQualityDashboard
title: "ecsDataQualityDashboard"
image: https://source.unsplash.com/400x175/?github
description: API docs for the ecsDataQualityDashboard plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
---
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';

2
api_docs/elastic_assistant.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/elasticAssistant
title: "elasticAssistant"
image: https://source.unsplash.com/400x175/?github
description: API docs for the elasticAssistant plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant']
---
import elasticAssistantObj from './elastic_assistant.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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
---
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';

83
api_docs/enterprise_search.devdocs.json
View file

@ -45,51 +45,6 @@
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "enterpriseSearch",
"id": "def-server.CONNECTORS_INDEX",
"type": "string",
"tags": [],
"label": "CONNECTORS_INDEX",
"description": [],
"signature": [
"\".elastic-connectors\""
],
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "enterpriseSearch",
"id": "def-server.CONNECTORS_JOBS_INDEX",
"type": "string",
"tags": [],
"label": "CONNECTORS_JOBS_INDEX",
"description": [],
"signature": [
"\".elastic-connectors-sync-jobs\""
],
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "enterpriseSearch",
"id": "def-server.CONNECTORS_VERSION",
"type": "number",
"tags": [],
"label": "CONNECTORS_VERSION",
"description": [],
"signature": [
"1"
],
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "enterpriseSearch",
"id": "def-server.CRAWLERS_INDEX",
@ -107,28 +62,13 @@
},
{
"parentPluginId": "enterpriseSearch",
"id": "def-server.CURRENT_CONNECTORS_INDEX",
"type": "string",
"id": "def-server.EnterpriseSearchPluginStart",
"type": "Type",
"tags": [],
"label": "CURRENT_CONNECTORS_INDEX",
"label": "EnterpriseSearchPluginStart",
"description": [],
"signature": [
"\".elastic-connectors-v1\""
],
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "enterpriseSearch",
"id": "def-server.CURRENT_CONNECTORS_JOB_INDEX",
"type": "string",
"tags": [],
"label": "CURRENT_CONNECTORS_JOB_INDEX",
"description": [],
"signature": [
"\".elastic-connectors-sync-jobs-v1\""
"PluginStart"
],
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"deprecated": false,
@ -303,20 +243,7 @@
"trackAdoption": false,
"initialIsOpen": false
}
],
"start": {
"parentPluginId": "enterpriseSearch",
"id": "def-server.EnterpriseSearchPluginStart",
"type": "Type",
"tags": [],
"label": "EnterpriseSearchPluginStart",
"description": [],
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"deprecated": false,
"trackAdoption": false,
"lifecycle": "start",
"initialIsOpen": true
}
]
},
"common": {
"classes": [],

7
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
---
import enterpriseSearchObj from './enterprise_search.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/enterprise-search-frontend](https://github.com/orgs/elastic/te
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 11 | 0 | 11 | 0 |
| 6 | 0 | 6 | 0 |
## Client
@ -30,9 +30,6 @@ Contact [@elastic/enterprise-search-frontend](https://github.com/orgs/elastic/te
## Server
### Start
<DocDefinitionList data={[enterpriseSearchObj.server.start]}/>
### Objects
<DocDefinitionList data={enterpriseSearchObj.server.objects}/>

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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
---
import eventAnnotationObj from './event_annotation.devdocs.json';

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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
---
import eventLogObj from './event_log.devdocs.json';

2
api_docs/exploratory_view.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/exploratoryView
title: "exploratoryView"
image: https://source.unsplash.com/400x175/?github
description: API docs for the exploratoryView plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
---
import exploratoryViewObj from './exploratory_view.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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
---
import fieldFormatsObj from './field_formats.devdocs.json';

42
api_docs/file_upload.devdocs.json
View file

@ -1124,48 +1124,6 @@
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.Mappings",
"type": "Interface",
"tags": [],
"label": "Mappings",
"description": [],
"path": "x-pack/plugins/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fileUpload",
"id": "def-common.Mappings._meta",
"type": "Object",
"tags": [],
"label": "_meta",
"description": [],
"signature": [
"{ created_by: string; } | undefined"
],
"path": "x-pack/plugins/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fileUpload",
"id": "def-common.Mappings.properties",
"type": "Object",
"tags": [],
"label": "properties",
"description": [],
"signature": [
"{ [key: string]: any; }"
],
"path": "x-pack/plugins/file_upload/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],

4
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
---
import fileUploadObj from './file_upload.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-gis](https://github.com/orgs/elastic/teams/kibana-gis)
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 62 | 0 | 62 | 2 |
| 59 | 0 | 59 | 2 |
## Client

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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'files']
---
import filesObj from './files.devdocs.json';

2
api_docs/files_management.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/filesManagement
title: "filesManagement"
image: https://source.unsplash.com/400x175/?github
description: API docs for the filesManagement plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
---
import filesManagementObj from './files_management.devdocs.json';

122
api_docs/fleet.devdocs.json
View file

@ -26707,6 +26707,128 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.API_VERSIONS",
"type": "Object",
"tags": [],
"label": "API_VERSIONS",
"description": [],
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-common.API_VERSIONS.public",
"type": "Object",
"tags": [],
"label": "public",
"description": [],
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-common.API_VERSIONS.public.v1",
"type": "string",
"tags": [],
"label": "v1",
"description": [],
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "fleet",
"id": "def-common.API_VERSIONS.internal",
"type": "Object",
"tags": [],
"label": "internal",
"description": [],
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-common.API_VERSIONS.internal.v1",
"type": "string",
"tags": [],
"label": "v1",
"description": [],
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.APP_API_ROUTES",
"type": "Object",
"tags": [],
"label": "APP_API_ROUTES",
"description": [],
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-common.APP_API_ROUTES.HEALTH_CHECK_PATTERN",
"type": "string",
"tags": [],
"label": "HEALTH_CHECK_PATTERN",
"description": [],
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.APP_API_ROUTES.CHECK_PERMISSIONS_PATTERN",
"type": "string",
"tags": [],
"label": "CHECK_PERMISSIONS_PATTERN",
"description": [],
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.APP_API_ROUTES.GENERATE_SERVICE_TOKEN_PATTERN",
"type": "string",
"tags": [],
"label": "GENERATE_SERVICE_TOKEN_PATTERN",
"description": [],
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.APP_API_ROUTES.GENERATE_SERVICE_TOKEN_PATTERN_DEPRECATED",
"type": "string",
"tags": [],
"label": "GENERATE_SERVICE_TOKEN_PATTERN_DEPRECATED",
"description": [
"// deprecated since 8.0"
],
"path": "x-pack/plugins/fleet/common/constants/routes.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "fleet",
"id": "def-common.appRoutesService",

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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
---
import fleetObj from './fleet.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/fleet](https://github.com/orgs/elastic/teams/fleet) for questi
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 1189 | 3 | 1073 | 41 |
| 1199 | 3 | 1082 | 41 |
## 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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
---
import globalSearchObj from './global_search.devdocs.json';

2
api_docs/guided_onboarding.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/guidedOnboarding
title: "guidedOnboarding"
image: https://source.unsplash.com/400x175/?github
description: API docs for the guidedOnboarding plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
---
import guidedOnboardingObj from './guided_onboarding.devdocs.json';

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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
---
import homeObj from './home.devdocs.json';

2
api_docs/image_embeddable.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/imageEmbeddable
title: "imageEmbeddable"
image: https://source.unsplash.com/400x175/?github
description: API docs for the imageEmbeddable plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
---
import imageEmbeddableObj from './image_embeddable.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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
---
import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json';

54
api_docs/index_management.devdocs.json
View file

@ -2013,6 +2013,60 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexSettingsResponse",
"type": "Interface",
"tags": [],
"label": "IndexSettingsResponse",
"description": [],
"path": "x-pack/plugins/index_management/common/types/indices.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexSettingsResponse.settings",
"type": "Object",
"tags": [],
"label": "settings",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.IndexSettings",
"text": "IndexSettings"
}
],
"path": "x-pack/plugins/index_management/common/types/indices.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.IndexSettingsResponse.defaults",
"type": "Object",
"tags": [],
"label": "defaults",
"description": [],
"signature": [
{
"pluginId": "indexManagement",
"scope": "common",
"docId": "kibIndexManagementPluginApi",
"section": "def-common.IndexSettings",
"text": "IndexSettings"
}
],
"path": "x-pack/plugins/index_management/common/types/indices.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "indexManagement",
"id": "def-common.LegacyTemplateSerialized",

4
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
---
import indexManagementObj from './index_management.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/platform-deployment-management](https://github.com/orgs/elasti
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 191 | 0 | 186 | 4 |
| 194 | 0 | 189 | 4 |
## Client

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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components']
---
import kbnAiopsComponentsObj from './kbn_aiops_components.devdocs.json';

2
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils']
---
import kbnAiopsUtilsObj from './kbn_aiops_utils.devdocs.json';

2
api_docs/kbn_alerting_api_integration_helpers.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-api-integration-helpers
title: "@kbn/alerting-api-integration-helpers"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerting-api-integration-helpers plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-api-integration-helpers']
---
import kbnAlertingApiIntegrationHelpersObj from './kbn_alerting_api_integration_helpers.devdocs.json';

2
api_docs/kbn_alerting_state_types.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerting-state-types
title: "@kbn/alerting-state-types"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerting-state-types plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types']
---
import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json';

2
api_docs/kbn_alerts_as_data_utils.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-as-data-utils
title: "@kbn/alerts-as-data-utils"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts-as-data-utils plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-as-data-utils']
---
import kbnAlertsAsDataUtilsObj from './kbn_alerts_as_data_utils.devdocs.json';

2
api_docs/kbn_alerts_ui_shared.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-alerts-ui-shared
title: "@kbn/alerts-ui-shared"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/alerts-ui-shared plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared']
---
import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
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: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory']
---
import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json';

2
api_docs/kbn_analytics_shippers_gainsight.mdx
View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-gainsight
title: "@kbn/analytics-shippers-gainsight"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/analytics-shippers-gainsight plugin
date: 2023-09-06
date: 2023-09-07
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-gainsight']
---
import kbnAnalyticsShippersGainsightObj from './kbn_analytics_shippers_gainsight.devdocs.json';

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