Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[api-docs] 2024-11-22 Daily api_docs build #201312

Merged
merged 1 commit into from
Nov 22, 2024
Merged

[api-docs] 2024-11-22 Daily api_docs build #201312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion api_docs/actions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/advanced_settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
---
import advancedSettingsObj from './advanced_settings.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/ai_assistant_management_selection.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ slug: /kibana-dev-docs/api/aiAssistantManagementSelection
title: "aiAssistantManagementSelection"
image: https://source.unsplash.com/400x175/?github
description: API docs for the aiAssistantManagementSelection plugin
date: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiAssistantManagementSelection']
---
import aiAssistantManagementSelectionObj from './ai_assistant_management_selection.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/aiops.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/alerting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/apm.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.devdocs.json';
Expand Down
157 changes: 3 additions & 154 deletions api_docs/apm_data_access.devdocs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,78 +441,6 @@
],
"functions": [],
"interfaces": [
{
"parentPluginId": "apmDataAccess",
"id": "def-server.ApmDataAccessPrivilegesCheck",
"type": "Interface",
"tags": [],
"label": "ApmDataAccessPrivilegesCheck",
"description": [],
"path": "x-pack/plugins/observability_solution/apm_data_access/server/lib/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "apmDataAccess",
"id": "def-server.ApmDataAccessPrivilegesCheck.request",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-http-server",
"scope": "server",
"docId": "kibKbnCoreHttpServerPluginApi",
"section": "def-server.KibanaRequest",
"text": "KibanaRequest"
},
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/plugins/observability_solution/apm_data_access/server/lib/check_privileges.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "apmDataAccess",
"id": "def-server.ApmDataAccessPrivilegesCheck.security",
"type": "Object",
"tags": [],
"label": "security",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.SecurityPluginStart",
"text": "SecurityPluginStart"
},
" | undefined"
],
"path": "x-pack/plugins/observability_solution/apm_data_access/server/lib/check_privileges.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "apmDataAccess",
"id": "def-server.ApmDataAccessPrivilegesCheck.getApmIndices",
"type": "Function",
"tags": [],
"label": "getApmIndices",
"description": [],
"signature": [
"() => Promise<Readonly<{} & { error: string; transaction: string; span: string; metric: string; onboarding: string; sourcemap: string; }>>"
],
"path": "x-pack/plugins/observability_solution/apm_data_access/server/lib/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "apmDataAccess",
"id": "def-server.ApmDataAccessServicesParams",
Expand Down Expand Up @@ -2365,42 +2293,12 @@
"label": "getApmIndices",
"description": [],
"signature": [
"(soClient: ",
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
},
") => Promise<Readonly<{} & { error: string; transaction: string; span: string; metric: string; onboarding: string; sourcemap: string; }>>"
"() => Promise<Readonly<{} & { error: string; transaction: string; span: string; metric: string; onboarding: string; sourcemap: string; }>>"
],
"path": "x-pack/plugins/observability_solution/apm_data_access/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "apmDataAccess",
"id": "def-server.ApmDataAccessPluginSetup.getApmIndices.$1",
"type": "Object",
"tags": [],
"label": "soClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/core-saved-objects-api-server",
"scope": "server",
"docId": "kibKbnCoreSavedObjectsApiServerPluginApi",
"section": "def-server.SavedObjectsClientContract",
"text": "SavedObjectsClientContract"
}
],
"path": "x-pack/plugins/observability_solution/apm_data_access/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"children": [],
"returnComment": []
},
{
Expand Down Expand Up @@ -2504,56 +2402,7 @@
"path": "x-pack/plugins/observability_solution/apm_data_access/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "apmDataAccess",
"id": "def-server.ApmDataAccessPluginStart.hasPrivileges",
"type": "Function",
"tags": [],
"label": "hasPrivileges",
"description": [],
"signature": [
"(params: Pick<",
{
"pluginId": "apmDataAccess",
"scope": "server",
"docId": "kibApmDataAccessPluginApi",
"section": "def-server.ApmDataAccessPrivilegesCheck",
"text": "ApmDataAccessPrivilegesCheck"
},
", \"request\">) => Promise<boolean>"
],
"path": "x-pack/plugins/observability_solution/apm_data_access/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "apmDataAccess",
"id": "def-server.ApmDataAccessPluginStart.hasPrivileges.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"Pick<",
{
"pluginId": "apmDataAccess",
"scope": "server",
"docId": "kibApmDataAccessPluginApi",
"section": "def-server.ApmDataAccessPrivilegesCheck",
"text": "ApmDataAccessPrivilegesCheck"
},
", \"request\">"
],
"path": "x-pack/plugins/observability_solution/apm_data_access/server/types.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
Expand Down
4 changes: 2 additions & 2 deletions api_docs/apm_data_access.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmDataAccess']
---
import apmDataAccessObj from './apm_data_access.devdocs.json';
Expand All @@ -21,7 +21,7 @@ Contact [@elastic/obs-knowledge-team](https://github.com/orgs/elastic/teams/obs-

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 93 | 0 | 93 | 3 |
| 86 | 0 | 86 | 3 |

## Server

Expand Down
2 changes: 1 addition & 1 deletion api_docs/banners.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
---
import bannersObj from './banners.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/bfetch.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
---
import bfetchObj from './bfetch.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/canvas.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
---
import canvasObj from './canvas.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/cases.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
---
import casesObj from './cases.devdocs.json';
Expand Down
16 changes: 0 additions & 16 deletions api_docs/charts.devdocs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2219,22 +2219,6 @@
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "charts",
"id": "def-public.ChartsPluginSetup.legacyColors",
"type": "Object",
"tags": [],
"label": "legacyColors",
"description": [],
"signature": [
"{ readonly seedColors: string[]; readonly mappedColors: ",
"MappedColors",
"; createColorLookupFunction: (arrayOfStringsOrNumbers?: (string | number)[] | undefined, colorMapping?: Partial<Record<string, string>>) => (value: string | number) => any; }"
],
"path": "src/plugins/charts/public/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "charts",
"id": "def-public.ChartsPluginSetup.theme",
Expand Down
4 changes: 2 additions & 2 deletions api_docs/charts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
---
import chartsObj from './charts.devdocs.json';
Expand All @@ -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 |
|-------------------|-----------|------------------------|-----------------|
| 268 | 2 | 253 | 10 |
| 267 | 2 | 252 | 9 |

## Client

Expand Down
2 changes: 1 addition & 1 deletion api_docs/cloud.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
---
import cloudObj from './cloud.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/cloud_data_migration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDataMigration']
---
import cloudDataMigrationObj from './cloud_data_migration.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/cloud_defend.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudDefend']
---
import cloudDefendObj from './cloud_defend.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/cloud_security_posture.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
---
import cloudSecurityPostureObj from './cloud_security_posture.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/console.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
---
import consoleObj from './console.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/content_management.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'contentManagement']
---
import contentManagementObj from './content_management.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/controls.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: 2024-11-21
date: 2024-11-22
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
---
import controlsObj from './controls.devdocs.json';
Expand Down
Loading