[api-docs] 2023-10-17 Daily api_docs build (#169059)

Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/493
This commit is contained in:
Kibana Machine 2023-10-17 01:07:46 -04:00 committed by GitHub
parent 6fdd1f177a
commit 4d4ff51e96
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
607 changed files with 1474 additions and 1055 deletions

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

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

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

View file

@ -3645,7 +3645,7 @@
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getExistingIndices: (indices: string[]) => Promise<string[]>; getFieldsForIndexPattern: (indexPattern: ",
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';

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

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
---
import apmDataAccessObj from './apm_data_access.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'assetManager']
---
import assetManagerObj from './asset_manager.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
---
import bannersObj from './banners.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
---
import bfetchObj from './bfetch.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
---
import canvasObj from './canvas.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
import casesObj from './cases.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
---
import cloudObj from './cloud.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
---
import cloudDefendObj from './cloud_defend.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudExperiments']
---
import cloudExperimentsObj from './cloud_experiments.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
---
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
---
import consoleObj from './console.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
---
import contentManagementObj from './content_management.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
---
import controlsObj from './controls.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
---
import customIntegrationsObj from './custom_integrations.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
---
import dashboardObj from './dashboard.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
---
import dashboardEnhancedObj from './dashboard_enhanced.devdocs.json';

View file

@ -7805,20 +7805,6 @@
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "data",
"id": "def-public.GetFieldsOptions.allowHidden",
"type": "CompoundType",
"tags": [],
"label": "allowHidden",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -14258,22 +14244,6 @@
"index pattern string"
]
},
{
"parentPluginId": "data",
"id": "def-server.DataView.getAllowHidden",
"type": "Function",
"tags": [],
"label": "getAllowHidden",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/data_views/common/data_views/data_view.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-server.DataView.setIndexPattern",
@ -16197,44 +16167,6 @@
"FieldSpec[]"
]
},
{
"parentPluginId": "data",
"id": "def-server.DataViewsService.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.DataViewsService.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list"
]
},
{
"parentPluginId": "data",
"id": "def-server.DataViewsService.getFieldsForIndexPattern",
@ -17265,7 +17197,7 @@
"signature": [
"(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; includeUnmapped?: boolean | undefined; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; indexFilter?: ",
"QueryDslQueryContainer",
" | undefined; fields?: string[] | undefined; allowHidden?: boolean | undefined; }) => Promise<{ fields: ",
" | undefined; fields?: string[] | undefined; }) => Promise<{ fields: ",
{
"pluginId": "dataViews",
"scope": "server",
@ -17388,25 +17320,49 @@
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.allowHidden",
"type": "CompoundType",
"tags": [],
"label": "allowHidden",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "data",
"id": "def-server.IndexPatternsFetcher.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"- index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list of index patterns that match indices"
]
}
],
"initialIsOpen": false
@ -22047,22 +22003,6 @@
"index pattern string"
]
},
{
"parentPluginId": "data",
"id": "def-common.DataView.getAllowHidden",
"type": "Function",
"tags": [],
"label": "getAllowHidden",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/data_views/common/data_views/data_view.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.DataView.setIndexPattern",
@ -24857,44 +24797,6 @@
"FieldSpec[]"
]
},
{
"parentPluginId": "data",
"id": "def-common.DataViewsService.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "data",
"id": "def-common.DataViewsService.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list"
]
},
{
"parentPluginId": "data",
"id": "def-common.DataViewsService.getFieldsForIndexPattern",
@ -26965,22 +26867,6 @@
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "data",
"id": "def-common.DataViewAttributes.allowHidden",
"type": "CompoundType",
"tags": [],
"label": "allowHidden",
"description": [
"\nAllow hidden and system indices when loading field list"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -27230,20 +27116,6 @@
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "data",
"id": "def-common.GetFieldsOptions.allowHidden",
"type": "CompoundType",
"tags": [],
"label": "allowHidden",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -27421,7 +27293,7 @@
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; allowHidden?: boolean | undefined; }"
" | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; }"
],
"path": "src/plugins/data_views/common/expressions/load_index_pattern.ts",
"deprecated": false,
@ -28331,7 +28203,7 @@
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getExistingIndices: (indices: string[]) => Promise<string[]>; getFieldsForIndexPattern: (indexPattern: ",
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",
@ -28548,7 +28420,7 @@
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; allowHidden?: boolean | undefined; }"
" | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; }"
],
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
---
import dataObj from './data.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3290 | 33 | 2554 | 24 |
| 3282 | 33 | 2549 | 24 |
## Client

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
---
import dataQueryObj from './data_query.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3290 | 33 | 2554 | 24 |
| 3282 | 33 | 2549 | 24 |
## Client

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
---
import dataSearchObj from './data_search.devdocs.json';
@ -21,7 +21,7 @@ Contact [@elastic/kibana-visualizations](https://github.com/orgs/elastic/teams/k
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3290 | 33 | 2554 | 24 |
| 3282 | 33 | 2549 | 24 |
## Client

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
---
import dataViewEditorObj from './data_view_editor.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
---
import dataViewFieldEditorObj from './data_view_field_editor.devdocs.json';

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

View file

@ -1225,22 +1225,6 @@
"index pattern string"
]
},
{
"parentPluginId": "dataViews",
"id": "def-public.DataView.getAllowHidden",
"type": "Function",
"tags": [],
"label": "getAllowHidden",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/data_views/common/data_views/data_view.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dataViews",
"id": "def-public.DataView.setIndexPattern",
@ -4456,44 +4440,6 @@
"FieldSpec[]"
]
},
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsService.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsService.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list"
]
},
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsService.getFieldsForIndexPattern",
@ -5602,6 +5548,46 @@
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsServicePublic.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<",
"ExistingIndicesResponse",
">"
],
"path": "src/plugins/data_views/public/data_views_service_public.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsServicePublic.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"- index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/public/data_views_service_public.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list of index patterns that match indices"
]
}
],
"initialIsOpen": false
@ -6142,22 +6128,6 @@
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewAttributes.allowHidden",
"type": "CompoundType",
"tags": [],
"label": "allowHidden",
"description": [
"\nAllow hidden and system indices when loading field list"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -6618,6 +6588,26 @@
"path": "src/plugins/data_views/public/data_views_service_public.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataViews",
"id": "def-public.DataViewsServicePublicDeps.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-browser",
"scope": "common",
"docId": "kibKbnCoreHttpBrowserPluginApi",
"section": "def-common.HttpSetup",
"text": "HttpSetup"
}
],
"path": "src/plugins/data_views/public/data_views_service_public.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -7814,7 +7804,7 @@
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; allowHidden?: boolean | undefined; }"
" | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; }"
],
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,
@ -9264,22 +9254,6 @@
"index pattern string"
]
},
{
"parentPluginId": "dataViews",
"id": "def-server.DataView.getAllowHidden",
"type": "Function",
"tags": [],
"label": "getAllowHidden",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/data_views/common/data_views/data_view.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dataViews",
"id": "def-server.DataView.setIndexPattern",
@ -11497,44 +11471,6 @@
"FieldSpec[]"
]
},
{
"parentPluginId": "dataViews",
"id": "def-server.DataViewsService.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataViews",
"id": "def-server.DataViewsService.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list"
]
},
{
"parentPluginId": "dataViews",
"id": "def-server.DataViewsService.getFieldsForIndexPattern",
@ -12565,7 +12501,7 @@
"signature": [
"(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; includeUnmapped?: boolean | undefined; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; indexFilter?: ",
"QueryDslQueryContainer",
" | undefined; fields?: string[] | undefined; allowHidden?: boolean | undefined; }) => Promise<{ fields: ",
" | undefined; fields?: string[] | undefined; }) => Promise<{ fields: ",
{
"pluginId": "dataViews",
"scope": "server",
@ -12688,25 +12624,49 @@
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataViews",
"id": "def-server.IndexPatternsFetcher.getFieldsForWildcard.$1.allowHidden",
"type": "CompoundType",
"tags": [],
"label": "allowHidden",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"trackAdoption": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "dataViews",
"id": "def-server.IndexPatternsFetcher.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataViews",
"id": "def-server.IndexPatternsFetcher.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"- index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/server/fetcher/index_patterns_fetcher.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list of index patterns that match indices"
]
}
],
"initialIsOpen": false
@ -16362,22 +16322,6 @@
"index pattern string"
]
},
{
"parentPluginId": "dataViews",
"id": "def-common.DataView.getAllowHidden",
"type": "Function",
"tags": [],
"label": "getAllowHidden",
"description": [],
"signature": [
"() => boolean"
],
"path": "src/plugins/data_views/common/data_views/data_view.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "dataViews",
"id": "def-common.DataView.setIndexPattern",
@ -19259,44 +19203,6 @@
"FieldSpec[]"
]
},
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsService.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsService.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list"
]
},
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsService.getFieldsForIndexPattern",
@ -20801,22 +20707,6 @@
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewAttributes.allowHidden",
"type": "CompoundType",
"tags": [],
"label": "allowHidden",
"description": [
"\nAllow hidden and system indices when loading field list"
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -22442,44 +22332,6 @@
],
"returnComment": []
},
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsServicePublicMethods.getExistingIndices",
"type": "Function",
"tags": [],
"label": "getExistingIndices",
"description": [
"\nGet existing index pattern list by providing string array index pattern list."
],
"signature": [
"(indices: string[]) => Promise<string[]>"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsServicePublicMethods.getExistingIndices.$1",
"type": "Array",
"tags": [],
"label": "indices",
"description": [
"- index pattern list"
],
"signature": [
"string[]"
],
"path": "src/plugins/data_views/common/data_views/data_views.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"index pattern list of index patterns that match indices"
]
},
{
"parentPluginId": "dataViews",
"id": "def-common.DataViewsServicePublicMethods.getIds",
@ -23149,20 +23001,6 @@
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "dataViews",
"id": "def-common.GetFieldsOptions.allowHidden",
"type": "CompoundType",
"tags": [],
"label": "allowHidden",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -23845,7 +23683,7 @@
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; allowHidden?: boolean | undefined; }"
" | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; }"
],
"path": "src/plugins/data_views/common/expressions/load_index_pattern.ts",
"deprecated": false,
@ -25351,7 +25189,7 @@
"section": "def-common.FieldSpec",
"text": "FieldSpec"
},
"[]>; getExistingIndices: (indices: string[]) => Promise<string[]>; getFieldsForIndexPattern: (indexPattern: ",
"[]>; getFieldsForIndexPattern: (indexPattern: ",
{
"pluginId": "dataViews",
"scope": "common",
@ -25568,7 +25406,7 @@
"section": "def-common.FieldAttrs",
"text": "FieldAttrs"
},
" | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; allowHidden?: boolean | undefined; }"
" | undefined; allowNoIndex?: boolean | undefined; namespaces?: string[] | undefined; name?: string | undefined; }"
],
"path": "src/plugins/data_views/common/types.ts",
"deprecated": false,

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-10-16
date: 2023-10-17
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 |
|-------------------|-----------|------------------------|-----------------|
| 1048 | 0 | 262 | 2 |
| 1038 | 0 | 258 | 3 |
## Client

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
---
import dataVisualizerObj from './data_visualizer.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana']
---

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

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
---
import discoverObj from './discover.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
---
import discoverEnhancedObj from './discover_enhanced.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ecsDataQualityDashboard']
---
import ecsDataQualityDashboardObj from './ecs_data_quality_dashboard.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'elasticAssistant']
---
import elasticAssistantObj from './elastic_assistant.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
---
import embeddableObj from './embeddable.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
---
import embeddableEnhancedObj from './embeddable_enhanced.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
---
import encryptedSavedObjectsObj from './encrypted_saved_objects.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
---
import enterpriseSearchObj from './enterprise_search.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
---
import esUiSharedObj from './es_ui_shared.devdocs.json';

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

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/eventAnnotationListing
title: "eventAnnotationListing"
image: https://source.unsplash.com/400x175/?github
description: API docs for the eventAnnotationListing plugin
date: 2023-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotationListing']
---
import eventAnnotationListingObj from './event_annotation_listing.devdocs.json';

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

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'exploratoryView']
---
import exploratoryViewObj from './exploratory_view.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
---
import expressionErrorObj from './expression_error.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
---
import expressionGaugeObj from './expression_gauge.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
---
import expressionHeatmapObj from './expression_heatmap.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
---
import expressionImageObj from './expression_image.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
---
import expressionLegacyMetricVisObj from './expression_legacy_metric_vis.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
---
import expressionMetricObj from './expression_metric.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
---
import expressionMetricVisObj from './expression_metric_vis.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
---
import expressionPartitionVisObj from './expression_partition_vis.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
---
import expressionRepeatImageObj from './expression_repeat_image.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
---
import expressionRevealImageObj from './expression_reveal_image.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
---
import expressionShapeObj from './expression_shape.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
---
import expressionTagcloudObj from './expression_tagcloud.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
---
import expressionXYObj from './expression_x_y.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
---
import expressionsObj from './expressions.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
---
import featuresObj from './features.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
---
import fieldFormatsObj from './field_formats.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
---
import fileUploadObj from './file_upload.devdocs.json';

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

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'filesManagement']
---
import filesManagementObj from './files_management.devdocs.json';

View file

@ -3269,6 +3269,52 @@
],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-public.pagePathGetters.integration_details_configs",
"type": "Function",
"tags": [],
"label": "integration_details_configs",
"description": [],
"signature": [
"({ pkgkey, integration }: ",
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
},
") => [string, string]"
],
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-public.pagePathGetters.integration_details_configs.$1",
"type": "Object",
"tags": [],
"label": "{ pkgkey, integration }",
"description": [],
"signature": [
{
"pluginId": "fleet",
"scope": "public",
"docId": "kibFleetPluginApi",
"section": "def-public.DynamicPagePathValues",
"text": "DynamicPagePathValues"
}
],
"path": "x-pack/plugins/fleet/public/constants/page_paths.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-public.pagePathGetters.integration_details_custom",
@ -17781,6 +17827,20 @@
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "fleet",
"id": "def-common.AgentPolicy.keep_monitoring_alive",
"type": "CompoundType",
"tags": [],
"label": "keep_monitoring_alive",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
@ -19431,7 +19491,9 @@
"label": "agent",
"description": [],
"signature": [
"{ monitoring: { namespace?: string | undefined; use_output?: string | undefined; enabled: boolean; metrics: boolean; logs: boolean; }; download: { sourceURI: string; }; features: Record<string, { enabled: boolean; }>; protection?: { enabled: boolean; uninstall_token_hash: string; signing_key: string; } | undefined; } | undefined"
"{ monitoring: ",
"FullAgentPolicyMonitoring",
"; download: { sourceURI: string; }; features: Record<string, { enabled: boolean; }>; protection?: { enabled: boolean; uninstall_token_hash: string; signing_key: string; } | undefined; } | undefined"
],
"path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts",
"deprecated": false,
@ -27601,6 +27663,53 @@
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "fleet",
"id": "def-common.epmRouteService.getInputsTemplatesPath",
"type": "Function",
"tags": [],
"label": "getInputsTemplatesPath",
"description": [],
"signature": [
"(pkgName: string, pkgVersion: string) => string"
],
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "fleet",
"id": "def-common.epmRouteService.getInputsTemplatesPath.$1",
"type": "string",
"tags": [],
"label": "pkgName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "fleet",
"id": "def-common.epmRouteService.getInputsTemplatesPath.$2",
"type": "string",
"tags": [],
"label": "pkgVersion",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/fleet/common/services/routes.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false

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-10-16
date: 2023-10-17
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 |
|-------------------|-----------|------------------------|-----------------|
| 1202 | 3 | 1084 | 42 |
| 1208 | 3 | 1090 | 43 |
## Client

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
---
import globalSearchObj from './global_search.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'guidedOnboarding']
---
import guidedOnboardingObj from './guided_onboarding.devdocs.json';

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

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'imageEmbeddable']
---
import imageEmbeddableObj from './image_embeddable.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
---
import indexLifecycleManagementObj from './index_lifecycle_management.devdocs.json';

View file

@ -1526,13 +1526,14 @@
{
"parentPluginId": "indexManagement",
"id": "def-common.DataStream.lifecycle",
"type": "Object",
"type": "CompoundType",
"tags": [],
"label": "lifecycle",
"description": [],
"signature": [
"(",
"IndicesDataLifecycleWithRollover",
" | undefined"
" & { enabled?: boolean | undefined; }) | undefined"
],
"path": "x-pack/plugins/index_management/common/types/data_streams.ts",
"deprecated": false,

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
---
import indexManagementObj from './index_management.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
---
import infraObj from './infra.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
---
import inspectorObj from './inspector.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
---
import interactiveSetupObj from './interactive_setup.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
---
import kbnAceObj from './kbn_ace.devdocs.json';

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

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

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-api-integration-helpers']
---
import kbnAlertingApiIntegrationHelpersObj from './kbn_alerting_api_integration_helpers.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerting-state-types']
---
import kbnAlertingStateTypesObj from './kbn_alerting_state_types.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-as-data-utils']
---
import kbnAlertsAsDataUtilsObj from './kbn_alerts_as_data_utils.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts-ui-shared']
---
import kbnAlertsUiSharedObj from './kbn_alerts_ui_shared.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics']
---
import kbnAnalyticsObj from './kbn_analytics.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client']
---
import kbnAnalyticsClientObj from './kbn_analytics_client.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser']
---
import kbnAnalyticsShippersElasticV3BrowserObj from './kbn_analytics_shippers_elastic_v3_browser.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common']
---
import kbnAnalyticsShippersElasticV3CommonObj from './kbn_analytics_shippers_elastic_v3_common.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server']
---
import kbnAnalyticsShippersElasticV3ServerObj from './kbn_analytics_shippers_elastic_v3_server.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory']
---
import kbnAnalyticsShippersFullstoryObj from './kbn_analytics_shippers_fullstory.devdocs.json';

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-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-gainsight']
---
import kbnAnalyticsShippersGainsightObj from './kbn_analytics_shippers_gainsight.devdocs.json';

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: 2023-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader']
---
import kbnApmConfigLoaderObj from './kbn_apm_config_loader.devdocs.json';

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: 2023-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace']
---
import kbnApmSynthtraceObj from './kbn_apm_synthtrace.devdocs.json';

View file

@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/kbn-apm-synthtrace-client
title: "@kbn/apm-synthtrace-client"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/apm-synthtrace-client plugin
date: 2023-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-synthtrace-client']
---
import kbnApmSynthtraceClientObj from './kbn_apm_synthtrace_client.devdocs.json';

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: 2023-10-16
date: 2023-10-17
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-utils']
---
import kbnApmUtilsObj from './kbn_apm_utils.devdocs.json';

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