mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
[api-docs] Daily api_docs build (#137246)
This commit is contained in:
Kibana Machine
GitHub
parent
5677d16c00
commit
c572e3e2a3
372 changed files with 19260 additions and 16343 deletions
|
|
@ -1572,6 +1572,20 @@
|
|||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "actions",
|
||||
"id": "def-server.ActionParamsType",
|
||||
"type": "Type",
|
||||
"tags": [],
|
||||
"label": "ActionParamsType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ readonly subAction: \"pushToService\"; readonly subActionParams: Readonly<{} & { incident: Readonly<{} & { title: string; description: string | null; tags: string[] | null; externalId: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }"
|
||||
],
|
||||
"path": "x-pack/plugins/actions/server/builtin_action_types/cases_webhook/index.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "actions",
|
||||
"id": "def-server.ActionParamsType",
|
||||
|
|
@ -1664,7 +1678,7 @@
|
|||
"label": "ActionParamsType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; severity: string | null; externalId: string | null; urgency: string | null; impact: string | null; short_description: string; subcategory: string | null; correlation_id: string | null; correlation_display: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }> | Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; externalId: string | null; short_description: string; subcategory: string | null; correlation_id: string | null; correlation_display: string | null; dest_ip: string | string[] | null; malware_hash: string | string[] | null; malware_url: string | string[] | null; source_ip: string | string[] | null; priority: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }>"
|
||||
"Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; externalId: string | null; severity: string | null; urgency: string | null; impact: string | null; short_description: string; subcategory: string | null; correlation_id: string | null; correlation_display: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }> | Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; externalId: string | null; short_description: string; subcategory: string | null; correlation_id: string | null; correlation_display: string | null; dest_ip: string | string[] | null; malware_hash: string | string[] | null; malware_url: string | string[] | null; source_ip: string | string[] | null; priority: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }>"
|
||||
],
|
||||
"path": "x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -1756,7 +1770,7 @@
|
|||
},
|
||||
"<",
|
||||
"ActionTypeConfig",
|
||||
">>; delete: ({ id }: { id: string; }) => Promise<{}>; get: ({ id }: { id: string; }) => Promise<",
|
||||
">>; get: ({ id }: { id: string; }) => Promise<",
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"scope": "server",
|
||||
|
|
@ -1778,7 +1792,7 @@
|
|||
},
|
||||
"<",
|
||||
"ActionTypeConfig",
|
||||
">>; getAll: () => Promise<",
|
||||
">>; delete: ({ id }: { id: string; }) => Promise<{}>; getAll: () => Promise<",
|
||||
{
|
||||
"pluginId": "actions",
|
||||
"scope": "server",
|
||||
|
|
@ -1824,6 +1838,20 @@
|
|||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "actions",
|
||||
"id": "def-server.ActionTypeId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "ActionTypeId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\".cases-webhook\""
|
||||
],
|
||||
"path": "x-pack/plugins/actions/server/builtin_action_types/cases_webhook/index.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "actions",
|
||||
"id": "def-server.ActionTypeId",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/actions
|
|||
title: "actions"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the actions plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Response Ops](https://github.com/orgs/elastic/teams/response-ops) for q
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 264 | 0 | 259 | 19 |
|
||||
| 266 | 0 | 261 | 19 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/advancedSettings
|
|||
title: "advancedSettings"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the advancedSettings plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/aiops
|
|||
title: "aiops"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the aiops plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'aiops']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1859,331 +1859,7 @@
|
|||
"label": "savedObjectsClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
"SavedObject",
|
||||
"<T>>; bulkCreate: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkCreateObject",
|
||||
"text": "SavedObjectsBulkCreateObject"
|
||||
},
|
||||
"<T>[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResponse",
|
||||
"text": "SavedObjectsBulkResponse"
|
||||
},
|
||||
"<T>>; checkConflicts: (objects?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCheckConflictsObject",
|
||||
"text": "SavedObjectsCheckConflictsObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCheckConflictsResponse",
|
||||
"text": "SavedObjectsCheckConflictsResponse"
|
||||
},
|
||||
">; delete: (type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsDeleteOptions",
|
||||
"text": "SavedObjectsDeleteOptions"
|
||||
},
|
||||
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkGetObject",
|
||||
"text": "SavedObjectsBulkGetObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResponse",
|
||||
"text": "SavedObjectsBulkResponse"
|
||||
},
|
||||
"<T>>; bulkResolve: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResolveObject",
|
||||
"text": "SavedObjectsBulkResolveObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResolveResponse",
|
||||
"text": "SavedObjectsBulkResolveResponse"
|
||||
},
|
||||
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
"SavedObject",
|
||||
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsResolveResponse",
|
||||
"text": "SavedObjectsResolveResponse"
|
||||
},
|
||||
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"<T>) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"<T>>; collectMultiNamespaceReferences: (objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
|
||||
},
|
||||
">; updateObjectsSpaces: (objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesObject"
|
||||
},
|
||||
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesResponse"
|
||||
},
|
||||
">; bulkUpdate: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateObject",
|
||||
"text": "SavedObjectsBulkUpdateObject"
|
||||
},
|
||||
"<T>[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateOptions",
|
||||
"text": "SavedObjectsBulkUpdateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateResponse",
|
||||
"text": "SavedObjectsBulkUpdateResponse"
|
||||
},
|
||||
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
|
||||
"text": "SavedObjectsRemoveReferencesToOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
|
||||
"text": "SavedObjectsRemoveReferencesToResponse"
|
||||
},
|
||||
">; openPointInTimeForType: (type: string | string[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
|
||||
"text": "SavedObjectsOpenPointInTimeOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
|
||||
"text": "SavedObjectsOpenPointInTimeResponse"
|
||||
},
|
||||
">; closePointInTime: (id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClosePointInTimeResponse",
|
||||
"text": "SavedObjectsClosePointInTimeResponse"
|
||||
},
|
||||
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreatePointInTimeFinderOptions",
|
||||
"text": "SavedObjectsCreatePointInTimeFinderOptions"
|
||||
},
|
||||
", dependencies?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
||||
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
|
||||
},
|
||||
" | undefined) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.ISavedObjectsPointInTimeFinder",
|
||||
"text": "ISavedObjectsPointInTimeFinder"
|
||||
},
|
||||
"<T, A>; errors: typeof ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsErrorHelpers",
|
||||
"text": "SavedObjectsErrorHelpers"
|
||||
},
|
||||
"; }"
|
||||
"SavedObjectsClientContract"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -2915,7 +2591,7 @@
|
|||
"section": "def-common.SanitizedRule",
|
||||
"text": "SanitizedRule"
|
||||
},
|
||||
"<Params>>; delete: ({ id }: { id: string; }) => Promise<{}>; find: <Params extends ",
|
||||
"<Params>>; find: <Params extends ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
|
|
@ -2941,7 +2617,7 @@
|
|||
"section": "def-common.RuleTypeParams",
|
||||
"text": "RuleTypeParams"
|
||||
},
|
||||
" = never>({ id, includeLegacyId, excludeFromPublicApi, }: { id: string; includeLegacyId?: boolean | undefined; excludeFromPublicApi?: boolean | undefined; }) => Promise<",
|
||||
" = never>({ id, includeLegacyId, includeSnoozeData, excludeFromPublicApi, }: { id: string; includeLegacyId?: boolean | undefined; includeSnoozeData?: boolean | undefined; excludeFromPublicApi?: boolean | undefined; }) => Promise<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
|
|
@ -2951,22 +2627,6 @@
|
|||
},
|
||||
"<Params> | ",
|
||||
"SanitizedRuleWithLegacyId",
|
||||
"<Params>>; resolve: <Params extends ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleTypeParams",
|
||||
"text": "RuleTypeParams"
|
||||
},
|
||||
" = never>({ id, includeLegacyId, }: { id: string; includeLegacyId?: boolean | undefined; }) => Promise<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.ResolvedSanitizedRule",
|
||||
"text": "ResolvedSanitizedRule"
|
||||
},
|
||||
"<Params>>; update: <Params extends ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
|
|
@ -2985,6 +2645,22 @@
|
|||
"section": "def-server.PartialRule",
|
||||
"text": "PartialRule"
|
||||
},
|
||||
"<Params>>; delete: ({ id }: { id: string; }) => Promise<{}>; resolve: <Params extends ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleTypeParams",
|
||||
"text": "RuleTypeParams"
|
||||
},
|
||||
" = never>({ id, includeLegacyId, }: { id: string; includeLegacyId?: boolean | undefined; }) => Promise<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.ResolvedSanitizedRule",
|
||||
"text": "ResolvedSanitizedRule"
|
||||
},
|
||||
"<Params>>; enable: ({ id }: { id: string; }) => Promise<void>; disable: ({ id }: { id: string; }) => Promise<void>; muteAll: ({ id }: { id: string; }) => Promise<void>; getAlertState: ({ id }: { id: string; }) => Promise<void | { alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; }>; getAlertSummary: ({ id, dateStart, numberOfExecutions, }: ",
|
||||
"GetAlertSummaryParams",
|
||||
") => Promise<",
|
||||
|
|
@ -3055,7 +2731,15 @@
|
|||
"section": "def-common.RuleSnoozeSchedule",
|
||||
"text": "RuleSnoozeSchedule"
|
||||
},
|
||||
"; }) => Promise<void>; unsnooze: ({ id, scheduleIds, }: { id: string; scheduleIds?: string[] | undefined; }) => Promise<void>; updateSnoozedUntilTime: ({ id }: { id: string; }) => Promise<void>; clearExpiredSnoozes: ({ id }: { id: string; }) => Promise<void>; unmuteAll: ({ id }: { id: string; }) => Promise<void>; muteInstance: ({ alertId, alertInstanceId }: ",
|
||||
"; }) => Promise<void>; unsnooze: ({ id, scheduleIds, }: { id: string; scheduleIds?: string[] | undefined; }) => Promise<void>; calculateIsSnoozedUntil: (rule: { muteAll: boolean; snoozeSchedule?: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.RuleSnooze",
|
||||
"text": "RuleSnooze"
|
||||
},
|
||||
" | undefined; }) => string | null; clearExpiredSnoozes: ({ id }: { id: string; }) => Promise<void>; unmuteAll: ({ id }: { id: string; }) => Promise<void>; muteInstance: ({ alertId, alertInstanceId }: ",
|
||||
"MuteOptions",
|
||||
") => Promise<void>; unmuteInstance: ({ alertId, alertInstanceId }: ",
|
||||
"MuteOptions",
|
||||
|
|
@ -5936,13 +5620,7 @@
|
|||
"text": "SanitizedRule"
|
||||
},
|
||||
"<Params> & Omit<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsResolveResponse",
|
||||
"text": "SavedObjectsResolveResponse"
|
||||
},
|
||||
"SavedObjectsResolveResponse",
|
||||
"<unknown>, \"saved_object\">"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/common/rule.ts",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/alerting
|
|||
title: "alerting"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the alerting plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@
|
|||
"section": "def-common.LocatorPublic",
|
||||
"text": "LocatorPublic"
|
||||
},
|
||||
"<{ serviceName: undefined; } | ({ serviceName: string; } & { serviceOverviewTab?: \"metrics\" | \"errors\" | \"logs\" | \"traces\" | undefined; } & { query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ",
|
||||
"<{ serviceName: undefined; } | ({ serviceName: string; } & { serviceOverviewTab?: \"metrics\" | \"logs\" | \"traces\" | \"errors\" | undefined; } & { query: { environment: \"ENVIRONMENT_NOT_DEFINED\" | \"ENVIRONMENT_ALL\" | ",
|
||||
"Branded",
|
||||
"<string, ",
|
||||
"NonEmptyStringBrand",
|
||||
|
|
@ -4898,7 +4898,25 @@
|
|||
"TypeC",
|
||||
"<{ percentileThreshold: ",
|
||||
"Type",
|
||||
"<number, unknown, unknown>; }>]>; }>, ",
|
||||
"<number, unknown, unknown>; chartType: ",
|
||||
"UnionC",
|
||||
"<[",
|
||||
"LiteralC",
|
||||
"<",
|
||||
"LatencyDistributionChartType",
|
||||
".transactionLatency>, ",
|
||||
"LiteralC",
|
||||
"<",
|
||||
"LatencyDistributionChartType",
|
||||
".latencyCorrelations>, ",
|
||||
"LiteralC",
|
||||
"<",
|
||||
"LatencyDistributionChartType",
|
||||
".failedTransactionsCorrelations>, ",
|
||||
"LiteralC",
|
||||
"<",
|
||||
"LatencyDistributionChartType",
|
||||
".dependencyLatency>]>; }>]>; }>, ",
|
||||
{
|
||||
"pluginId": "apm",
|
||||
"scope": "server",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/apm
|
|||
title: "apm"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the apm plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apm']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [APM UI](https://github.com/orgs/elastic/teams/apm-ui) for questions reg
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 40 | 0 | 40 | 53 |
|
||||
| 40 | 0 | 40 | 54 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/banners
|
|||
title: "banners"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the banners plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/bfetch
|
|||
title: "bfetch"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the bfetch plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/canvas
|
|||
title: "canvas"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the canvas plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1411,6 +1411,8 @@
|
|||
},
|
||||
"; tags: string[]; title: string; connector: { id: string; type: ",
|
||||
"ConnectorTypes",
|
||||
".casesWebhook; fields: null; name: string; } | { id: string; type: ",
|
||||
"ConnectorTypes",
|
||||
".jira; fields: { issueType: string | null; priority: string | null; parent: string | null; } | null; name: string; } | { id: string; type: ",
|
||||
"ConnectorTypes",
|
||||
".none; fields: null; name: string; } | { id: string; type: ",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cases
|
|||
title: "cases"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the cases plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cases']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/charts
|
|||
title: "charts"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the charts plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloud
|
|||
title: "cloud"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the cloud plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/cloudSecurityPosture
|
|||
title: "cloudSecurityPosture"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the cloudSecurityPosture plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloudSecurityPosture']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/console
|
|||
title: "console"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the console plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/controls
|
|||
title: "controls"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the controls plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'controls']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core
|
|||
title: "core"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the core plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2474 | 5 | 648 | 16 |
|
||||
| 2498 | 2 | 413 | 8 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-application
|
|||
title: "core.application"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the core.application plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2474 | 5 | 648 | 16 |
|
||||
| 2498 | 2 | 413 | 8 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-chrome
|
|||
title: "core.chrome"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the core.chrome plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2474 | 5 | 648 | 16 |
|
||||
| 2498 | 2 | 413 | 8 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/core-savedObjects
|
|||
title: "core.savedObjects"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the core.savedObjects plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,13 +18,10 @@ Contact [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) for que
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2474 | 5 | 648 | 16 |
|
||||
| 2498 | 2 | 413 | 8 |
|
||||
|
||||
## Client
|
||||
|
||||
### Classes
|
||||
<DocDefinitionList data={coreSavedObjectsObj.client.classes}/>
|
||||
|
||||
### Interfaces
|
||||
<DocDefinitionList data={coreSavedObjectsObj.client.interfaces}/>
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/customIntegrations
|
|||
title: "customIntegrations"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the customIntegrations plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'customIntegrations']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2377,13 +2377,7 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"(savedObjectClient: Pick<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.ISavedObjectsRepository",
|
||||
"text": "ISavedObjectsRepository"
|
||||
},
|
||||
"ISavedObjectsRepository",
|
||||
", \"find\">, embeddableType: string) => Promise<{ [key: string]: ",
|
||||
"Serializable",
|
||||
"; }[]>"
|
||||
|
|
@ -2400,13 +2394,7 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.ISavedObjectsRepository",
|
||||
"text": "ISavedObjectsRepository"
|
||||
},
|
||||
"ISavedObjectsRepository",
|
||||
", \"find\">"
|
||||
],
|
||||
"path": "src/plugins/dashboard/server/usage/find_by_value_embeddables.ts",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboard
|
|||
title: "dashboard"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dashboard plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dashboardEnhanced
|
|||
title: "dashboardEnhanced"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dashboardEnhanced plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -3641,7 +3641,6 @@
|
|||
],
|
||||
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
||||
"deprecated": true,
|
||||
"removeBy": "8.1",
|
||||
"references": [
|
||||
{
|
||||
"plugin": "stackAlerts",
|
||||
|
|
@ -7855,7 +7854,7 @@
|
|||
"SavedObject",
|
||||
"<T>"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
|
|
@ -7867,7 +7866,7 @@
|
|||
"description": [
|
||||
"The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -7879,7 +7878,7 @@
|
|||
"description": [
|
||||
" The type of Saved Object. Each plugin can define it's own custom Saved Object types."
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -7894,7 +7893,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -7909,7 +7908,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -7923,7 +7922,7 @@
|
|||
"SavedObjectError",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -7938,7 +7937,7 @@
|
|||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -7954,7 +7953,7 @@
|
|||
"SavedObjectReference",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -7970,7 +7969,7 @@
|
|||
"SavedObjectsMigrationVersion",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -7985,7 +7984,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -8000,7 +7999,7 @@
|
|||
"signature": [
|
||||
"string[] | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -8015,7 +8014,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
|
|
@ -8049,7 +8048,7 @@
|
|||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.SearchSourceFields.query",
|
||||
"type": "Object",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [
|
||||
|
|
@ -8057,6 +8056,8 @@
|
|||
],
|
||||
"signature": [
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/common/search/search_source/types.ts",
|
||||
|
|
@ -8764,8 +8765,12 @@
|
|||
"[] | undefined; query?: ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | (",
|
||||
"Query",
|
||||
"[] | undefined; timeRange?: ",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
")[] | undefined; timeRange?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
|
|
@ -9528,6 +9533,8 @@
|
|||
"Filter",
|
||||
"[] | undefined; query?: ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | undefined; }"
|
||||
],
|
||||
"path": "src/plugins/data/common/query/query_state.ts",
|
||||
|
|
@ -9558,6 +9565,8 @@
|
|||
"signature": [
|
||||
"{ type?: string | undefined; query?: ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | undefined; filter?: ",
|
||||
"Filter",
|
||||
"[] | undefined; sort?: ",
|
||||
|
|
@ -14844,13 +14853,7 @@
|
|||
],
|
||||
"signature": [
|
||||
"(savedObjectsClient: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClientContract",
|
||||
"text": "SavedObjectsClientContract"
|
||||
},
|
||||
"SavedObjectsClientContract",
|
||||
", elasticsearchClient: ",
|
||||
"ElasticsearchClient",
|
||||
", request?: ",
|
||||
|
|
@ -14877,331 +14880,7 @@
|
|||
"label": "savedObjectsClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
"SavedObject",
|
||||
"<T>>; bulkCreate: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkCreateObject",
|
||||
"text": "SavedObjectsBulkCreateObject"
|
||||
},
|
||||
"<T>[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResponse",
|
||||
"text": "SavedObjectsBulkResponse"
|
||||
},
|
||||
"<T>>; checkConflicts: (objects?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCheckConflictsObject",
|
||||
"text": "SavedObjectsCheckConflictsObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCheckConflictsResponse",
|
||||
"text": "SavedObjectsCheckConflictsResponse"
|
||||
},
|
||||
">; delete: (type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsDeleteOptions",
|
||||
"text": "SavedObjectsDeleteOptions"
|
||||
},
|
||||
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkGetObject",
|
||||
"text": "SavedObjectsBulkGetObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResponse",
|
||||
"text": "SavedObjectsBulkResponse"
|
||||
},
|
||||
"<T>>; bulkResolve: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResolveObject",
|
||||
"text": "SavedObjectsBulkResolveObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResolveResponse",
|
||||
"text": "SavedObjectsBulkResolveResponse"
|
||||
},
|
||||
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
"SavedObject",
|
||||
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsResolveResponse",
|
||||
"text": "SavedObjectsResolveResponse"
|
||||
},
|
||||
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"<T>) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"<T>>; collectMultiNamespaceReferences: (objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
|
||||
},
|
||||
">; updateObjectsSpaces: (objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesObject"
|
||||
},
|
||||
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesResponse"
|
||||
},
|
||||
">; bulkUpdate: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateObject",
|
||||
"text": "SavedObjectsBulkUpdateObject"
|
||||
},
|
||||
"<T>[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateOptions",
|
||||
"text": "SavedObjectsBulkUpdateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateResponse",
|
||||
"text": "SavedObjectsBulkUpdateResponse"
|
||||
},
|
||||
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
|
||||
"text": "SavedObjectsRemoveReferencesToOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
|
||||
"text": "SavedObjectsRemoveReferencesToResponse"
|
||||
},
|
||||
">; openPointInTimeForType: (type: string | string[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
|
||||
"text": "SavedObjectsOpenPointInTimeOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
|
||||
"text": "SavedObjectsOpenPointInTimeResponse"
|
||||
},
|
||||
">; closePointInTime: (id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClosePointInTimeResponse",
|
||||
"text": "SavedObjectsClosePointInTimeResponse"
|
||||
},
|
||||
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreatePointInTimeFinderOptions",
|
||||
"text": "SavedObjectsCreatePointInTimeFinderOptions"
|
||||
},
|
||||
", dependencies?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
||||
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
|
||||
},
|
||||
" | undefined) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.ISavedObjectsPointInTimeFinder",
|
||||
"text": "ISavedObjectsPointInTimeFinder"
|
||||
},
|
||||
"<T, A>; errors: typeof ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsErrorHelpers",
|
||||
"text": "SavedObjectsErrorHelpers"
|
||||
},
|
||||
"; }"
|
||||
"SavedObjectsClientContract"
|
||||
],
|
||||
"path": "src/plugins/data_views/server/types.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -15308,32 +14987,6 @@
|
|||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"WriteResponseBase",
|
||||
">; }; delete: { (this: That, params: ",
|
||||
"DeleteRequest",
|
||||
" | ",
|
||||
"DeleteRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"WriteResponseBase",
|
||||
">; (this: That, params: ",
|
||||
"DeleteRequest",
|
||||
" | ",
|
||||
"DeleteRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"WriteResponseBase",
|
||||
", unknown>>; (this: That, params: ",
|
||||
"DeleteRequest",
|
||||
" | ",
|
||||
"DeleteRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"WriteResponseBase",
|
||||
">; }; get: { <TDocument = unknown>(this: That, params: ",
|
||||
"GetRequest",
|
||||
" | ",
|
||||
|
|
@ -15386,32 +15039,32 @@
|
|||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"UpdateResponse",
|
||||
"<TDocumentR>>; }; closePointInTime: { (this: That, params: ",
|
||||
"ClosePointInTimeRequest",
|
||||
"<TDocumentR>>; }; delete: { (this: That, params: ",
|
||||
"DeleteRequest",
|
||||
" | ",
|
||||
"ClosePointInTimeRequest",
|
||||
"DeleteRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"ClosePointInTimeResponse",
|
||||
"WriteResponseBase",
|
||||
">; (this: That, params: ",
|
||||
"ClosePointInTimeRequest",
|
||||
"DeleteRequest",
|
||||
" | ",
|
||||
"ClosePointInTimeRequest",
|
||||
"DeleteRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"ClosePointInTimeResponse",
|
||||
"WriteResponseBase",
|
||||
", unknown>>; (this: That, params: ",
|
||||
"ClosePointInTimeRequest",
|
||||
"DeleteRequest",
|
||||
" | ",
|
||||
"ClosePointInTimeRequest",
|
||||
"DeleteRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"ClosePointInTimeResponse",
|
||||
"WriteResponseBase",
|
||||
">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
|
||||
"default",
|
||||
"; helpers: ",
|
||||
|
|
@ -15482,6 +15135,32 @@
|
|||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"ClearScrollResponse",
|
||||
">; }; closePointInTime: { (this: That, params: ",
|
||||
"ClosePointInTimeRequest",
|
||||
" | ",
|
||||
"ClosePointInTimeRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"ClosePointInTimeResponse",
|
||||
">; (this: That, params: ",
|
||||
"ClosePointInTimeRequest",
|
||||
" | ",
|
||||
"ClosePointInTimeRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"ClosePointInTimeResponse",
|
||||
", unknown>>; (this: That, params: ",
|
||||
"ClosePointInTimeRequest",
|
||||
" | ",
|
||||
"ClosePointInTimeRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"ClosePointInTimeResponse",
|
||||
">; }; count: { (this: That, params?: ",
|
||||
"CountRequest",
|
||||
" | ",
|
||||
|
|
@ -22891,7 +22570,7 @@
|
|||
"SavedObject",
|
||||
"<T>"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
|
|
@ -22903,7 +22582,7 @@
|
|||
"description": [
|
||||
"The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -22915,7 +22594,7 @@
|
|||
"description": [
|
||||
" The type of Saved Object. Each plugin can define it's own custom Saved Object types."
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -22930,7 +22609,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -22945,7 +22624,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -22959,7 +22638,7 @@
|
|||
"SavedObjectError",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -22974,7 +22653,7 @@
|
|||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -22990,7 +22669,7 @@
|
|||
"SavedObjectReference",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -23006,7 +22685,7 @@
|
|||
"SavedObjectsMigrationVersion",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -23021,7 +22700,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -23036,7 +22715,7 @@
|
|||
"signature": [
|
||||
"string[] | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -23051,7 +22730,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
|
|
@ -23358,7 +23037,7 @@
|
|||
"section": "def-common.DataView",
|
||||
"text": "DataView"
|
||||
},
|
||||
">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<",
|
||||
">; find: (search: string, size?: number) => Promise<",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
|
|
@ -23374,7 +23053,7 @@
|
|||
"section": "def-common.DataView",
|
||||
"text": "DataView"
|
||||
},
|
||||
">; getCanSave: () => Promise<boolean>; getIds: (refresh?: boolean) => Promise<string[]>; getTitles: (refresh?: boolean) => Promise<string[]>; getIdsWithTitle: (refresh?: boolean) => Promise<",
|
||||
">; delete: (indexPatternId: string) => Promise<{}>; getCanSave: () => Promise<boolean>; getIds: (refresh?: boolean) => Promise<string[]>; getTitles: (refresh?: boolean) => Promise<string[]>; getIdsWithTitle: (refresh?: boolean) => Promise<",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data
|
|||
title: "data"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the data plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3094 | 34 | 2421 | 21 |
|
||||
| 3097 | 34 | 2420 | 21 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -2036,16 +2036,26 @@
|
|||
"signature": [
|
||||
"{ getDefaultQuery: () => { query: string; language: any; }; formatQuery: (query: string | ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | undefined) => ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
"; getUpdates$: () => ",
|
||||
"Observable",
|
||||
"<",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
">; getQuery: () => ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
"; setQuery: (query: ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
") => void; clearQuery: () => void; }"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/query_service.ts",
|
||||
|
|
@ -2190,16 +2200,26 @@
|
|||
"signature": [
|
||||
"{ getDefaultQuery: () => { query: string; language: any; }; formatQuery: (query: string | ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | undefined) => ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
"; getUpdates$: () => ",
|
||||
"Observable",
|
||||
"<",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
">; getQuery: () => ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
"; setQuery: (query: ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
") => void; clearQuery: () => void; }"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/query_service.ts",
|
||||
|
|
@ -3012,16 +3032,26 @@
|
|||
"signature": [
|
||||
"{ getDefaultQuery: () => { query: string; language: any; }; formatQuery: (query: string | ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | undefined) => ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
"; getUpdates$: () => ",
|
||||
"Observable",
|
||||
"<",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
">; getQuery: () => ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
"; setQuery: (query: ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
") => void; clearQuery: () => void; }"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/query_string/query_string_manager.ts",
|
||||
|
|
@ -3616,22 +3646,15 @@
|
|||
"\nConverts QueryState to expression AST"
|
||||
],
|
||||
"signature": [
|
||||
"({ filters, query, time }: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.QueryState",
|
||||
"text": "QueryState"
|
||||
},
|
||||
") => ",
|
||||
"({\n filters,\n query,\n inputQuery,\n time,\n dataViewsService,\n}: Args) => Promise<",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExpressionAstExpressionBuilder",
|
||||
"text": "ExpressionAstExpressionBuilder"
|
||||
}
|
||||
"section": "def-common.ExpressionAstExpression",
|
||||
"text": "ExpressionAstExpression"
|
||||
},
|
||||
">"
|
||||
],
|
||||
"path": "src/plugins/data/common/query/to_expression_ast.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -3641,16 +3664,10 @@
|
|||
"id": "def-common.queryStateToExpressionAst.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "{ filters, query, time }",
|
||||
"label": "{\n filters,\n query,\n inputQuery,\n time,\n dataViewsService,\n}",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataQueryPluginApi",
|
||||
"section": "def-common.QueryState",
|
||||
"text": "QueryState"
|
||||
}
|
||||
"Args"
|
||||
],
|
||||
"path": "src/plugins/data/common/query/to_expression_ast.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -3856,6 +3873,8 @@
|
|||
"Filter",
|
||||
"[] | undefined; query?: ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | undefined; }"
|
||||
],
|
||||
"path": "src/plugins/data/common/query/query_state.ts",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-query
|
|||
title: "data.query"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the data.query plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3094 | 34 | 2421 | 21 |
|
||||
| 3097 | 34 | 2420 | 21 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -323,32 +323,14 @@
|
|||
"signature": [
|
||||
"{ create: ({ name, appId, locatorId, initialState, restoreState, sessionId, }: { name: string; appId: string; locatorId: string; initialState: Record<string, unknown>; restoreState: Record<string, unknown>; sessionId: string; }) => Promise<",
|
||||
"SearchSessionSavedObject",
|
||||
">; delete: (sessionId: string) => Promise<void>; find: (options: Omit<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
">; find: (options: Omit<",
|
||||
"SavedObjectsFindOptions",
|
||||
", \"type\">) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"SavedObjectsFindResponse",
|
||||
"<unknown, unknown>>; get: (sessionId: string) => Promise<",
|
||||
"SearchSessionSavedObject",
|
||||
">; update: (sessionId: string, attributes: unknown) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -358,13 +340,7 @@
|
|||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
">>; rename: (sessionId: string, newName: string) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<Pick<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -374,13 +350,7 @@
|
|||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
", \"name\">>>; extend: (sessionId: string, expires: string) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"SavedObjectsFindResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -389,7 +359,7 @@
|
|||
"section": "def-common.SearchSessionSavedObjectAttributes",
|
||||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
", unknown>>; }"
|
||||
", unknown>>; delete: (sessionId: string) => Promise<void>; }"
|
||||
],
|
||||
"path": "src/plugins/data/public/search/types.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -701,32 +671,14 @@
|
|||
"signature": [
|
||||
"{ create: ({ name, appId, locatorId, initialState, restoreState, sessionId, }: { name: string; appId: string; locatorId: string; initialState: Record<string, unknown>; restoreState: Record<string, unknown>; sessionId: string; }) => Promise<",
|
||||
"SearchSessionSavedObject",
|
||||
">; delete: (sessionId: string) => Promise<void>; find: (options: Omit<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
">; find: (options: Omit<",
|
||||
"SavedObjectsFindOptions",
|
||||
", \"type\">) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"SavedObjectsFindResponse",
|
||||
"<unknown, unknown>>; get: (sessionId: string) => Promise<",
|
||||
"SearchSessionSavedObject",
|
||||
">; update: (sessionId: string, attributes: unknown) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -736,13 +688,7 @@
|
|||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
">>; rename: (sessionId: string, newName: string) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<Pick<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -752,13 +698,7 @@
|
|||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
", \"name\">>>; extend: (sessionId: string, expires: string) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"SavedObjectsFindResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -767,7 +707,7 @@
|
|||
"section": "def-common.SearchSessionSavedObjectAttributes",
|
||||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
", unknown>>; }"
|
||||
", unknown>>; delete: (sessionId: string) => Promise<void>; }"
|
||||
],
|
||||
"path": "src/plugins/data/public/search/types.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -1246,32 +1186,14 @@
|
|||
"signature": [
|
||||
"{ create: ({ name, appId, locatorId, initialState, restoreState, sessionId, }: { name: string; appId: string; locatorId: string; initialState: Record<string, unknown>; restoreState: Record<string, unknown>; sessionId: string; }) => Promise<",
|
||||
"SearchSessionSavedObject",
|
||||
">; delete: (sessionId: string) => Promise<void>; find: (options: Omit<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
">; find: (options: Omit<",
|
||||
"SavedObjectsFindOptions",
|
||||
", \"type\">) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"SavedObjectsFindResponse",
|
||||
"<unknown, unknown>>; get: (sessionId: string) => Promise<",
|
||||
"SearchSessionSavedObject",
|
||||
">; update: (sessionId: string, attributes: unknown) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -1281,13 +1203,7 @@
|
|||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
">>; rename: (sessionId: string, newName: string) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<Pick<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -1297,13 +1213,7 @@
|
|||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
", \"name\">>>; extend: (sessionId: string, expires: string) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"SavedObjectsFindResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -1312,7 +1222,7 @@
|
|||
"section": "def-common.SearchSessionSavedObjectAttributes",
|
||||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
", unknown>>; }"
|
||||
", unknown>>; delete: (sessionId: string) => Promise<void>; }"
|
||||
],
|
||||
"path": "src/plugins/data/public/search/session/sessions_client.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -1879,21 +1789,9 @@
|
|||
"text": "AuthenticatedUser"
|
||||
},
|
||||
" | null, options: Omit<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
"SavedObjectsFindOptions",
|
||||
", \"type\">) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"SavedObjectsFindResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -1951,13 +1849,7 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"Omit<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
"SavedObjectsFindOptions",
|
||||
", \"type\">"
|
||||
],
|
||||
"path": "src/plugins/data/server/search/session/session_service.ts",
|
||||
|
|
@ -1994,13 +1886,7 @@
|
|||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
">) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -2107,13 +1993,7 @@
|
|||
"text": "AuthenticatedUser"
|
||||
},
|
||||
" | null, sessionId: string, expires: Date) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -2212,13 +2092,7 @@
|
|||
"text": "AuthenticatedUser"
|
||||
},
|
||||
" | null, sessionId: string) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -2513,21 +2387,9 @@
|
|||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
">>; find: (options: Omit<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
"SavedObjectsFindOptions",
|
||||
", \"type\">) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"SavedObjectsFindResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -2545,13 +2407,7 @@
|
|||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
">) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -2561,13 +2417,7 @@
|
|||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
">>; extend: (sessionId: string, expires: Date) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -2577,13 +2427,7 @@
|
|||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
">>; cancel: (sessionId: string) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -2823,21 +2667,9 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"(options: Omit<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
"SavedObjectsFindOptions",
|
||||
", \"type\">) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"SavedObjectsFindResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -2865,29 +2697,11 @@
|
|||
"> | undefined; fields?: string[] | undefined; searchAfter?: string[] | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: ",
|
||||
"SortOrder",
|
||||
" | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; hasReference?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptionsReference",
|
||||
"text": "SavedObjectsFindOptionsReference"
|
||||
},
|
||||
"SavedObjectsFindOptionsReference",
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptionsReference",
|
||||
"text": "SavedObjectsFindOptionsReference"
|
||||
},
|
||||
"SavedObjectsFindOptionsReference",
|
||||
"[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map<string, string[] | undefined> | undefined; preference?: string | undefined; pit?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsPitParams",
|
||||
"text": "SavedObjectsPitParams"
|
||||
},
|
||||
"SavedObjectsPitParams",
|
||||
" | undefined; }"
|
||||
],
|
||||
"path": "src/plugins/data/server/search/session/types.ts",
|
||||
|
|
@ -2912,13 +2726,7 @@
|
|||
"text": "SearchSessionSavedObjectAttributes"
|
||||
},
|
||||
">) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -3039,13 +2847,7 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"(sessionId: string, expires: Date) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"SavedObjectsUpdateResponse",
|
||||
"<",
|
||||
{
|
||||
"pluginId": "data",
|
||||
|
|
@ -3465,331 +3267,7 @@
|
|||
"label": "savedObjectsClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
"SavedObject",
|
||||
"<T>>; bulkCreate: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkCreateObject",
|
||||
"text": "SavedObjectsBulkCreateObject"
|
||||
},
|
||||
"<T>[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResponse",
|
||||
"text": "SavedObjectsBulkResponse"
|
||||
},
|
||||
"<T>>; checkConflicts: (objects?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCheckConflictsObject",
|
||||
"text": "SavedObjectsCheckConflictsObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCheckConflictsResponse",
|
||||
"text": "SavedObjectsCheckConflictsResponse"
|
||||
},
|
||||
">; delete: (type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsDeleteOptions",
|
||||
"text": "SavedObjectsDeleteOptions"
|
||||
},
|
||||
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkGetObject",
|
||||
"text": "SavedObjectsBulkGetObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResponse",
|
||||
"text": "SavedObjectsBulkResponse"
|
||||
},
|
||||
"<T>>; bulkResolve: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResolveObject",
|
||||
"text": "SavedObjectsBulkResolveObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResolveResponse",
|
||||
"text": "SavedObjectsBulkResolveResponse"
|
||||
},
|
||||
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
"SavedObject",
|
||||
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsResolveResponse",
|
||||
"text": "SavedObjectsResolveResponse"
|
||||
},
|
||||
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"<T>) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"<T>>; collectMultiNamespaceReferences: (objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
|
||||
},
|
||||
">; updateObjectsSpaces: (objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesObject"
|
||||
},
|
||||
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesResponse"
|
||||
},
|
||||
">; bulkUpdate: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateObject",
|
||||
"text": "SavedObjectsBulkUpdateObject"
|
||||
},
|
||||
"<T>[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateOptions",
|
||||
"text": "SavedObjectsBulkUpdateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateResponse",
|
||||
"text": "SavedObjectsBulkUpdateResponse"
|
||||
},
|
||||
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
|
||||
"text": "SavedObjectsRemoveReferencesToOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
|
||||
"text": "SavedObjectsRemoveReferencesToResponse"
|
||||
},
|
||||
">; openPointInTimeForType: (type: string | string[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
|
||||
"text": "SavedObjectsOpenPointInTimeOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
|
||||
"text": "SavedObjectsOpenPointInTimeResponse"
|
||||
},
|
||||
">; closePointInTime: (id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClosePointInTimeResponse",
|
||||
"text": "SavedObjectsClosePointInTimeResponse"
|
||||
},
|
||||
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreatePointInTimeFinderOptions",
|
||||
"text": "SavedObjectsCreatePointInTimeFinderOptions"
|
||||
},
|
||||
", dependencies?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
||||
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
|
||||
},
|
||||
" | undefined) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.ISavedObjectsPointInTimeFinder",
|
||||
"text": "ISavedObjectsPointInTimeFinder"
|
||||
},
|
||||
"<T, A>; errors: typeof ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsErrorHelpers",
|
||||
"text": "SavedObjectsErrorHelpers"
|
||||
},
|
||||
"; }"
|
||||
"SavedObjectsClientContract"
|
||||
],
|
||||
"path": "src/plugins/data/server/search/types.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -10082,7 +9560,6 @@
|
|||
],
|
||||
"path": "src/plugins/data/common/search/search_source/search_source.ts",
|
||||
"deprecated": true,
|
||||
"removeBy": "8.1",
|
||||
"references": [
|
||||
{
|
||||
"plugin": "stackAlerts",
|
||||
|
|
@ -11189,6 +10666,61 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-common.aggregateQueryToAst",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "aggregateQueryToAst",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(query: ",
|
||||
"AggregateQuery",
|
||||
", timeField?: string | undefined) => ",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.ExpressionAstFunction",
|
||||
"text": "ExpressionAstFunction"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/common/search/expressions/aggregate_query_to_ast.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-common.aggregateQueryToAst.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"AggregateQuery"
|
||||
],
|
||||
"path": "src/plugins/data/common/search/expressions/aggregate_query_to_ast.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-common.aggregateQueryToAst.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "timeField",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/common/search/expressions/aggregate_query_to_ast.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-common.aggSampler",
|
||||
|
|
@ -25747,7 +25279,7 @@
|
|||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-common.SearchSourceFields.query",
|
||||
"type": "Object",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [
|
||||
|
|
@ -25755,6 +25287,8 @@
|
|||
],
|
||||
"signature": [
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/common/search/search_source/types.ts",
|
||||
|
|
@ -27690,8 +27224,12 @@
|
|||
"[] | undefined; query?: ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | (",
|
||||
"Query",
|
||||
"[] | undefined; timeRange?: ",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
")[] | undefined; timeRange?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
|
|
@ -29971,6 +29509,8 @@
|
|||
"signature": [
|
||||
"{ type?: string | undefined; query?: ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | undefined; filter?: ",
|
||||
"Filter",
|
||||
"[] | undefined; sort?: ",
|
||||
|
|
@ -35331,8 +34871,12 @@
|
|||
"[]; type: \"kibana_context\"; query?: ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | (",
|
||||
"Query",
|
||||
"[] | undefined; timeRange?: ",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
")[] | undefined; timeRange?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
|
|
@ -35634,8 +35178,12 @@
|
|||
"[]; type: \"kibana_context\"; query?: ",
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | (",
|
||||
"Query",
|
||||
"[] | undefined; timeRange?: ",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
")[] | undefined; timeRange?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/data-search
|
|||
title: "data.search"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the data.search plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3094 | 34 | 2421 | 21 |
|
||||
| 3097 | 34 | 2420 | 21 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewEditor
|
|||
title: "dataViewEditor"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dataViewEditor plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewEditor']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewFieldEditor
|
|||
title: "dataViewFieldEditor"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dataViewFieldEditor plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewFieldEditor']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViewManagement
|
|||
title: "dataViewManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dataViewManagement plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViewManagement']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4134,13 +4134,7 @@
|
|||
"text": "DataViewAttributes"
|
||||
},
|
||||
", options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"SavedObjectsUpdateOptions",
|
||||
"<unknown>) => Promise<",
|
||||
"SavedObject",
|
||||
"<unknown>>"
|
||||
|
|
@ -4204,13 +4198,7 @@
|
|||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"SavedObjectsUpdateOptions",
|
||||
"<unknown>"
|
||||
],
|
||||
"path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts",
|
||||
|
|
@ -4237,13 +4225,7 @@
|
|||
"text": "DataViewAttributes"
|
||||
},
|
||||
", options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
"SavedObjectsCreateOptions",
|
||||
" | undefined) => Promise<",
|
||||
"SavedObject",
|
||||
"<unknown>>"
|
||||
|
|
@ -4293,13 +4275,7 @@
|
|||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
"SavedObjectsCreateOptions",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/data_views/public/saved_objects_client_wrapper.ts",
|
||||
|
|
@ -5716,13 +5692,7 @@
|
|||
"text": "DataViewAttributes"
|
||||
},
|
||||
", options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"SavedObjectsUpdateOptions",
|
||||
"<unknown>) => Promise<",
|
||||
"SavedObject",
|
||||
"<unknown>>"
|
||||
|
|
@ -5794,13 +5764,7 @@
|
|||
"- client options"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"SavedObjectsUpdateOptions",
|
||||
"<unknown>"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/types.ts",
|
||||
|
|
@ -5829,13 +5793,7 @@
|
|||
"text": "DataViewAttributes"
|
||||
},
|
||||
", options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
"SavedObjectsCreateOptions",
|
||||
") => Promise<",
|
||||
"SavedObject",
|
||||
"<unknown>>"
|
||||
|
|
@ -5891,13 +5849,7 @@
|
|||
"- client options"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
}
|
||||
"SavedObjectsCreateOptions"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -8028,13 +7980,7 @@
|
|||
"text": "DataViewsServerPluginStartDependencies"
|
||||
},
|
||||
") => { dataViewsServiceFactory: (savedObjectsClient: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClientContract",
|
||||
"text": "SavedObjectsClientContract"
|
||||
},
|
||||
"SavedObjectsClientContract",
|
||||
", elasticsearchClient: ",
|
||||
"ElasticsearchClient",
|
||||
", request?: ",
|
||||
|
|
@ -9540,13 +9486,7 @@
|
|||
],
|
||||
"signature": [
|
||||
"(deps: DataViewsServiceFactoryDeps) => (savedObjectsClient: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClientContract",
|
||||
"text": "SavedObjectsClientContract"
|
||||
},
|
||||
"SavedObjectsClientContract",
|
||||
", elasticsearchClient: ",
|
||||
"ElasticsearchClient",
|
||||
", request?: ",
|
||||
|
|
@ -9595,13 +9535,7 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"(savedObjectsClient: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClientContract",
|
||||
"text": "SavedObjectsClientContract"
|
||||
},
|
||||
"SavedObjectsClientContract",
|
||||
", index: string) => Promise<",
|
||||
"SavedObject",
|
||||
"<",
|
||||
|
|
@ -9643,13 +9577,7 @@
|
|||
"label": "savedObjectsClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClientContract",
|
||||
"text": "SavedObjectsClientContract"
|
||||
}
|
||||
"SavedObjectsClientContract"
|
||||
],
|
||||
"path": "src/plugins/data_views/server/utils.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -10214,13 +10142,7 @@
|
|||
"text": "DataViewAttributes"
|
||||
},
|
||||
", options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"SavedObjectsUpdateOptions",
|
||||
"<unknown>) => Promise<",
|
||||
"SavedObject",
|
||||
"<unknown>>"
|
||||
|
|
@ -10292,13 +10214,7 @@
|
|||
"- client options"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"SavedObjectsUpdateOptions",
|
||||
"<unknown>"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/types.ts",
|
||||
|
|
@ -10327,13 +10243,7 @@
|
|||
"text": "DataViewAttributes"
|
||||
},
|
||||
", options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
"SavedObjectsCreateOptions",
|
||||
") => Promise<",
|
||||
"SavedObject",
|
||||
"<unknown>>"
|
||||
|
|
@ -10389,13 +10299,7 @@
|
|||
"- client options"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
}
|
||||
"SavedObjectsCreateOptions"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -10756,13 +10660,7 @@
|
|||
],
|
||||
"signature": [
|
||||
"(savedObjectsClient: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClientContract",
|
||||
"text": "SavedObjectsClientContract"
|
||||
},
|
||||
"SavedObjectsClientContract",
|
||||
", elasticsearchClient: ",
|
||||
"ElasticsearchClient",
|
||||
", request?: ",
|
||||
|
|
@ -10789,331 +10687,7 @@
|
|||
"label": "savedObjectsClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ create: <T = unknown>(type: string, attributes: T, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
"SavedObject",
|
||||
"<T>>; bulkCreate: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkCreateObject",
|
||||
"text": "SavedObjectsBulkCreateObject"
|
||||
},
|
||||
"<T>[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResponse",
|
||||
"text": "SavedObjectsBulkResponse"
|
||||
},
|
||||
"<T>>; checkConflicts: (objects?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCheckConflictsObject",
|
||||
"text": "SavedObjectsCheckConflictsObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCheckConflictsResponse",
|
||||
"text": "SavedObjectsCheckConflictsResponse"
|
||||
},
|
||||
">; delete: (type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsDeleteOptions",
|
||||
"text": "SavedObjectsDeleteOptions"
|
||||
},
|
||||
") => Promise<{}>; find: <T = unknown, A = unknown>(options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindOptions",
|
||||
"text": "SavedObjectsFindOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsFindResponse",
|
||||
"text": "SavedObjectsFindResponse"
|
||||
},
|
||||
"<T, A>>; bulkGet: <T = unknown>(objects?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkGetObject",
|
||||
"text": "SavedObjectsBulkGetObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResponse",
|
||||
"text": "SavedObjectsBulkResponse"
|
||||
},
|
||||
"<T>>; bulkResolve: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResolveObject",
|
||||
"text": "SavedObjectsBulkResolveObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkResolveResponse",
|
||||
"text": "SavedObjectsBulkResolveResponse"
|
||||
},
|
||||
"<T>>; get: <T = unknown>(type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
"SavedObject",
|
||||
"<T>>; resolve: <T = unknown>(type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsResolveResponse",
|
||||
"text": "SavedObjectsResolveResponse"
|
||||
},
|
||||
"<T>>; update: <T = unknown>(type: string, id: string, attributes: Partial<T>, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"<T>) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateResponse",
|
||||
"text": "SavedObjectsUpdateResponse"
|
||||
},
|
||||
"<T>>; collectMultiNamespaceReferences: (objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesObject"
|
||||
},
|
||||
"[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse",
|
||||
"text": "SavedObjectsCollectMultiNamespaceReferencesResponse"
|
||||
},
|
||||
">; updateObjectsSpaces: (objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesObject",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesObject"
|
||||
},
|
||||
"[], spacesToAdd: string[], spacesToRemove: string[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesOptions",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsUpdateObjectsSpacesResponse",
|
||||
"text": "SavedObjectsUpdateObjectsSpacesResponse"
|
||||
},
|
||||
">; bulkUpdate: <T = unknown>(objects: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateObject",
|
||||
"text": "SavedObjectsBulkUpdateObject"
|
||||
},
|
||||
"<T>[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateOptions",
|
||||
"text": "SavedObjectsBulkUpdateOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBulkUpdateResponse",
|
||||
"text": "SavedObjectsBulkUpdateResponse"
|
||||
},
|
||||
"<T>>; removeReferencesTo: (type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsRemoveReferencesToOptions",
|
||||
"text": "SavedObjectsRemoveReferencesToOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsRemoveReferencesToResponse",
|
||||
"text": "SavedObjectsRemoveReferencesToResponse"
|
||||
},
|
||||
">; openPointInTimeForType: (type: string | string[], options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsOpenPointInTimeOptions",
|
||||
"text": "SavedObjectsOpenPointInTimeOptions"
|
||||
},
|
||||
") => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsOpenPointInTimeResponse",
|
||||
"text": "SavedObjectsOpenPointInTimeResponse"
|
||||
},
|
||||
">; closePointInTime: (id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClosePointInTimeResponse",
|
||||
"text": "SavedObjectsClosePointInTimeResponse"
|
||||
},
|
||||
">; createPointInTimeFinder: <T = unknown, A = unknown>(findOptions: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreatePointInTimeFinderOptions",
|
||||
"text": "SavedObjectsCreatePointInTimeFinderOptions"
|
||||
},
|
||||
", dependencies?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
||||
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
|
||||
},
|
||||
" | undefined) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.ISavedObjectsPointInTimeFinder",
|
||||
"text": "ISavedObjectsPointInTimeFinder"
|
||||
},
|
||||
"<T, A>; errors: typeof ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsErrorHelpers",
|
||||
"text": "SavedObjectsErrorHelpers"
|
||||
},
|
||||
"; }"
|
||||
"SavedObjectsClientContract"
|
||||
],
|
||||
"path": "src/plugins/data_views/server/types.ts",
|
||||
"deprecated": false
|
||||
|
|
@ -11220,32 +10794,6 @@
|
|||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"WriteResponseBase",
|
||||
">; }; delete: { (this: That, params: ",
|
||||
"DeleteRequest",
|
||||
" | ",
|
||||
"DeleteRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"WriteResponseBase",
|
||||
">; (this: That, params: ",
|
||||
"DeleteRequest",
|
||||
" | ",
|
||||
"DeleteRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"WriteResponseBase",
|
||||
", unknown>>; (this: That, params: ",
|
||||
"DeleteRequest",
|
||||
" | ",
|
||||
"DeleteRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"WriteResponseBase",
|
||||
">; }; get: { <TDocument = unknown>(this: That, params: ",
|
||||
"GetRequest",
|
||||
" | ",
|
||||
|
|
@ -11298,32 +10846,32 @@
|
|||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"UpdateResponse",
|
||||
"<TDocumentR>>; }; closePointInTime: { (this: That, params: ",
|
||||
"ClosePointInTimeRequest",
|
||||
"<TDocumentR>>; }; delete: { (this: That, params: ",
|
||||
"DeleteRequest",
|
||||
" | ",
|
||||
"ClosePointInTimeRequest",
|
||||
"DeleteRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"ClosePointInTimeResponse",
|
||||
"WriteResponseBase",
|
||||
">; (this: That, params: ",
|
||||
"ClosePointInTimeRequest",
|
||||
"DeleteRequest",
|
||||
" | ",
|
||||
"ClosePointInTimeRequest",
|
||||
"DeleteRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"ClosePointInTimeResponse",
|
||||
"WriteResponseBase",
|
||||
", unknown>>; (this: That, params: ",
|
||||
"ClosePointInTimeRequest",
|
||||
"DeleteRequest",
|
||||
" | ",
|
||||
"ClosePointInTimeRequest",
|
||||
"DeleteRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"ClosePointInTimeResponse",
|
||||
"WriteResponseBase",
|
||||
">; }; [kInternal]: symbol | null; [kAsyncSearch]: symbol | null; [kAutoscaling]: symbol | null; [kCat]: symbol | null; [kCcr]: symbol | null; [kCluster]: symbol | null; [kDanglingIndices]: symbol | null; [kEnrich]: symbol | null; [kEql]: symbol | null; [kFeatures]: symbol | null; [kFleet]: symbol | null; [kGraph]: symbol | null; [kIlm]: symbol | null; [kIndices]: symbol | null; [kIngest]: symbol | null; [kLicense]: symbol | null; [kLogstash]: symbol | null; [kMigration]: symbol | null; [kMl]: symbol | null; [kMonitoring]: symbol | null; [kNodes]: symbol | null; [kRollup]: symbol | null; [kSearchableSnapshots]: symbol | null; [kSecurity]: symbol | null; [kShutdown]: symbol | null; [kSlm]: symbol | null; [kSnapshot]: symbol | null; [kSql]: symbol | null; [kSsl]: symbol | null; [kTasks]: symbol | null; [kTextStructure]: symbol | null; [kTransform]: symbol | null; [kWatcher]: symbol | null; [kXpack]: symbol | null; transport: ",
|
||||
"default",
|
||||
"; helpers: ",
|
||||
|
|
@ -11394,6 +10942,32 @@
|
|||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"ClearScrollResponse",
|
||||
">; }; closePointInTime: { (this: That, params: ",
|
||||
"ClosePointInTimeRequest",
|
||||
" | ",
|
||||
"ClosePointInTimeRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptionsWithOutMeta",
|
||||
" | undefined): Promise<",
|
||||
"ClosePointInTimeResponse",
|
||||
">; (this: That, params: ",
|
||||
"ClosePointInTimeRequest",
|
||||
" | ",
|
||||
"ClosePointInTimeRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptionsWithMeta",
|
||||
" | undefined): Promise<",
|
||||
"TransportResult",
|
||||
"<",
|
||||
"ClosePointInTimeResponse",
|
||||
", unknown>>; (this: That, params: ",
|
||||
"ClosePointInTimeRequest",
|
||||
" | ",
|
||||
"ClosePointInTimeRequest",
|
||||
", options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): Promise<",
|
||||
"ClosePointInTimeResponse",
|
||||
">; }; count: { (this: That, params?: ",
|
||||
"CountRequest",
|
||||
" | ",
|
||||
|
|
@ -19000,7 +18574,7 @@
|
|||
"SavedObject",
|
||||
"<T>"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
|
|
@ -19012,7 +18586,7 @@
|
|||
"description": [
|
||||
"The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -19024,7 +18598,7 @@
|
|||
"description": [
|
||||
" The type of Saved Object. Each plugin can define it's own custom Saved Object types."
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -19039,7 +18613,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -19054,7 +18628,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -19068,7 +18642,7 @@
|
|||
"SavedObjectError",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -19083,7 +18657,7 @@
|
|||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -19099,7 +18673,7 @@
|
|||
"SavedObjectReference",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -19115,7 +18689,7 @@
|
|||
"SavedObjectsMigrationVersion",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -19130,7 +18704,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -19145,7 +18719,7 @@
|
|||
"signature": [
|
||||
"string[] | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
|
|
@ -19160,7 +18734,7 @@
|
|||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/core/types/saved_objects.ts",
|
||||
"path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
|
|
@ -19299,13 +18873,7 @@
|
|||
"text": "DataViewAttributes"
|
||||
},
|
||||
", options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"SavedObjectsUpdateOptions",
|
||||
"<unknown>) => Promise<",
|
||||
"SavedObject",
|
||||
"<unknown>>"
|
||||
|
|
@ -19377,13 +18945,7 @@
|
|||
"- client options"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsUpdateOptions",
|
||||
"text": "SavedObjectsUpdateOptions"
|
||||
},
|
||||
"SavedObjectsUpdateOptions",
|
||||
"<unknown>"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/types.ts",
|
||||
|
|
@ -19412,13 +18974,7 @@
|
|||
"text": "DataViewAttributes"
|
||||
},
|
||||
", options: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
},
|
||||
"SavedObjectsCreateOptions",
|
||||
") => Promise<",
|
||||
"SavedObject",
|
||||
"<unknown>>"
|
||||
|
|
@ -19474,13 +19030,7 @@
|
|||
"- client options"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObjectsCreateOptions",
|
||||
"text": "SavedObjectsCreateOptions"
|
||||
}
|
||||
"SavedObjectsCreateOptions"
|
||||
],
|
||||
"path": "src/plugins/data_views/common/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -20013,7 +19563,7 @@
|
|||
"section": "def-common.DataView",
|
||||
"text": "DataView"
|
||||
},
|
||||
">; delete: (indexPatternId: string) => Promise<{}>; find: (search: string, size?: number) => Promise<",
|
||||
">; find: (search: string, size?: number) => Promise<",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
|
|
@ -20029,7 +19579,7 @@
|
|||
"section": "def-common.DataView",
|
||||
"text": "DataView"
|
||||
},
|
||||
">; getCanSave: () => Promise<boolean>; getIds: (refresh?: boolean) => Promise<string[]>; getTitles: (refresh?: boolean) => Promise<string[]>; getIdsWithTitle: (refresh?: boolean) => Promise<",
|
||||
">; delete: (indexPatternId: string) => Promise<{}>; getCanSave: () => Promise<boolean>; getIds: (refresh?: boolean) => Promise<string[]>; getTitles: (refresh?: boolean) => Promise<string[]>; getIdsWithTitle: (refresh?: boolean) => Promise<",
|
||||
{
|
||||
"pluginId": "dataViews",
|
||||
"scope": "common",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataViews
|
|||
title: "dataViews"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dataViews plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataViews']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 945 | 0 | 203 | 0 |
|
||||
| 945 | 0 | 201 | 0 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/dataVisualizer
|
|||
title: "dataVisualizer"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the dataVisualizer plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataVisualizer']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByApi
|
|||
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-api
|
||||
title: Deprecated API usage by API
|
||||
summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
|
||||
---
|
||||
|
|
@ -23,6 +23,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibUiActionsPluginApi" section="def-public.UiActionsService.executeTriggerActions" text="executeTriggerActions"/> | data, discover, embeddable | - |
|
||||
| <DocLink id="kibCorePluginApi" section="def-public.UiSettingsParams.metric" text="metric"/> | advancedSettings, discover | - |
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.UiSettingsParams.metric" text="metric"/> | advancedSettings, discover | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | - |
|
||||
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | actions, alerting | - |
|
||||
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | encryptedSavedObjects, actions, data, cloud, ml, logstash, securitySolution | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | dashboard, lens, stackAlerts, visTypeTable, visTypeTimeseries, visTypeXy, visTypeVislib, expressionPartitionVis | - |
|
||||
|
|
@ -60,8 +62,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibCorePluginApi" section="def-public.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - |
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | spaces, savedObjectsManagement | - |
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.ElasticsearchServiceSetup.legacy" text="legacy"/> | console, @kbn/core-elasticsearch-server-internal | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 |
|
||||
| <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | embeddable, discover, presentationUtil, dashboard, graph | 8.8.0 |
|
||||
| <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getKibanaFeatures" text="getKibanaFeatures"/> | spaces, security, alerting | 8.8.0 |
|
||||
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | 8.8.0 |
|
||||
|
|
@ -140,4 +140,5 @@ Safe to remove.
|
|||
| <DocLink id="kibKbnCoreInjectedMetadataBrowserPluginApi" section="def-common.InjectedMetadataStart" text="InjectedMetadataStart"/> | @kbn/core-injected-metadata-browser |
|
||||
| <DocLink id="kibKbnCoreInjectedMetadataBrowserPluginApi" section="def-common.InjectedMetadataSetup" text="InjectedMetadataSetup"/> | @kbn/core-injected-metadata-browser |
|
||||
| <DocLink id="kibKbnCoreMetricsServerPluginApi" section="def-server.OpsMetrics.process" text="process"/> | @kbn/core-metrics-server |
|
||||
| <DocLink id="kibKbnCoreSavedObjectsCommonPluginApi" section="def-common.SavedObjectsImportSuccess.createNewCopy" text="createNewCopy"/> | @kbn/core-saved-objects-common |
|
||||
| <DocLink id="kibKbnCoreUiSettingsCommonPluginApi" section="def-common.UiSettingsParams.metric" text="metric"/> | @kbn/core-ui-settings-common |
|
||||
|
|
@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsByPlugin
|
|||
slug: /kibana-dev-docs/api-meta/deprecated-api-list-by-plugin
|
||||
title: Deprecated API usage by plugin
|
||||
summary: A list of deprecated APIs, which plugins are still referencing them, and when they need to be removed by.
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
|
||||
---
|
||||
|
|
@ -65,9 +65,9 @@ so TS and code-reference navigation might not highlight them. |
|
|||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.create" text="create"/> | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.ts#:~:text=create) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.create" text="create"/> | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.ts#:~:text=create) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch) | - |
|
||||
| <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getKibanaFeatures" text="getKibanaFeatures"/> | [plugin.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/plugin.test.ts#:~:text=getKibanaFeatures) | 8.8.0 |
|
||||
| <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24) | 8.8.0 |
|
||||
| <DocLink id="kibTaskManagerPluginApi" section="def-server.TaskManagerSetupContract.index" text="index"/> | [task.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/usage/task.ts#:~:text=index) | - |
|
||||
|
|
@ -307,9 +307,9 @@ so TS and code-reference navigation might not highlight them. |
|
|||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [list_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/list_control_factory.ts#:~:text=fetch), [range_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/range_control_factory.ts#:~:text=fetch) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [list_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/list_control_factory.ts#:~:text=fetch), [range_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/range_control_factory.ts#:~:text=fetch) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [list_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/list_control_factory.ts#:~:text=indexPatterns), [range_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/range_control_factory.ts#:~:text=indexPatterns), [controls_tab.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/components/editor/controls_tab.tsx#:~:text=indexPatterns) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [list_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/list_control_factory.ts#:~:text=fetch), [range_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/range_control_factory.ts#:~:text=fetch) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [list_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/list_control_factory.ts#:~:text=fetch), [range_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/range_control_factory.ts#:~:text=fetch) | - |
|
||||
|
||||
|
||||
|
||||
|
|
@ -542,10 +542,10 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
|
|||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.create" text="create"/> | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.ts#:~:text=create) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [middleware.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#:~:text=indexPatterns), [dependencies_start_mock.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/common/mock/endpoint/dependencies_start_mock.ts#:~:text=indexPatterns) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.create" text="create"/> | [wrap_search_source_client.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.ts#:~:text=create) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | - |
|
||||
| <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [list.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts#:~:text=mode), [response_actions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts#:~:text=mode)+ 3 more | 8.8.0 |
|
||||
| <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [list.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts#:~:text=mode), [response_actions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts#:~:text=mode)+ 3 more | 8.8.0 |
|
||||
| <DocLink id="kibSecurityPluginApi" section="def-server.SecurityPluginSetup.authc" text="authc"/> | [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [request_context_factory.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/request_context_factory.ts#:~:text=authc), [create_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts#:~:text=authc), [delete_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts#:~:text=authc), [finalize_signals_migration_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts#:~:text=authc), [open_close_signals_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/open_close_signals_route.ts#:~:text=authc), [preview_rules_route.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/preview_rules_route.ts#:~:text=authc), [common.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts#:~:text=authc) | - |
|
||||
|
|
@ -579,10 +579,10 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
|
|||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.indexPatterns" text="indexPatterns"/> | [entity_index_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/entity_index_expression.tsx#:~:text=indexPatterns), [boundary_index_expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/expressions/boundary_index_expression.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns), [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/geo_containment/query_builder/index.tsx#:~:text=indexPatterns) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.DataPublicPluginStart.fieldFormats" text="fieldFormats"/> | [expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/threshold/expression.tsx#:~:text=fieldFormats) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch) | 8.1 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch) | - |
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ id: kibDevDocsDeprecationsDueByTeam
|
|||
slug: /kibana-dev-docs/api-meta/deprecations-due-by-team
|
||||
title: Deprecated APIs due to be removed, by team
|
||||
summary: Lists the teams that are referencing deprecated APIs with a remove by date.
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana']
|
||||
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system.
|
||||
---
|
||||
|
|
@ -73,8 +73,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
|
||||
| Plugin | Deprecated API | Reference location(s) | Remove By |
|
||||
| --------|-------|-----------|-----------|
|
||||
| inputControlVis | <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [list_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/list_control_factory.ts#:~:text=fetch), [range_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/range_control_factory.ts#:~:text=fetch) | 8.1 |
|
||||
| inputControlVis | <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [list_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/list_control_factory.ts#:~:text=fetch), [range_control_factory.ts](https://github.com/elastic/kibana/tree/master/src/plugins/input_control_vis/public/control/range_control_factory.ts#:~:text=fetch) | 8.1 |
|
||||
| dashboard | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectSaveModal" text="SavedObjectSaveModal"/> | [saved_objects.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [save_modal.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/top_nav/save_modal.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal), [saved_object_save_modal_dashboard.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/presentation_util/public/components/saved_object_save_modal_dashboard.tsx#:~:text=SavedObjectSaveModal) | 8.8.0 |
|
||||
| dashboard | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObject" text="SavedObject"/> | [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_object_loader.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_object_loader.ts#:~:text=SavedObject), [saved_objects.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/services/saved_objects.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [dashboard_tagging.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/lib/dashboard_tagging.ts#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject), [clone_panel_action.tsx](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/application/actions/clone_panel_action.tsx#:~:text=SavedObject)+ 1 more | 8.8.0 |
|
||||
| dashboard | <DocLink id="kibSavedObjectsPluginApi" section="def-public.SavedObjectsStart.SavedObjectClass" text="SavedObjectClass"/> | [saved_dashboard.ts](https://github.com/elastic/kibana/tree/master/src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#:~:text=SavedObjectClass) | 8.8.0 |
|
||||
|
|
@ -143,8 +141,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
|
|||
|
||||
| Plugin | Deprecated API | Reference location(s) | Remove By |
|
||||
| --------|-------|-----------|-----------|
|
||||
| alerting | <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch) | 8.1 |
|
||||
| alerting | <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/wrap_search_source_client.test.ts#:~:text=fetch), [fetch_search_source_query.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/lib/fetch_search_source_query.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch), [rule_type.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/server/alert_types/es_query/rule_type.test.ts#:~:text=fetch) | 8.1 |
|
||||
| alerting | <DocLink id="kibFeaturesPluginApi" section="def-server.PluginSetupContract.getKibanaFeatures" text="getKibanaFeatures"/> | [plugin.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/plugin.test.ts#:~:text=getKibanaFeatures) | 8.8.0 |
|
||||
| alerting | <DocLink id="kibLicensingPluginApi" section="def-server.LicensingPluginSetup.license$" text="license$"/> | [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/lib/license_state.test.ts#:~:text=license%24), [plugin.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/plugin.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/lib/license_state.test.ts#:~:text=license%24), [license_state.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/actions/server/lib/license_state.test.ts#:~:text=license%24) | 8.8.0 |
|
||||
|
||||
|
|
@ -154,8 +150,6 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/
|
|||
|
||||
| Plugin | Deprecated API | Reference location(s) | Remove By |
|
||||
| --------|-------|-----------|-----------|
|
||||
| securitySolution | <DocLink id="kibDataPluginApi" section="def-public.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 |
|
||||
| securitySolution | <DocLink id="kibDataPluginApi" section="def-common.SearchSource.fetch" text="fetch"/> | [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch), [wrap_search_source_client.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/lib/detection_engine/routes/rules/utils/wrap_search_source_client.test.ts#:~:text=fetch) | 8.1 |
|
||||
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-public.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [list.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts#:~:text=mode), [response_actions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts#:~:text=mode)+ 3 more | 8.8.0 |
|
||||
| securitySolution | <DocLink id="kibLicensingPluginApi" section="def-server.PublicLicense.mode" text="mode"/> | [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [policy_config.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/common/license/policy_config.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [fleet_integration.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/fleet_integration/fleet_integration.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [license_watch.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/lib/policy/license_watch.test.ts#:~:text=mode), [list.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/list.test.ts#:~:text=mode), [response_actions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/server/endpoint/routes/actions/response_actions.test.ts#:~:text=mode)+ 3 more | 8.8.0 |
|
||||
| securitySolution | <DocLink id="kibCorePluginApi" section="def-public.AppMountParameters.onAppLeave" text="onAppLeave"/> | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave) | 8.8.0 |
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/devTools
|
|||
title: "devTools"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the devTools plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -339,7 +339,7 @@
|
|||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.DiscoverAppLocatorParams.query",
|
||||
"type": "Object",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [
|
||||
|
|
@ -347,6 +347,8 @@
|
|||
],
|
||||
"signature": [
|
||||
"Query",
|
||||
" | ",
|
||||
"AggregateQuery",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/discover/public/locator.ts",
|
||||
|
|
@ -931,6 +933,19 @@
|
|||
"path": "src/plugins/discover/public/services/saved_searches/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.SavedSearch.isTextBasedQuery",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "isTextBasedQuery",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "src/plugins/discover/public/services/saved_searches/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.SavedSearch.rowsPerPage",
|
||||
|
|
@ -1348,6 +1363,20 @@
|
|||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-common.ENABLE_SQL",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "ENABLE_SQL",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"discover:enableSql\""
|
||||
],
|
||||
"path": "src/plugins/discover/common/index.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-common.FIELDS_LIMIT_SETTING",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discover
|
|||
title: "discover"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the discover plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-disco
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 82 | 0 | 66 | 7 |
|
||||
| 84 | 0 | 68 | 7 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/discoverEnhanced
|
|||
title: "discoverEnhanced"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the discoverEnhanced plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/elastic-apm-synthtrace
|
|||
title: "@elastic/apm-synthtrace"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @elastic/apm-synthtrace plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@elastic/apm-synthtrace']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -9055,6 +9055,39 @@
|
|||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.SelfStyledEmbeddable",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "SelfStyledEmbeddable",
|
||||
"description": [
|
||||
"\nAll embeddables that implement this interface will be able to configure\nthe style of their containing panels"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/lib/self_styled_embeddable/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.SelfStyledEmbeddable.getSelfStyledOptions",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getSelfStyledOptions",
|
||||
"description": [
|
||||
"\nGets the embeddable's style configuration"
|
||||
],
|
||||
"signature": [
|
||||
"() => ",
|
||||
"SelfStyledOptions"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/lib/self_styled_embeddable/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.ValueClickContext",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddable
|
|||
title: "embeddable"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the embeddable plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 505 | 0 | 413 | 3 |
|
||||
| 507 | 0 | 413 | 4 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/embeddableEnhanced
|
|||
title: "embeddableEnhanced"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the embeddableEnhanced plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -402,13 +402,7 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"<T = unknown>(type: string, id: string, options?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
"SavedObjectsBaseOptions",
|
||||
" | undefined) => Promise<",
|
||||
"SavedObject",
|
||||
"<T>>"
|
||||
|
|
@ -452,13 +446,7 @@
|
|||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsBaseOptions",
|
||||
"text": "SavedObjectsBaseOptions"
|
||||
},
|
||||
"SavedObjectsBaseOptions",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
|
||||
|
|
@ -479,29 +467,11 @@
|
|||
],
|
||||
"signature": [
|
||||
"<T = unknown, A = unknown>(findOptions: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreatePointInTimeFinderOptions",
|
||||
"text": "SavedObjectsCreatePointInTimeFinderOptions"
|
||||
},
|
||||
"SavedObjectsCreatePointInTimeFinderOptions",
|
||||
", dependencies?: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
||||
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
|
||||
},
|
||||
"SavedObjectsCreatePointInTimeFinderDependencies",
|
||||
" | undefined) => Promise<",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.ISavedObjectsPointInTimeFinder",
|
||||
"text": "ISavedObjectsPointInTimeFinder"
|
||||
},
|
||||
"ISavedObjectsPointInTimeFinder",
|
||||
"<T, A>>"
|
||||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
|
||||
|
|
@ -517,13 +487,7 @@
|
|||
"matches interface of corresponding argument of Saved Objects API `createPointInTimeFinder` {@link SavedObjectsCreatePointInTimeFinderOptions }"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreatePointInTimeFinderOptions",
|
||||
"text": "SavedObjectsCreatePointInTimeFinderOptions"
|
||||
}
|
||||
"SavedObjectsCreatePointInTimeFinderOptions"
|
||||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -539,13 +503,7 @@
|
|||
"matches interface of corresponding argument of Saved Objects API `createPointInTimeFinder` {@link SavedObjectsCreatePointInTimeFinderDependencies }"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies",
|
||||
"text": "SavedObjectsCreatePointInTimeFinderDependencies"
|
||||
},
|
||||
"SavedObjectsCreatePointInTimeFinderDependencies",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/encryptedSavedObjects
|
|||
title: "encryptedSavedObjects"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the encryptedSavedObjects plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -69,6 +69,20 @@
|
|||
"path": "x-pack/plugins/enterprise_search/server/index.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "enterpriseSearch",
|
||||
"id": "def-server.CRAWLERS_INDEX",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "CRAWLERS_INDEX",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\".ent-search-actastic-crawler2_configurations\""
|
||||
],
|
||||
"path": "x-pack/plugins/enterprise_search/server/index.ts",
|
||||
"deprecated": false,
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"objects": [
|
||||
|
|
@ -81,21 +95,21 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"ObjectType",
|
||||
"<{ host: ",
|
||||
"Type",
|
||||
"<string | undefined>; accessCheckTimeout: ",
|
||||
"<{ accessCheckTimeout: ",
|
||||
"Type",
|
||||
"<number>; accessCheckTimeoutWarning: ",
|
||||
"Type",
|
||||
"<number>; ssl: ",
|
||||
"<number>; customHeaders: ",
|
||||
"Type",
|
||||
"<Readonly<{} & {}> | undefined>; host: ",
|
||||
"Type",
|
||||
"<string | undefined>; ssl: ",
|
||||
"ObjectType",
|
||||
"<{ certificateAuthorities: ",
|
||||
"Type",
|
||||
"<string | string[] | undefined>; verificationMode: ",
|
||||
"Type",
|
||||
"<\"none\" | \"full\" | \"certificate\">; }>; customHeaders: ",
|
||||
"Type",
|
||||
"<Readonly<{} & {}> | undefined>; }>"
|
||||
"<\"none\" | \"full\" | \"certificate\">; }>; }>"
|
||||
],
|
||||
"path": "x-pack/plugins/enterprise_search/server/index.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/enterpriseSearch
|
|||
title: "enterpriseSearch"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the enterpriseSearch plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,7 @@ Contact [Enterprise Search](https://github.com/orgs/elastic/teams/enterprise-sea
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 5 | 0 | 5 | 0 |
|
||||
| 6 | 0 | 6 | 0 |
|
||||
|
||||
## Server
|
||||
|
||||
|
|
|
|||
|
|
@ -1215,7 +1215,7 @@
|
|||
"label": "method",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"delete\" | \"get\" | \"post\" | \"put\" | \"patch\" | \"head\""
|
||||
"\"get\" | \"delete\" | \"post\" | \"put\" | \"patch\" | \"head\""
|
||||
],
|
||||
"path": "src/plugins/es_ui_shared/public/request/send_request.ts",
|
||||
"deprecated": false
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/esUiShared
|
|||
title: "esUiShared"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the esUiShared plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventAnnotation
|
|||
title: "eventAnnotation"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the eventAnnotation plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventAnnotation']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/eventLog
|
|||
title: "eventLog"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the eventLog plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionError
|
|||
title: "expressionError"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionError plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionError']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionGauge
|
|||
title: "expressionGauge"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionGauge plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionGauge']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionHeatmap
|
|||
title: "expressionHeatmap"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionHeatmap plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionHeatmap']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionImage
|
|||
title: "expressionImage"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionImage plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionImage']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionLegacyMetricVis
|
|||
title: "expressionLegacyMetricVis"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionLegacyMetricVis plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionLegacyMetricVis']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetric
|
|||
title: "expressionMetric"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionMetric plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetric']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -2,7 +2,116 @@
|
|||
"id": "expressionMetricVis",
|
||||
"client": {
|
||||
"classes": [],
|
||||
"functions": [],
|
||||
"functions": [
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-public.getDataBoundsForPalette",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getDataBoundsForPalette",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(accessors: { metric: string; max?: string | undefined; breakdownBy?: string | undefined; }, data?: ",
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.Datatable",
|
||||
"text": "Datatable"
|
||||
},
|
||||
" | undefined, rowNumber?: number | undefined) => { min: number; max: any; }"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-public.getDataBoundsForPalette.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "accessors",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-public.getDataBoundsForPalette.$1.metric",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "metric",
|
||||
"description": [],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-public.getDataBoundsForPalette.$1.max",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "max",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-public.getDataBoundsForPalette.$1.breakdownBy",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "breakdownBy",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-public.getDataBoundsForPalette.$2",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "data",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.Datatable",
|
||||
"text": "Datatable"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-public.getDataBoundsForPalette.$3",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "rowNumber",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
"interfaces": [],
|
||||
"enums": [],
|
||||
"misc": [],
|
||||
|
|
@ -97,10 +206,10 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.DimensionsVisParam.breakdownBy",
|
||||
"id": "def-common.DimensionsVisParam.max",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "breakdownBy",
|
||||
"label": "max",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | ",
|
||||
|
|
@ -118,10 +227,10 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.DimensionsVisParam.progressMax",
|
||||
"id": "def-common.DimensionsVisParam.breakdownBy",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "progressMax",
|
||||
"label": "breakdownBy",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | ",
|
||||
|
|
@ -191,6 +300,27 @@
|
|||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.max",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "max",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "common",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-common.ExpressionValueVisDimension",
|
||||
"text": "ExpressionValueVisDimension"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.breakdownBy",
|
||||
|
|
@ -227,10 +357,10 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.extraText",
|
||||
"id": "def-common.MetricArguments.secondaryPrefix",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "extraText",
|
||||
"label": "secondaryPrefix",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
|
|
@ -238,27 +368,6 @@
|
|||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.progressMax",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "progressMax",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | ",
|
||||
{
|
||||
"pluginId": "visualizations",
|
||||
"scope": "common",
|
||||
"docId": "kibVisualizationsPluginApi",
|
||||
"section": "def-common.ExpressionValueVisDimension",
|
||||
"text": "ExpressionValueVisDimension"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.progressDirection",
|
||||
|
|
@ -272,6 +381,19 @@
|
|||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.color",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "color",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricArguments.palette",
|
||||
|
|
@ -434,10 +556,23 @@
|
|||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.extraText",
|
||||
"id": "def-common.MetricVisParam.secondaryPrefix",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "extraText",
|
||||
"label": "secondaryPrefix",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "expressionMetricVis",
|
||||
"id": "def-common.MetricVisParam.color",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "color",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionMetricVis
|
|||
title: "expressionMetricVis"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionMetricVis plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionMetricVis']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
@ -18,7 +18,12 @@ Contact [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors)
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 47 | 0 | 47 | 0 |
|
||||
| 56 | 0 | 56 | 0 |
|
||||
|
||||
## Client
|
||||
|
||||
### Functions
|
||||
<DocDefinitionList data={expressionMetricVisObj.client.functions}/>
|
||||
|
||||
## Common
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionPartitionVis
|
|||
title: "expressionPartitionVis"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionPartitionVis plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionPartitionVis']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRepeatImage
|
|||
title: "expressionRepeatImage"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionRepeatImage plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRepeatImage']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionRevealImage
|
|||
title: "expressionRevealImage"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionRevealImage plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionRevealImage']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionShape
|
|||
title: "expressionShape"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionShape plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionShape']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionTagcloud
|
|||
title: "expressionTagcloud"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionTagcloud plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionTagcloud']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressionXY
|
|||
title: "expressionXY"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressionXY plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressionXY']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/expressions
|
|||
title: "expressions"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the expressions plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/features
|
|||
title: "features"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the features plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fieldFormats
|
|||
title: "fieldFormats"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the fieldFormats plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fieldFormats']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fileUpload
|
|||
title: "fileUpload"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the fileUpload plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/fleet
|
|||
title: "fleet"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the fleet plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -612,13 +612,7 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"{ savedObjects: { client: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClientContract",
|
||||
"text": "SavedObjectsClientContract"
|
||||
},
|
||||
"SavedObjectsClientContract",
|
||||
"; typeRegistry: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/globalSearch
|
|||
title: "globalSearch"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the globalSearch plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1628,7 +1628,7 @@
|
|||
"signature": [
|
||||
"{ getSampleDatasets: () => ",
|
||||
"Writable",
|
||||
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; name: string; description: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
|
||||
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; name: string; description: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
|
||||
"SavedObject",
|
||||
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ",
|
||||
{
|
||||
|
|
@ -1662,7 +1662,7 @@
|
|||
"signature": [
|
||||
"() => ",
|
||||
"Writable",
|
||||
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; name: string; description: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>"
|
||||
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; name: string; description: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>"
|
||||
],
|
||||
"path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts",
|
||||
"deprecated": false,
|
||||
|
|
@ -2021,7 +2021,7 @@
|
|||
"signature": [
|
||||
"{ getSampleDatasets: () => ",
|
||||
"Writable",
|
||||
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; name: string; description: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
|
||||
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; statusMsg?: string | undefined; } & { id: string; name: string; description: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
|
||||
"SavedObject",
|
||||
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ",
|
||||
{
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/home
|
|||
title: "home"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the home plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexLifecycleManagement
|
|||
title: "indexLifecycleManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the indexLifecycleManagement plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/indexManagement
|
|||
title: "indexManagement"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the indexManagement plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -614,13 +614,7 @@
|
|||
"description": [],
|
||||
"signature": [
|
||||
"(savedObjectsClient: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClientContract",
|
||||
"text": "SavedObjectsClientContract"
|
||||
},
|
||||
"SavedObjectsClientContract",
|
||||
", sourceId?: string | undefined) => Promise<string>"
|
||||
],
|
||||
"path": "x-pack/plugins/infra/server/types.ts",
|
||||
|
|
@ -634,13 +628,7 @@
|
|||
"label": "savedObjectsClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectsClientContract",
|
||||
"text": "SavedObjectsClientContract"
|
||||
}
|
||||
"SavedObjectsClientContract"
|
||||
],
|
||||
"path": "x-pack/plugins/infra/server/types.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/infra
|
|||
title: "infra"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the infra plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/inspector
|
|||
title: "inspector"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the inspector plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/interactiveSetup
|
|||
title: "interactiveSetup"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the interactiveSetup plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'interactiveSetup']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ace
|
|||
title: "@kbn/ace"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/ace plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ace']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-components
|
|||
title: "@kbn/aiops-components"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/aiops-components plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-components']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-aiops-utils
|
|||
title: "@kbn/aiops-utils"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/aiops-utils plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/aiops-utils']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-alerts
|
|||
title: "@kbn/alerts"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/alerts plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/alerts']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics
|
|||
title: "@kbn/analytics"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/analytics plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-client
|
|||
title: "@kbn/analytics-client"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/analytics-client plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-client']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,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
|
||||
summary: API docs for the @kbn/analytics-shippers-elastic-v3-browser plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-browser']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,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
|
||||
summary: API docs for the @kbn/analytics-shippers-elastic-v3-common plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-common']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,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
|
||||
summary: API docs for the @kbn/analytics-shippers-elastic-v3-server plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-elastic-v3-server']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-analytics-shippers-fullstory
|
|||
title: "@kbn/analytics-shippers-fullstory"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/analytics-shippers-fullstory plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/analytics-shippers-fullstory']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-config-loader
|
|||
title: "@kbn/apm-config-loader"
|
||||
image: https://source.unsplash.com/400x175/?github
|
||||
summary: API docs for the @kbn/apm-config-loader plugin
|
||||
date: 2022-07-26
|
||||
date: 2022-07-27
|
||||
tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-config-loader']
|
||||
warning: 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.
|
||||
---
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue