Skip to content

Commit

Permalink
[api-docs] 2023-08-31 Daily api_docs build (elastic#165285)
Browse files Browse the repository at this point in the history 
Generated by
https://buildkite.com/elastic/kibana-api-docs-daily/builds/446
  • Loading branch information
@kibanamachine
kibanamachine authored Aug 31, 2023
1 parent 0af40a3 commit 9cd6a4a
Show file tree
Hide file tree
Showing 580 changed files with 1,188 additions and 644 deletions.
16 changes: 5 additions & 11 deletions api_docs/actions.devdocs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3247,9 +3247,7 @@
"section": "def-common.ActionTypeExecutorResult",
"text": "ActionTypeExecutorResult"
},
"<unknown>>; enqueueExecution: (options: ",
"ExecuteOptions",
") => Promise<void>; bulkEnqueueExecution: (options: ",
"<unknown>>; bulkEnqueueExecution: (options: ",
"ExecuteOptions",
"[]) => Promise<void>; ephemeralEnqueuedExecution: (options: ",
"ExecuteOptions",
Expand All @@ -3261,14 +3259,10 @@
"section": "def-server.RunNowResult",
"text": "RunNowResult"
},
">; listTypes: ({ featureId, includeSystemActionTypes, }?: ListTypesOptions) => Promise<",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.ActionType",
"text": "ActionType"
},
">; listTypes: ({ featureId, includeSystemActionTypes, }?: ",
"ListTypesParams",
") => Promise<",
"ConnectorType",
"[]>; isActionTypeEnabled: (actionTypeId: string, options?: { notifyUsage: boolean; }) => boolean; isPreconfigured: (connectorId: string) => boolean; isSystemAction: (connectorId: string) => boolean; getGlobalExecutionLogWithAuth: ({ dateStart, dateEnd, filter, page, perPage, sort, namespaces, }: ",
{
"pluginId": "actions",
Expand Down
4 changes: 2 additions & 2 deletions api_docs/actions.mdx
View file
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: 2023-08-30
date: 2023-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
---
import actionsObj from './actions.devdocs.json';
Expand All @@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 267 | 0 | 261 | 28 |
| 267 | 0 | 261 | 30 |

## Client

Expand Down
2 changes: 1 addition & 1 deletion api_docs/advanced_settings.mdx
View file
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: 2023-08-30
date: 2023-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
---
import advancedSettingsObj from './advanced_settings.devdocs.json';
Expand Down
2 changes: 1 addition & 1 deletion api_docs/aiops.mdx
View file
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: 2023-08-30
date: 2023-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
---
import aiopsObj from './aiops.devdocs.json';
Expand Down
191 changes: 185 additions & 6 deletions api_docs/alerting.devdocs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -900,7 +900,9 @@
"\nInstalls index template that uses installed component template\nPrior to installation, simulates the installation to check for possible\nconflicts. Simulate should return an empty mapping if a template\nconflicts with an already installed template."
],
"signature": [
"({ logger, esClient, indexPatterns, totalFieldsLimit, }: CreateConcreteWriteIndexOpts) => Promise<void>"
"(opts: ",
"CreateConcreteWriteIndexOpts",
") => Promise<void>"
],
"path": "x-pack/plugins/alerting/server/alerts_service/lib/create_concrete_write_index.ts",
"deprecated": false,
Expand All @@ -911,7 +913,7 @@
"id": "def-server.createConcreteWriteIndex.$1",
"type": "Object",
"tags": [],
"label": "{\n logger,\n esClient,\n indexPatterns,\n totalFieldsLimit,\n}",
"label": "opts",
"description": [],
"signature": [
"CreateConcreteWriteIndexOpts"
Expand Down Expand Up @@ -968,7 +970,7 @@
"\nCreates ILM policy if it doesn't already exist, updates it if it does"
],
"signature": [
"({ logger, esClient, name, policy, }: CreateOrUpdateIlmPolicyOpts) => Promise<void>"
"({ logger, esClient, name, policy, dataStreamAdapter, }: CreateOrUpdateIlmPolicyOpts) => Promise<void>"
],
"path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_ilm_policy.ts",
"deprecated": false,
Expand All @@ -979,7 +981,7 @@
"id": "def-server.createOrUpdateIlmPolicy.$1",
"type": "Object",
"tags": [],
"label": "{\n logger,\n esClient,\n name,\n policy,\n}",
"label": "{\n logger,\n esClient,\n name,\n policy,\n dataStreamAdapter,\n}",
"description": [],
"signature": [
"CreateOrUpdateIlmPolicyOpts"
Expand Down Expand Up @@ -1062,6 +1064,48 @@
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.getDataStreamAdapter",
"type": "Function",
"tags": [],
"label": "getDataStreamAdapter",
"description": [],
"signature": [
"(opts: ",
"GetDataStreamAdapterOpts",
") => ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.DataStreamAdapter",
"text": "DataStreamAdapter"
}
],
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-server.getDataStreamAdapter.$1",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
"GetDataStreamAdapterOpts"
],
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.getEsErrorMessage",
Expand Down Expand Up @@ -1105,7 +1149,7 @@
"label": "getIndexTemplate",
"description": [],
"signature": [
"({ componentTemplateRefs, ilmPolicyName, indexPatterns, kibanaVersion, namespace, totalFieldsLimit, }: GetIndexTemplateOpts) => ",
"({ componentTemplateRefs, ilmPolicyName, indexPatterns, kibanaVersion, namespace, totalFieldsLimit, dataStreamAdapter, }: GetIndexTemplateOpts) => ",
"IndicesPutIndexTemplateRequest"
],
"path": "x-pack/plugins/alerting/server/alerts_service/lib/create_or_update_index_template.ts",
Expand All @@ -1117,7 +1161,7 @@
"id": "def-server.getIndexTemplate.$1",
"type": "Object",
"tags": [],
"label": "{\n componentTemplateRefs,\n ilmPolicyName,\n indexPatterns,\n kibanaVersion,\n namespace,\n totalFieldsLimit,\n}",
"label": "{\n componentTemplateRefs,\n ilmPolicyName,\n indexPatterns,\n kibanaVersion,\n namespace,\n totalFieldsLimit,\n dataStreamAdapter,\n}",
"description": [],
"signature": [
"GetIndexTemplateOpts"
Expand Down Expand Up @@ -1517,6 +1561,118 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.DataStreamAdapter",
"type": "Interface",
"tags": [],
"label": "DataStreamAdapter",
"description": [],
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-server.DataStreamAdapter.isUsingDataStreams",
"type": "Function",
"tags": [],
"label": "isUsingDataStreams",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "alerting",
"id": "def-server.DataStreamAdapter.getIndexTemplateFields",
"type": "Function",
"tags": [],
"label": "getIndexTemplateFields",
"description": [],
"signature": [
"(alias: string, pattern: string) => ",
"IndexTemplateFields"
],
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-server.DataStreamAdapter.getIndexTemplateFields.$1",
"type": "string",
"tags": [],
"label": "alias",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "alerting",
"id": "def-server.DataStreamAdapter.getIndexTemplateFields.$2",
"type": "string",
"tags": [],
"label": "pattern",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "alerting",
"id": "def-server.DataStreamAdapter.createStream",
"type": "Function",
"tags": [],
"label": "createStream",
"description": [],
"signature": [
"(opts: ",
"CreateConcreteWriteIndexOpts",
") => Promise<void>"
],
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "alerting",
"id": "def-server.DataStreamAdapter.createStream.$1",
"type": "Object",
"tags": [],
"label": "opts",
"description": [],
"signature": [
"CreateConcreteWriteIndexOpts"
],
"path": "x-pack/plugins/alerting/server/alerts_service/lib/data_stream_adapter.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "alerting",
"id": "def-server.FindResult",
Expand Down Expand Up @@ -1996,6 +2152,29 @@
"path": "x-pack/plugins/alerting/server/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "alerting",
"id": "def-server.PluginSetupContract.getDataStreamAdapter",
"type": "Function",
"tags": [],
"label": "getDataStreamAdapter",
"description": [],
"signature": [
"() => ",
{
"pluginId": "alerting",
"scope": "server",
"docId": "kibAlertingPluginApi",
"section": "def-server.DataStreamAdapter",
"text": "DataStreamAdapter"
}
],
"path": "x-pack/plugins/alerting/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
Expand Down
4 changes: 2 additions & 2 deletions api_docs/alerting.mdx
View file
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: 2023-08-30
date: 2023-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';
Expand All @@ -21,7 +21,7 @@ Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-o

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 780 | 1 | 749 | 46 |
| 790 | 1 | 759 | 49 |

## Client

Expand Down
26 changes: 24 additions & 2 deletions api_docs/apm.devdocs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,27 @@
"section": "def-common.NonEmptyStringBrand",
"text": "NonEmptyStringBrand"
},
">]>; }>]>; }> | undefined; handler: ({}: ",
">]>; healthStatus: ",
"ArrayC",
"<",
"UnionC",
"<[",
"LiteralC",
"<",
"ServiceHealthStatus",
".unknown>, ",
"LiteralC",
"<",
"ServiceHealthStatus",
".healthy>, ",
"LiteralC",
"<",
"ServiceHealthStatus",
".warning>, ",
"LiteralC",
"<",
"ServiceHealthStatus",
".critical>]>>; }>]>; }> | undefined; handler: ({}: ",
"APMRouteHandlerResources",
" & { params: { query: { start: string; end: string; } & { 'service.environment'?: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ",
"Branded",
Expand All @@ -497,7 +517,9 @@
"section": "def-common.NonEmptyStringBrand",
"text": "NonEmptyStringBrand"
},
"> | undefined; }; }; }) => Promise<{ content: ApmServicesListContent; }>; } & ",
"> | undefined; healthStatus?: ",
"ServiceHealthStatus",
"[] | undefined; }; }; }) => Promise<{ content: ApmServicesListContent; }>; } & ",
"APMRouteCreateOptions",
"; \"GET /internal/apm/assistant/get_downstream_dependencies\": { endpoint: \"GET /internal/apm/assistant/get_downstream_dependencies\"; params?: ",
"TypeC",
Expand Down
4 changes: 2 additions & 2 deletions api_docs/apm.mdx
View file
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: 2023-08-30
date: 2023-08-31
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
---
import apmObj from './apm.devdocs.json';
Expand All @@ -21,7 +21,7 @@ Contact [@elastic/apm-ui](https://github.com/orgs/elastic/teams/apm-ui) for ques

| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 29 | 0 | 29 | 118 |
| 29 | 0 | 29 | 119 |

## Client

Expand Down
Loading

0 comments on commit 9cd6a4a

Please sign in to comment.