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] Daily api_docs build (#139941)

Browse source
This commit is contained in:
Kibana Machine 2022-09-01 12:02:27 -04:00 • committed by GitHub
parent 8c010530ab
commit 75c2229faa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
15 changed files with 431 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

17
api_docs/core.devdocs.json
View file

@ -17474,13 +17474,7 @@
"{@link I18nServiceSetup}"
],
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.I18nServiceSetup",
"text": "I18nServiceSetup"
}
"I18nServiceSetup"
],
"path": "src/core/server/index.ts",
"deprecated": false
@ -22202,7 +22196,10 @@
"tags": [],
"label": "I18nServiceSetup",
"description": [],
"path": "src/core/server/i18n/i18n_service.ts",
"signature": [
"I18nServiceSetup"
],
"path": "node_modules/@types/kbn__core-i18n-server/index.d.ts",
"deprecated": false,
"children": [
{
@ -22217,7 +22214,7 @@
"signature": [
"() => string"
],
"path": "src/core/server/i18n/i18n_service.ts",
"path": "node_modules/@types/kbn__core-i18n-server/index.d.ts",
"deprecated": false,
"children": [],
"returnComment": []
@ -22234,7 +22231,7 @@
"signature": [
"() => string[]"
],
"path": "src/core/server/i18n/i18n_service.ts",
"path": "node_modules/@types/kbn__core-i18n-server/index.d.ts",
"deprecated": false,
"children": [],
"returnComment": []

2
api_docs/core.mdx
View file

@ -21,7 +21,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2656 | 1 | 101 | 3 |
| 2656 | 1 | 100 | 3 |
## Client

2
api_docs/core_chrome.mdx
View file

@ -21,7 +21,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 2656 | 1 | 101 | 3 |
| 2656 | 1 | 100 | 3 |
## Client

2
api_docs/data.devdocs.json
View file

@ -8724,7 +8724,7 @@
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; }"
" | undefined; disableShardWarnings?: boolean | undefined; }"
],
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
"deprecated": false,

2
api_docs/data.mdx
View file

@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3130 | 34 | 2440 | 23 |
| 3131 | 34 | 2441 | 23 |
## Client

2
api_docs/data_query.mdx
View file

@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3130 | 34 | 2440 | 23 |
| 3131 | 34 | 2441 | 23 |
## Client

23
api_docs/data_search.devdocs.json
View file

@ -13895,7 +13895,7 @@
"label": "handleRequest",
"description": [],
"signature": [
"({ abortSignal, aggs, filters, indexPattern, inspectorAdapters, query, searchSessionId, searchSourceService, timeFields, timeRange, getNow, executionContext, }: ",
"({ abortSignal, aggs, filters, indexPattern, inspectorAdapters, query, searchSessionId, searchSourceService, timeFields, timeRange, disableShardWarnings, getNow, executionContext, }: ",
{
"pluginId": "data",
"scope": "common",
@ -13923,7 +13923,7 @@
"id": "def-common.handleRequest.$1",
"type": "Object",
"tags": [],
"label": "{\n abortSignal,\n aggs,\n filters,\n indexPattern,\n inspectorAdapters,\n query,\n searchSessionId,\n searchSourceService,\n timeFields,\n timeRange,\n getNow,\n executionContext,\n}",
"label": "{\n abortSignal,\n aggs,\n filters,\n indexPattern,\n inspectorAdapters,\n query,\n searchSessionId,\n searchSourceService,\n timeFields,\n timeRange,\n disableShardWarnings,\n getNow,\n executionContext,\n}",
"description": [],
"signature": [
{
@ -24764,6 +24764,19 @@
"path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.RequestHandlerParams.disableShardWarnings",
"type": "CompoundType",
"tags": [],
"label": "disableShardWarnings",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/data/common/search/expressions/esaggs/request_handler.ts",
"deprecated": false
},
{
"parentPluginId": "data",
"id": "def-common.RequestHandlerParams.getNow",
@ -27560,7 +27573,7 @@
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; }"
" | undefined; disableShardWarnings?: boolean | undefined; }"
],
"path": "src/plugins/data/common/search/expressions/kibana_context_type.ts",
"deprecated": false,
@ -35203,7 +35216,7 @@
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; }"
" | undefined; disableShardWarnings?: boolean | undefined; }"
],
"path": "src/plugins/data/common/search/expressions/remove_filter.ts",
"deprecated": false,
@ -35506,7 +35519,7 @@
"section": "def-common.TimeRange",
"text": "TimeRange"
},
" | undefined; }"
" | undefined; disableShardWarnings?: boolean | undefined; }"
],
"path": "src/plugins/data/common/search/expressions/select_filter.ts",
"deprecated": false,

2
api_docs/data_search.mdx
View file

@ -21,7 +21,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3130 | 34 | 2440 | 23 |
| 3131 | 34 | 2441 | 23 |
## Client

75
api_docs/kbn_core_i18n_server.devdocs.json Normal file
View file

@ -0,0 +1,75 @@
{
"id": "@kbn/core-i18n-server",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "@kbn/core-i18n-server",
"id": "def-common.I18nServiceSetup",
"type": "Interface",
"tags": [],
"label": "I18nServiceSetup",
"description": [],
"path": "packages/core/i18n/core-i18n-server/src/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/core-i18n-server",
"id": "def-common.I18nServiceSetup.getLocale",
"type": "Function",
"tags": [],
"label": "getLocale",
"description": [
"\nReturn the locale currently in use."
],
"signature": [
"() => string"
],
"path": "packages/core/i18n/core-i18n-server/src/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/core-i18n-server",
"id": "def-common.I18nServiceSetup.getTranslationFiles",
"type": "Function",
"tags": [],
"label": "getTranslationFiles",
"description": [
"\nReturn the absolute paths to translation files currently in use."
],
"signature": [
"() => string[]"
],
"path": "packages/core/i18n/core-i18n-server/src/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
}
}

30
api_docs/kbn_core_i18n_server.mdx Normal file
View file

@ -0,0 +1,30 @@
---
####
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
#### Reach out in #docs-engineering for more info.
####
id: kibKbnCoreI18nServerPluginApi
slug: /kibana-dev-docs/api/kbn-core-i18n-server
title: "@kbn/core-i18n-server"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-i18n-server plugin
date: 2022-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server']
---
import kbnCoreI18nServerObj from './kbn_core_i18n_server.devdocs.json';
Contact Kibana Core for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3 | 0 | 1 | 0 |
## Common
### Interfaces
<DocDefinitionList data={kbnCoreI18nServerObj.common.interfaces}/>

152
api_docs/kbn_core_i18n_server_internal.devdocs.json Normal file
View file

@ -0,0 +1,152 @@
{
"id": "@kbn/core-i18n-server-internal",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"parentPluginId": "@kbn/core-i18n-server-internal",
"id": "def-server.I18nService",
"type": "Class",
"tags": [],
"label": "I18nService",
"description": [],
"path": "packages/core/i18n/core-i18n-server-internal/src/i18n_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/core-i18n-server-internal",
"id": "def-server.I18nService.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "packages/core/i18n/core-i18n-server-internal/src/i18n_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/core-i18n-server-internal",
"id": "def-server.I18nService.Unnamed.$1",
"type": "Object",
"tags": [],
"label": "coreContext",
"description": [],
"signature": [
"CoreContext"
],
"path": "packages/core/i18n/core-i18n-server-internal/src/i18n_service.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/core-i18n-server-internal",
"id": "def-server.I18nService.preboot",
"type": "Function",
"tags": [],
"label": "preboot",
"description": [],
"signature": [
"({ pluginPaths, http }: ",
"PrebootDeps",
") => Promise<void>"
],
"path": "packages/core/i18n/core-i18n-server-internal/src/i18n_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/core-i18n-server-internal",
"id": "def-server.I18nService.preboot.$1",
"type": "Object",
"tags": [],
"label": "{ pluginPaths, http }",
"description": [],
"signature": [
"PrebootDeps"
],
"path": "packages/core/i18n/core-i18n-server-internal/src/i18n_service.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/core-i18n-server-internal",
"id": "def-server.I18nService.setup",
"type": "Function",
"tags": [],
"label": "setup",
"description": [],
"signature": [
"({ pluginPaths, http }: ",
"SetupDeps",
") => Promise<",
"I18nServiceSetup",
">"
],
"path": "packages/core/i18n/core-i18n-server-internal/src/i18n_service.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/core-i18n-server-internal",
"id": "def-server.I18nService.setup.$1",
"type": "Object",
"tags": [],
"label": "{ pluginPaths, http }",
"description": [],
"signature": [
"SetupDeps"
],
"path": "packages/core/i18n/core-i18n-server-internal/src/i18n_service.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/core-i18n-server-internal",
"id": "def-server.I18nConfigType",
"type": "Type",
"tags": [],
"label": "I18nConfigType",
"description": [],
"signature": [
"{ readonly locale: string; }"
],
"path": "packages/core/i18n/core-i18n-server-internal/src/i18n_config.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}

33
api_docs/kbn_core_i18n_server_internal.mdx Normal file
View file

@ -0,0 +1,33 @@
---
####
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
#### Reach out in #docs-engineering for more info.
####
id: kibKbnCoreI18nServerInternalPluginApi
slug: /kibana-dev-docs/api/kbn-core-i18n-server-internal
title: "@kbn/core-i18n-server-internal"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-i18n-server-internal plugin
date: 2022-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server-internal']
---
import kbnCoreI18nServerInternalObj from './kbn_core_i18n_server_internal.devdocs.json';
Contact Kibana Core for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 8 | 0 | 8 | 2 |
## Server
### Classes
<DocDefinitionList data={kbnCoreI18nServerInternalObj.server.classes}/>
### Consts, variables and types
<DocDefinitionList data={kbnCoreI18nServerInternalObj.server.misc}/>

73
api_docs/kbn_core_i18n_server_mocks.devdocs.json Normal file
View file

@ -0,0 +1,73 @@
{
"id": "@kbn/core-i18n-server-mocks",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [
{
"parentPluginId": "@kbn/core-i18n-server-mocks",
"id": "def-common.i18nServiceMock",
"type": "Object",
"tags": [],
"label": "i18nServiceMock",
"description": [],
"path": "packages/core/i18n/core-i18n-server-mocks/src/i18n_service.mock.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "@kbn/core-i18n-server-mocks",
"id": "def-common.i18nServiceMock.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [],
"signature": [
"() => jest.Mocked<I18nServiceContract>"
],
"path": "packages/core/i18n/core-i18n-server-mocks/src/i18n_service.mock.ts",
"deprecated": false,
"returnComment": [],
"children": []
},
{
"parentPluginId": "@kbn/core-i18n-server-mocks",
"id": "def-common.i18nServiceMock.createSetupContract",
"type": "Function",
"tags": [],
"label": "createSetupContract",
"description": [],
"signature": [
"() => jest.Mocked<",
"I18nServiceSetup",
">"
],
"path": "packages/core/i18n/core-i18n-server-mocks/src/i18n_service.mock.ts",
"deprecated": false,
"returnComment": [],
"children": []
}
],
"initialIsOpen": false
}
]
}
}

30
api_docs/kbn_core_i18n_server_mocks.mdx Normal file
View file

@ -0,0 +1,30 @@
---
####
#### This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
#### Reach out in #docs-engineering for more info.
####
id: kibKbnCoreI18nServerMocksPluginApi
slug: /kibana-dev-docs/api/kbn-core-i18n-server-mocks
title: "@kbn/core-i18n-server-mocks"
image: https://source.unsplash.com/400x175/?github
description: API docs for the @kbn/core-i18n-server-mocks plugin
date: 2022-09-01
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-server-mocks']
---
import kbnCoreI18nServerMocksObj from './kbn_core_i18n_server_mocks.devdocs.json';
Contact Kibana Core for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 3 | 0 | 3 | 0 |
## Common
### Objects
<DocDefinitionList data={kbnCoreI18nServerMocksObj.common.objects}/>

11
api_docs/plugin_directory.mdx
View file

@ -15,13 +15,13 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| Count | Plugins or Packages with a <br /> public API | Number of teams |
|--------------|----------|------------------------|
| 433 | 360 | 36 |
| 436 | 363 | 36 |
### Public API health stats
| API Count | Any Count | Missing comments | Missing exports |
|--------------|----------|-----------------|--------|
| 30377 | 180 | 20348 | 969 |
| 30392 | 180 | 20360 | 971 |
## Plugin Directory
@ -41,12 +41,12 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibCloudSecurityPosturePluginApi" text="cloudSecurityPosture"/> | [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-posture-security) | The cloud security posture plugin | 18 | 0 | 2 | 3 |
| <DocLink id="kibConsolePluginApi" text="console"/> | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 13 | 0 | 13 | 1 |
| <DocLink id="kibControlsPluginApi" text="controls"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 204 | 0 | 196 | 7 |
| <DocLink id="kibCorePluginApi" text="core"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2656 | 1 | 101 | 3 |
| <DocLink id="kibCorePluginApi" text="core"/> | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2656 | 1 | 100 | 3 |
| crossClusterReplication | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 |
| <DocLink id="kibCustomIntegrationsPluginApi" text="customIntegrations"/> | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 102 | 0 | 83 | 1 |
| <DocLink id="kibDashboardPluginApi" text="dashboard"/> | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 146 | 0 | 141 | 12 |
| <DocLink id="kibDashboardEnhancedPluginApi" text="dashboardEnhanced"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 52 | 0 | 51 | 0 |
| <DocLink id="kibDataPluginApi" text="data"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3130 | 34 | 2440 | 23 |
| <DocLink id="kibDataPluginApi" text="data"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3131 | 34 | 2441 | 23 |
| <DocLink id="kibDataViewEditorPluginApi" text="dataViewEditor"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | This plugin provides the ability to create data views via a modal flyout inside Kibana apps | 15 | 0 | 7 | 0 |
| <DocLink id="kibDataViewFieldEditorPluginApi" text="dataViewFieldEditor"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Reusable data view field editor across Kibana | 49 | 0 | 29 | 3 |
| <DocLink id="kibDataViewManagementPluginApi" text="dataViewManagement"/> | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data view management app | 2 | 0 | 2 | 0 |
@ -258,6 +258,9 @@ tags: ['contributor', 'dev', 'apidocs', 'kibana']
| <DocLink id="kibKbnCoreHttpServerMocksPluginApi" text="@kbn/core-http-server-mocks"/> | Kibana Core | - | 41 | 0 | 37 | 0 |
| <DocLink id="kibKbnCoreI18nBrowserPluginApi" text="@kbn/core-i18n-browser"/> | Kibana Core | - | 4 | 0 | 2 | 0 |
| <DocLink id="kibKbnCoreI18nBrowserMocksPluginApi" text="@kbn/core-i18n-browser-mocks"/> | Kibana Core | - | 3 | 0 | 3 | 0 |
| <DocLink id="kibKbnCoreI18nServerPluginApi" text="@kbn/core-i18n-server"/> | Kibana Core | - | 3 | 0 | 1 | 0 |
| <DocLink id="kibKbnCoreI18nServerInternalPluginApi" text="@kbn/core-i18n-server-internal"/> | Kibana Core | - | 8 | 0 | 8 | 2 |
| <DocLink id="kibKbnCoreI18nServerMocksPluginApi" text="@kbn/core-i18n-server-mocks"/> | Kibana Core | - | 3 | 0 | 3 | 0 |
| <DocLink id="kibKbnCoreInjectedMetadataBrowserPluginApi" text="@kbn/core-injected-metadata-browser"/> | Kibana Core | - | 8 | 2 | 6 | 0 |
| <DocLink id="kibKbnCoreInjectedMetadataBrowserMocksPluginApi" text="@kbn/core-injected-metadata-browser-mocks"/> | Kibana Core | - | 4 | 0 | 4 | 0 |
| <DocLink id="kibKbnCoreIntegrationsBrowserInternalPluginApi" text="@kbn/core-integrations-browser-internal"/> | Kibana Core | - | 2 | 0 | 2 | 0 |