diff --git a/.backportrc.json b/.backportrc.json index 5348a52e43bdc..db7ad3b0eb887 100644 --- a/.backportrc.json +++ b/.backportrc.json @@ -3,6 +3,7 @@ "repoName": "kibana", "targetBranchChoices": [ "main", + "8.4", "8.3", "8.2", "8.1", @@ -40,7 +41,7 @@ "backport" ], "branchLabelMapping": { - "^v8.4.0$": "main", + "^v8.5.0$": "main", "^v(\\d+).(\\d+).\\d+$": "$1.$2" }, "autoMerge": true, diff --git a/.buildkite/ftr_configs.yml b/.buildkite/ftr_configs.yml index 5abe469587f30..24025abc7e769 100644 --- a/.buildkite/ftr_configs.yml +++ b/.buildkite/ftr_configs.yml @@ -98,7 +98,6 @@ enabled: - test/interactive_setup_functional/manual_configuration_without_tls.config.ts - test/interactive_setup_functional/manual_configuration.config.ts - test/interpreter_functional/config.ts - - test/new_visualize_flow/config.ts - test/node_roles_functional/all.config.ts - test/node_roles_functional/background_tasks.config.ts - test/node_roles_functional/ui.config.ts diff --git a/.buildkite/pipeline-utils/ci-stats/client.ts b/.buildkite/pipeline-utils/ci-stats/client.ts index 598cf2a07f018..9044e0072e150 100644 --- a/.buildkite/pipeline-utils/ci-stats/client.ts +++ b/.buildkite/pipeline-utils/ci-stats/client.ts @@ -132,11 +132,13 @@ export class CiStatsClient { }); }; - getPrReport = async (buildId: string) => { + getPrReport = async (buildId: string, backfillJobIds: string[] = []) => { const resp = await this.request({ - path: `v2/pr_report`, - params: { + path: `v3/pr_report`, + method: 'post', + body: { buildId, + backfillJobIds, }, }); diff --git a/.buildkite/scripts/steps/es_snapshots/build.sh b/.buildkite/scripts/steps/es_snapshots/build.sh index 2e5e55c3f97b6..1ae00af473f40 100755 --- a/.buildkite/scripts/steps/es_snapshots/build.sh +++ b/.buildkite/scripts/steps/es_snapshots/build.sh @@ -14,10 +14,6 @@ mkdir -p "$destination" mkdir -p elasticsearch && cd elasticsearch export ELASTICSEARCH_BRANCH="${ELASTICSEARCH_BRANCH:-$BUILDKITE_BRANCH}" -# Until ES renames their master branch to main... -if [[ "$ELASTICSEARCH_BRANCH" == "main" ]]; then - export ELASTICSEARCH_BRANCH="master" -fi if [[ ! -d .git ]]; then git init diff --git a/api_docs/actions.devdocs.json b/api_docs/actions.devdocs.json index 8c3b40d809b7c..83285a0af7f0d 100644 --- a/api_docs/actions.devdocs.json +++ b/api_docs/actions.devdocs.json @@ -965,7 +965,7 @@ "label": "listTypes", "description": [], "signature": [ - "() => ", + "(featureId?: string | undefined) => ", { "pluginId": "actions", "scope": "common", @@ -978,7 +978,21 @@ "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false, "returnComment": [], - "children": [] + "children": [ + { + "parentPluginId": "actions", + "id": "def-server.ActionsApiRequestHandlerContext.listTypes.$1", + "type": "string", + "tags": [], + "label": "featureId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/actions/server/action_type_registry.ts", + "deprecated": false + } + ] } ], "initialIsOpen": false @@ -1100,6 +1114,19 @@ "path": "x-pack/plugins/actions/server/types.ts", "deprecated": false }, + { + "parentPluginId": "actions", + "id": "def-server.ActionType.supportedFeatureIds", + "type": "Array", + "tags": [], + "label": "supportedFeatureIds", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/actions/server/types.ts", + "deprecated": false + }, { "parentPluginId": "actions", "id": "def-server.ActionType.validate", @@ -1545,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", @@ -1637,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, @@ -1729,7 +1770,7 @@ }, "<", "ActionTypeConfig", - ">>; delete: ({ id }: { id: string; }) => Promise<{}>; get: ({ id }: { id: string; }) => Promise<", + ">>; get: ({ id }: { id: string; }) => Promise<", { "pluginId": "actions", "scope": "server", @@ -1751,7 +1792,7 @@ }, "<", "ActionTypeConfig", - ">>; getAll: () => Promise<", + ">>; delete: ({ id }: { id: string; }) => Promise<{}>; getAll: () => Promise<", { "pluginId": "actions", "scope": "server", @@ -1783,7 +1824,7 @@ "section": "def-server.RunNowResult", "text": "RunNowResult" }, - ">; listTypes: () => Promise<", + ">; listTypes: (featureId?: string | undefined) => Promise<", { "pluginId": "actions", "scope": "common", @@ -1797,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", @@ -2451,6 +2506,37 @@ "common": { "classes": [], "functions": [ + { + "parentPluginId": "actions", + "id": "def-common.areValidFeatures", + "type": "Function", + "tags": [], + "label": "areValidFeatures", + "description": [], + "signature": [ + "(ids: string[]) => boolean" + ], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.areValidFeatures.$1", + "type": "Array", + "tags": [], + "label": "ids", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "actions", "id": "def-common.buildAlertHistoryDocument", @@ -2482,6 +2568,37 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "actions", + "id": "def-common.getConnectorFeatureName", + "type": "Function", + "tags": [], + "label": "getConnectorFeatureName", + "description": [], + "signature": [ + "(id: string) => string" + ], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.getConnectorFeatureName.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "actions", "id": "def-common.hasMustacheTemplate", @@ -2911,6 +3028,19 @@ ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-common.ActionType.supportedFeatureIds", + "type": "Array", + "tags": [], + "label": "supportedFeatureIds", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -3286,6 +3416,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "actions", + "id": "def-common.AlertingConnectorFeatureId", + "type": "string", + "tags": [], + "label": "AlertingConnectorFeatureId", + "description": [], + "signature": [ + "\"alerting\"" + ], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "actions", "id": "def-common.AsApiContract", @@ -3314,6 +3458,20 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "actions", + "id": "def-common.CasesConnectorFeatureId", + "type": "string", + "tags": [], + "label": "CasesConnectorFeatureId", + "description": [], + "signature": [ + "\"cases\"" + ], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "actions", "id": "def-common.DEFAULT_ALERTS_GROUPING_KEY", @@ -3440,6 +3598,20 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "actions", + "id": "def-common.SecurityConnectorFeatureId", + "type": "string", + "tags": [], + "label": "SecurityConnectorFeatureId", + "description": [], + "signature": [ + "\"siem\"" + ], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "actions", "id": "def-common.ServiceNowITOMActionTypeId", @@ -3531,9 +3703,89 @@ "path": "x-pack/plugins/actions/common/servicenow_config.ts", "deprecated": false, "initialIsOpen": false + }, + { + "parentPluginId": "actions", + "id": "def-common.UptimeConnectorFeatureId", + "type": "string", + "tags": [], + "label": "UptimeConnectorFeatureId", + "description": [], + "signature": [ + "\"uptime\"" + ], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false, + "initialIsOpen": false } ], "objects": [ + { + "parentPluginId": "actions", + "id": "def-common.AlertingConnectorFeature", + "type": "Object", + "tags": [], + "label": "AlertingConnectorFeature", + "description": [], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.AlertingConnectorFeature.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-common.AlertingConnectorFeature.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "actions", + "id": "def-common.CasesConnectorFeature", + "type": "Object", + "tags": [], + "label": "CasesConnectorFeature", + "description": [], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.CasesConnectorFeature.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-common.CasesConnectorFeature.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "actions", "id": "def-common.MustacheInEmailRegExp", @@ -3548,6 +3800,39 @@ "deprecated": false, "initialIsOpen": false }, + { + "parentPluginId": "actions", + "id": "def-common.SecuritySolutionFeature", + "type": "Object", + "tags": [], + "label": "SecuritySolutionFeature", + "description": [], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.SecuritySolutionFeature.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-common.SecuritySolutionFeature.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "actions", "id": "def-common.snExternalServiceConfig", @@ -3775,6 +4060,39 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "actions", + "id": "def-common.UptimeConnectorFeature", + "type": "Object", + "tags": [], + "label": "UptimeConnectorFeature", + "description": [], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "actions", + "id": "def-common.UptimeConnectorFeature.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false + }, + { + "parentPluginId": "actions", + "id": "def-common.UptimeConnectorFeature.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "x-pack/plugins/actions/common/connector_feature_config.ts", + "deprecated": false + } + ], + "initialIsOpen": false } ] } diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx index 5ac6dbd9bd365..91cd2a0d4864d 100644 --- a/api_docs/actions.mdx +++ b/api_docs/actions.mdx @@ -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-25 +date: 2022-07-28 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 | |-------------------|-----------|------------------------|-----------------| -| 241 | 0 | 236 | 19 | +| 266 | 0 | 261 | 19 | ## Client diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx index 0fec295fa5200..6ffe1439d6f7c 100644 --- a/api_docs/advanced_settings.mdx +++ b/api_docs/advanced_settings.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/aiops.mdx b/api_docs/aiops.mdx index f967b22c85a53..c6026e00e921c 100644 --- a/api_docs/aiops.mdx +++ b/api_docs/aiops.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/alerting.devdocs.json b/api_docs/alerting.devdocs.json index 882b50b8524ba..37286b87f391e 100644 --- a/api_docs/alerting.devdocs.json +++ b/api_docs/alerting.devdocs.json @@ -1859,331 +1859,7 @@ "label": "savedObjectsClient", "description": [], "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; 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" }, - ">; delete: ({ id }: { id: string; }) => Promise<{}>; find: >; find: ({ 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,7 +2627,7 @@ }, " | ", "SanitizedRuleWithLegacyId", - ">; resolve: >; update: ({ id, includeLegacyId, }: { id: string; includeLegacyId?: boolean | undefined; }) => Promise<", + " = never>({ id, data, }: ", + "UpdateOptions", + ") => Promise<", { "pluginId": "alerting", - "scope": "common", + "scope": "server", "docId": "kibAlertingPluginApi", - "section": "def-common.ResolvedSanitizedRule", - "text": "ResolvedSanitizedRule" + "section": "def-server.PartialRule", + "text": "PartialRule" }, - ">; update: >; delete: ({ id }: { id: string; }) => Promise<{}>; resolve: ({ id, data, }: ", - "UpdateOptions", - ") => Promise<", + " = never>({ id, includeLegacyId, }: { id: string; includeLegacyId?: boolean | undefined; }) => Promise<", { "pluginId": "alerting", - "scope": "server", + "scope": "common", "docId": "kibAlertingPluginApi", - "section": "def-server.PartialRule", - "text": "PartialRule" + "section": "def-common.ResolvedSanitizedRule", + "text": "ResolvedSanitizedRule" }, ">; enable: ({ id }: { id: string; }) => Promise; disable: ({ id }: { id: string; }) => Promise; muteAll: ({ id }: { id: string; }) => Promise; getAlertState: ({ id }: { id: string; }) => Promise; getAlertSummary: ({ id, dateStart, numberOfExecutions, }: ", "GetAlertSummaryParams", @@ -3055,7 +2731,15 @@ "section": "def-common.RuleSnoozeSchedule", "text": "RuleSnoozeSchedule" }, - "; }) => Promise; unsnooze: ({ id, scheduleIds, }: { id: string; scheduleIds?: string[] | undefined; }) => Promise; updateSnoozedUntilTime: ({ id }: { id: string; }) => Promise; clearExpiredSnoozes: ({ id }: { id: string; }) => Promise; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", + "; }) => Promise; unsnooze: ({ id, scheduleIds, }: { id: string; scheduleIds?: string[] | undefined; }) => Promise; 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; unmuteAll: ({ id }: { id: string; }) => Promise; muteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", ") => Promise; unmuteInstance: ({ alertId, alertInstanceId }: ", "MuteOptions", @@ -5936,13 +5620,7 @@ "text": "SanitizedRule" }, " & Omit<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, + "SavedObjectsResolveResponse", ", \"saved_object\">" ], "path": "x-pack/plugins/alerting/common/rule.ts", diff --git a/api_docs/alerting.mdx b/api_docs/alerting.mdx index f8a33dc9954a6..39b73cfd4ecf5 100644 --- a/api_docs/alerting.mdx +++ b/api_docs/alerting.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/apm.devdocs.json b/api_docs/apm.devdocs.json index cd51d3e83d9da..dc84bcf71fb65 100644 --- a/api_docs/apm.devdocs.json +++ b/api_docs/apm.devdocs.json @@ -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", "; }>]>; }>, ", + "; chartType: ", + "UnionC", + "<[", + "LiteralC", + "<", + "LatencyDistributionChartType", + ".transactionLatency>, ", + "LiteralC", + "<", + "LatencyDistributionChartType", + ".latencyCorrelations>, ", + "LiteralC", + "<", + "LatencyDistributionChartType", + ".failedTransactionsCorrelations>, ", + "LiteralC", + "<", + "LatencyDistributionChartType", + ".dependencyLatency>]>; }>]>; }>, ", { "pluginId": "apm", "scope": "server", diff --git a/api_docs/apm.mdx b/api_docs/apm.mdx index 7c5955f02a982..e16aa47ab2ebc 100644 --- a/api_docs/apm.mdx +++ b/api_docs/apm.mdx @@ -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-25 +date: 2022-07-28 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 diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx index 305fd9705a851..9eb48ebd672e6 100644 --- a/api_docs/banners.mdx +++ b/api_docs/banners.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx index 8f729a1bd75d1..7aa0f6ba9bad1 100644 --- a/api_docs/bfetch.mdx +++ b/api_docs/bfetch.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx index a88f12d1aea65..ebd00252c9f68 100644 --- a/api_docs/canvas.mdx +++ b/api_docs/canvas.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/cases.devdocs.json b/api_docs/cases.devdocs.json index 01257a8b90c82..fe0026b70306c 100644 --- a/api_docs/cases.devdocs.json +++ b/api_docs/cases.devdocs.json @@ -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: ", diff --git a/api_docs/cases.mdx b/api_docs/cases.mdx index 8916379f49378..af44309ebc597 100644 --- a/api_docs/cases.mdx +++ b/api_docs/cases.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/charts.devdocs.json b/api_docs/charts.devdocs.json index bc7c2a9481445..96a9ad926a858 100644 --- a/api_docs/charts.devdocs.json +++ b/api_docs/charts.devdocs.json @@ -737,7 +737,9 @@ "signature": [ "(xInterval?: number | undefined, domainStart?: number | undefined, domainEnd?: number | undefined, formatter?: ((v: any) => string) | undefined, renderValue?: boolean) => (headerData: ", "TooltipValue", - ") => string | JSX.Element" + ") => string | JSX.Element" ], "path": "src/plugins/charts/public/static/components/endzones.tsx", "deprecated": false, diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx index cb5a8ef23a6eb..ee012a499a166 100644 --- a/api_docs/charts.mdx +++ b/api_docs/charts.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx index 80b75143f5f31..4d1838b309013 100644 --- a/api_docs/cloud.mdx +++ b/api_docs/cloud.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/cloud_security_posture.devdocs.json b/api_docs/cloud_security_posture.devdocs.json index cb6c6f086b077..4f3fe1dfefeef 100644 --- a/api_docs/cloud_security_posture.devdocs.json +++ b/api_docs/cloud_security_posture.devdocs.json @@ -5,15 +5,15 @@ "functions": [ { "parentPluginId": "cloudSecurityPosture", - "id": "def-public.getSecuritySolutionDashboardLinks", + "id": "def-public.getSecuritySolutionLink", "type": "Function", "tags": [], - "label": "getSecuritySolutionDashboardLinks", + "label": "getSecuritySolutionLink", "description": [ - "\nGets the cloud security posture links for navigation in the security solution's \"Dashboards\" section." + "\nGets the cloud security posture link properties of a CSP page for navigation in the security solution." ], "signature": [ - "(extensions?: Partial>> | undefined) => TLinkItem" + ">(cloudSecurityPosturePage: ", + "CspPage", + ") => CloudSecurityPostureLinkItem" ], "path": "x-pack/plugins/cloud_security_posture/public/common/navigation/security_solution_links.ts", "deprecated": false, "children": [ { "parentPluginId": "cloudSecurityPosture", - "id": "def-public.getSecuritySolutionDashboardLinks.$1", - "type": "Object", + "id": "def-public.getSecuritySolutionLink.$1", + "type": "CompoundType", "tags": [], - "label": "extensions", + "label": "cloudSecurityPosturePage", "description": [ - "extended configuration for the links." + "the name of the cloud posture page." ], "signature": [ - "Partial>> | undefined" + "CspPage" ], "path": "x-pack/plugins/cloud_security_posture/public/common/navigation/security_solution_links.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [], @@ -56,15 +50,15 @@ }, { "parentPluginId": "cloudSecurityPosture", - "id": "def-public.getSecuritySolutionManageLinks", + "id": "def-public.getSecuritySolutionNavTab", "type": "Function", "tags": [], - "label": "getSecuritySolutionManageLinks", + "label": "getSecuritySolutionNavTab", "description": [ - "\nGets the cloud security posture links for navigation in the security solution's \"Manage\" section." + "\nGets the cloud security posture link properties of a CSP page for navigation in the old security solution navigation." ], "signature": [ - "(extensions?: Partial>> | undefined) => TLinkItem" + ">(cloudSecurityPosturePage: ", + "CspPage", + ", basePath: string) => CloudSecurityPostureNavTab" ], "path": "x-pack/plugins/cloud_security_posture/public/common/navigation/security_solution_links.ts", "deprecated": false, "children": [ { "parentPluginId": "cloudSecurityPosture", - "id": "def-public.getSecuritySolutionManageLinks.$1", - "type": "Object", + "id": "def-public.getSecuritySolutionNavTab.$1", + "type": "CompoundType", "tags": [], - "label": "extensions", + "label": "cloudSecurityPosturePage", "description": [ - "extended configuration for the links." + "the name of the cloud posture page." ], "signature": [ - "Partial>> | undefined" + "CspPage" ], "path": "x-pack/plugins/cloud_security_posture/public/common/navigation/security_solution_links.ts", "deprecated": false, - "isRequired": false - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "cloudSecurityPosture", - "id": "def-public.getSecuritySolutionRootLinks", - "type": "Function", - "tags": [], - "label": "getSecuritySolutionRootLinks", - "description": [ - "\nGets the cloud security posture links for top-level navigation in the security solution." - ], - "signature": [ - "(extensions?: Partial>> | undefined) => TLinkItem" - ], - "path": "x-pack/plugins/cloud_security_posture/public/common/navigation/security_solution_links.ts", - "deprecated": false, - "children": [ { "parentPluginId": "cloudSecurityPosture", - "id": "def-public.getSecuritySolutionRootLinks.$1", - "type": "Object", + "id": "def-public.getSecuritySolutionNavTab.$2", + "type": "string", "tags": [], - "label": "extensions", + "label": "basePath", "description": [ - "extended configuration for the links." + "the base path for links." ], "signature": [ - "Partial>> | undefined" + "string" ], "path": "x-pack/plugins/cloud_security_posture/public/common/navigation/security_solution_links.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [], @@ -223,7 +176,8 @@ ], "signature": [ "() => ", - "BreadcrumbEntry" + "BreadcrumbEntry", + " | undefined" ], "path": "x-pack/plugins/cloud_security_posture/public/types.ts", "deprecated": false, @@ -307,15 +261,9 @@ "Gets the cloud security posture router component for embedding in the security solution." ], "signature": [ - "() => React.ComponentType<{ securitySolutionContext: ", - { - "pluginId": "cloudSecurityPosture", - "scope": "public", - "docId": "kibCloudSecurityPosturePluginApi", - "section": "def-public.CspSecuritySolutionContext", - "text": "CspSecuritySolutionContext" - }, - "; }>" + "() => React.ComponentType<", + "CspRouterProps", + ">" ], "path": "x-pack/plugins/cloud_security_posture/public/types.ts", "deprecated": false, diff --git a/api_docs/cloud_security_posture.mdx b/api_docs/cloud_security_posture.mdx index 077355b1574a5..adbf346a55b5c 100644 --- a/api_docs/cloud_security_posture.mdx +++ b/api_docs/cloud_security_posture.mdx @@ -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-25 +date: 2022-07-28 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. --- @@ -18,7 +18,7 @@ Contact [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-pos | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 19 | 0 | 2 | 1 | +| 18 | 0 | 2 | 3 | ## Client diff --git a/api_docs/console.mdx b/api_docs/console.mdx index 7fbe7aa0106bc..762e346d00d82 100644 --- a/api_docs/console.mdx +++ b/api_docs/console.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/controls.mdx b/api_docs/controls.mdx index 15491442d2922..f8c304fa8eb0d 100644 --- a/api_docs/controls.mdx +++ b/api_docs/controls.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/core.devdocs.json b/api_docs/core.devdocs.json index 3bb474a84715f..612f711183fce 100644 --- a/api_docs/core.devdocs.json +++ b/api_docs/core.devdocs.json @@ -1050,7 +1050,10 @@ "description": [ "\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n" ], - "path": "src/core/types/capabilities.ts", + "signature": [ + "Capabilities" + ], + "path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts", "deprecated": false, "children": [ { @@ -1065,7 +1068,7 @@ "signature": [ "{ [x: string]: boolean; }" ], - "path": "src/core/types/capabilities.ts", + "path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts", "deprecated": false }, { @@ -1080,7 +1083,7 @@ "signature": [ "{ [sectionId: string]: Record; }" ], - "path": "src/core/types/capabilities.ts", + "path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts", "deprecated": false }, { @@ -1095,7 +1098,7 @@ "signature": [ "{ [x: string]: boolean; }" ], - "path": "src/core/types/capabilities.ts", + "path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts", "deprecated": false }, { @@ -1110,7 +1113,7 @@ "signature": [ "[key: string]: Record>" ], - "path": "src/core/types/capabilities.ts", + "path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts", "deprecated": false } ], @@ -6820,6 +6823,86 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "core", + "id": "def-public.ResolvedSimpleSavedObject", + "type": "Interface", + "tags": [], + "label": "ResolvedSimpleSavedObject", + "description": [ + "\nThis interface is a very simple wrapper for SavedObjects resolved from the server\nwith the {@link SavedObjectsClientContract}.\n" + ], + "signature": [ + "ResolvedSimpleSavedObject", + "" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.ResolvedSimpleSavedObject.saved_object", + "type": "Object", + "tags": [], + "label": "saved_object", + "description": [ + "\nThe saved object that was found." + ], + "signature": [ + "SimpleSavedObject", + "" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.ResolvedSimpleSavedObject.outcome", + "type": "CompoundType", + "tags": [], + "label": "outcome", + "description": [ + "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." + ], + "signature": [ + "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.ResolvedSimpleSavedObject.alias_target_id", + "type": "string", + "tags": [], + "label": "alias_target_id", + "description": [ + "\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.ResolvedSimpleSavedObject.alias_purpose", + "type": "CompoundType", + "tags": [], + "label": "alias_purpose", + "description": [ + "\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + ], + "signature": [ + "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "core", "id": "def-public.ResponseErrorBody", @@ -6880,7 +6963,7 @@ "SavedObject", "" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -6892,7 +6975,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 }, { @@ -6904,7 +6987,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 }, { @@ -6919,7 +7002,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 }, { @@ -6934,7 +7017,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 }, { @@ -6948,7 +7031,7 @@ "SavedObjectError", " | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -6963,7 +7046,7 @@ "signature": [ "T" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -6979,7 +7062,7 @@ "SavedObjectReference", "[]" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -6995,7 +7078,7 @@ "SavedObjectsMigrationVersion", " | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7010,7 +7093,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 }, { @@ -7025,7 +7108,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 }, { @@ -7040,7 +7123,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 } ], @@ -7055,7 +7138,10 @@ "description": [ "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" ], - "path": "src/core/types/saved_objects.ts", + "signature": [ + "SavedObjectAttributes" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -7069,7 +7155,7 @@ "[key: string]: ", "SavedObjectAttribute" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -7082,7 +7168,10 @@ "tags": [], "label": "SavedObjectError", "description": [], - "path": "src/core/types/saved_objects.ts", + "signature": [ + "SavedObjectError" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -7092,7 +7181,7 @@ "tags": [], "label": "error", "description": [], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7102,7 +7191,7 @@ "tags": [], "label": "message", "description": [], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7112,7 +7201,7 @@ "tags": [], "label": "statusCode", "description": [], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7125,7 +7214,7 @@ "signature": [ "Record | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -7140,7 +7229,10 @@ "description": [ "\nA reference to another saved object.\n" ], - "path": "src/core/types/saved_objects.ts", + "signature": [ + "SavedObjectReference" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -7150,7 +7242,7 @@ "tags": [], "label": "name", "description": [], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7160,7 +7252,7 @@ "tags": [], "label": "type", "description": [], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7170,7 +7262,7 @@ "tags": [], "label": "id", "description": [], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -7178,128 +7270,30 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext", + "id": "def-public.SavedObjectsBatchResponse", "type": "Interface", "tags": [], - "label": "SavedObjectReferenceWithContext", - "description": [ - "\nA returned input object or one of its references, with additional context.\n" + "label": "SavedObjectsBatchResponse", + "description": [], + "signature": [ + "SavedObjectsBatchResponse", + "" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "The type of the referenced object" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "The ID of the referenced object" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.originId", - "type": "string", - "tags": [], - "label": "originId", - "description": [ - "The origin ID of the referenced object (if it has one)" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.spaces", - "type": "Array", - "tags": [], - "label": "spaces", - "description": [ - "The space(s) that the referenced object exists in" - ], - "signature": [ - "string[]" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.inboundReferences", - "type": "Array", - "tags": [], - "label": "inboundReferences", - "description": [ - "\nReferences to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains\ninbound references for the scope of this operation" - ], - "signature": [ - "{ type: string; id: string; name: string; }[]" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.isMissing", - "type": "CompoundType", - "tags": [], - "label": "isMissing", - "description": [ - "Whether or not this object or reference is missing" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.spacesWithMatchingAliases", - "type": "Array", - "tags": [], - "label": "spacesWithMatchingAliases", - "description": [ - "The space(s) that legacy URL aliases matching this type/id exist in" - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectReferenceWithContext.spacesWithMatchingOrigins", + "id": "def-public.SavedObjectsBatchResponse.savedObjects", "type": "Array", "tags": [], - "label": "spacesWithMatchingOrigins", - "description": [ - "The space(s) that objects matching this origin exist in (including this one)" - ], + "label": "savedObjects", + "description": [], "signature": [ - "string[] | undefined" + "SimpleSavedObject", + "[]" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false } ], @@ -7307,29 +7301,40 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBaseOptions", + "id": "def-public.SavedObjectsBulkCreateObject", "type": "Interface", "tags": [], - "label": "SavedObjectsBaseOptions", - "description": [ - "\n" + "label": "SavedObjectsBulkCreateObject", + "description": [], + "signature": [ + "SavedObjectsBulkCreateObject", + " extends ", + "SavedObjectsCreateOptions" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsBaseOptions.namespace", + "id": "def-public.SavedObjectsBulkCreateObject.type", "type": "string", "tags": [], - "label": "namespace", - "description": [ - "Specify the namespace for this operation" - ], + "label": "type", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkCreateObject.attributes", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], "signature": [ - "string | undefined" + "T" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false } ], @@ -7337,34 +7342,30 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkResolveObject", + "id": "def-public.SavedObjectsBulkCreateOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsBulkResolveObject", - "description": [ - "\n" + "label": "SavedObjectsBulkCreateOptions", + "description": [], + "signature": [ + "SavedObjectsBulkCreateOptions" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkResolveObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkResolveObject.type", - "type": "string", + "id": "def-public.SavedObjectsBulkCreateOptions.overwrite", + "type": "CompoundType", "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "label": "overwrite", + "description": [ + "If a document with the given `id` already exists, overwrite it's contents (default=false)." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false } ], @@ -7372,34 +7373,30 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsCollectMultiNamespaceReferencesResponse", + "id": "def-public.SavedObjectsBulkResolveResponse", "type": "Interface", "tags": [], - "label": "SavedObjectsCollectMultiNamespaceReferencesResponse", - "description": [ - "\nThe response when object references are collected.\n" + "label": "SavedObjectsBulkResolveResponse", + "description": [], + "signature": [ + "SavedObjectsBulkResolveResponse", + "" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsCollectMultiNamespaceReferencesResponse.objects", + "id": "def-public.SavedObjectsBulkResolveResponse.resolved_objects", "type": "Array", "tags": [], - "label": "objects", + "label": "resolved_objects", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectReferenceWithContext", - "text": "SavedObjectReferenceWithContext" - }, - "[]" + "ResolvedSimpleSavedObject", + "[]" ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false } ], @@ -7407,312 +7404,784 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions", + "id": "def-public.SavedObjectsBulkUpdateObject", "type": "Interface", "tags": [], - "label": "SavedObjectsFindOptions", - "description": [ - "\n" + "label": "SavedObjectsBulkUpdateObject", + "description": [], + "signature": [ + "SavedObjectsBulkUpdateObject", + "" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.type", - "type": "CompoundType", + "id": "def-public.SavedObjectsBulkUpdateObject.type", + "type": "string", "tags": [], "label": "type", "description": [], - "signature": [ - "string | string[]" - ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.page", - "type": "number", + "id": "def-public.SavedObjectsBulkUpdateObject.id", + "type": "string", "tags": [], - "label": "page", + "label": "id", "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.perPage", - "type": "number", + "id": "def-public.SavedObjectsBulkUpdateObject.attributes", + "type": "Uncategorized", "tags": [], - "label": "perPage", + "label": "attributes", "description": [], "signature": [ - "number | undefined" + "T" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.sortField", + "id": "def-public.SavedObjectsBulkUpdateObject.version", "type": "string", "tags": [], - "label": "sortField", + "label": "version", "description": [], "signature": [ "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.sortOrder", - "type": "CompoundType", + "id": "def-public.SavedObjectsBulkUpdateObject.references", + "type": "Array", "tags": [], - "label": "sortOrder", + "label": "references", "description": [], "signature": [ - "SortOrder", - " | undefined" + "SavedObjectReference", + "[] | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsBulkUpdateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkUpdateOptions", + "description": [], + "signature": [ + "SavedObjectsBulkUpdateOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.fields", - "type": "Array", + "id": "def-public.SavedObjectsBulkUpdateOptions.namespace", + "type": "string", "tags": [], - "label": "fields", - "description": [ - "\nAn array of fields to include in the results" - ], + "label": "namespace", + "description": [], "signature": [ - "string[] | undefined" + "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract", + "type": "Interface", + "tags": [], + "label": "SavedObjectsClientContract", + "description": [ + "\nThe client-side SavedObjectsClient is a thin convenience library around the SavedObjects\nHTTP API for interacting with Saved Objects.\n" + ], + "signature": [ + "SavedObjectsClientContract" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.search", - "type": "string", + "id": "def-public.SavedObjectsClientContract.create", + "type": "Function", "tags": [], - "label": "search", + "label": "create", "description": [ - "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" + "\nPersists an object" ], "signature": [ - "string | undefined" + "(type: string, attributes: T, options?: ", + "SavedObjectsCreateOptions", + " | undefined) => Promise<", + "SimpleSavedObject", + ">" ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.create.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.create.$2", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.create.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsCreateOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.searchFields", - "type": "Array", + "id": "def-public.SavedObjectsClientContract.bulkCreate", + "type": "Function", "tags": [], - "label": "searchFields", + "label": "bulkCreate", "description": [ - "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" + "\nCreates multiple documents at once" ], "signature": [ - "string[] | undefined" + "(objects: ", + "SavedObjectsBulkCreateObject", + "[], options?: ", + "SavedObjectsBulkCreateOptions", + " | undefined) => Promise<", + "SavedObjectsBatchResponse", + ">" ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.bulkCreate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "SavedObjectsBulkCreateObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.bulkCreate.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBulkCreateOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "The result of the create operation containing created saved objects." + ] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.searchAfter", - "type": "Array", + "id": "def-public.SavedObjectsClientContract.delete", + "type": "Function", "tags": [], - "label": "searchAfter", + "label": "delete", "description": [ - "\nUse the sort values from the previous page to retrieve the next page of results." + "\nDeletes an object" ], "signature": [ - "string[] | undefined" + "(type: string, id: string, options?: ", + "SavedObjectsDeleteOptions", + " | undefined) => Promise<{}>" ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.delete.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.delete.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.delete.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsDeleteOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.rootSearchFields", - "type": "Array", - "tags": [], - "label": "rootSearchFields", + "id": "def-public.SavedObjectsClientContract.find", + "type": "Function", + "tags": [ + "property", + "property", + "property", + "property", + "property", + "property", + "property" + ], + "label": "find", "description": [ - "\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together." + "\nSearch for objects\n" ], "signature": [ - "string[] | undefined" + "(options: ", + "SavedObjectsFindOptions", + ") => Promise<", + "SavedObjectsFindResponse", + ">" ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.find.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsFindOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "A find result with objects matching the specified search." + ] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.hasReference", - "type": "CompoundType", + "id": "def-public.SavedObjectsClientContract.get", + "type": "Function", "tags": [], - "label": "hasReference", + "label": "get", "description": [ - "\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references." + "\nFetches a single object\n" ], "signature": [ + "(type: string, id: string) => Promise<", + "SimpleSavedObject", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.get.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true }, - " | ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, - "[] | undefined" + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.get.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "returnComment": [ + "The saved object for the given type and id." + ] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.hasReferenceOperator", - "type": "CompoundType", + "id": "def-public.SavedObjectsClientContract.bulkGet", + "type": "Function", "tags": [], - "label": "hasReferenceOperator", + "label": "bulkGet", "description": [ - "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" + "\nReturns an array of objects by id\n" ], "signature": [ - "\"AND\" | \"OR\" | undefined" + "(objects: ", + "SavedObjectTypeIdTuple", + "[]) => Promise<", + "SavedObjectsBatchResponse", + ">" ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.defaultSearchOperator", - "type": "CompoundType", - "tags": [], - "label": "defaultSearchOperator", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.bulkGet.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array ids, or an array of objects containing id and optionally type" + ], + "signature": [ + "SavedObjectTypeIdTuple", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The saved objects with the given type and ids requested" + ] + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.resolve", + "type": "Function", + "tags": [ + "note" + ], + "label": "resolve", "description": [ - "\nThe search operator to use with the provided filter. Defaults to `OR`" + "\nResolves a single object\n" ], "signature": [ - "\"AND\" | \"OR\" | undefined" + "(type: string, id: string) => Promise<", + "ResolvedSimpleSavedObject", + ">" ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.resolve.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.resolve.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The resolve result for the saved object for the given type and id." + ] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.filter", - "type": "Any", - "tags": [], - "label": "filter", - "description": [], + "id": "def-public.SavedObjectsClientContract.bulkResolve", + "type": "Function", + "tags": [ + "note" + ], + "label": "bulkResolve", + "description": [ + "\nResolves an array of objects by id, using any legacy URL aliases if they exist\n" + ], "signature": [ - "any" + "(objects: ", + "SavedObjectTypeIdTuple", + "[]) => Promise<", + "SavedObjectsBulkResolveResponse", + ">" ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.bulkResolve.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array of objects containing id, type" + ], + "signature": [ + "SavedObjectTypeIdTuple", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The bulk resolve result for the saved objects for the given types and ids." + ] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.aggs", - "type": "Object", + "id": "def-public.SavedObjectsClientContract.update", + "type": "Function", "tags": [ - "alpha" + "prop", + "prop" ], - "label": "aggs", + "label": "update", "description": [ - "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" + "\nUpdates an object\n" ], "signature": [ - "Record | undefined" + "(type: string, id: string, attributes: T, options?: ", + "SavedObjectsUpdateOptions", + " | undefined) => Promise<", + "SimpleSavedObject", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.update.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.update.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.update.$3", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.update.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsUpdateOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.bulkUpdate", + "type": "Function", + "tags": [], + "label": "bulkUpdate", + "description": [ + "\nUpdate multiple documents at once\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsBulkUpdateObject", + "[]) => Promise<", + "SavedObjectsBatchResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsClientContract.bulkUpdate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- [{ type, id, attributes, options: { version, references } }]" + ], + "signature": [ + "SavedObjectsBulkUpdateObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The result of the update operation containing both failed and updated saved objects." + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsCreateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCreateOptions", + "description": [], + "signature": [ + "SavedObjectsCreateOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsCreateOptions.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\n(Not recommended) Specify an id instead of having the saved objects service generate one for you." + ], + "signature": [ + "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.namespaces", - "type": "Array", + "id": "def-public.SavedObjectsCreateOptions.overwrite", + "type": "CompoundType", "tags": [], - "label": "namespaces", - "description": [], + "label": "overwrite", + "description": [ + "If a document with the given `id` already exists, overwrite it's contents (default=false)." + ], "signature": [ - "string[] | undefined" + "boolean | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.typeToNamespacesMap", + "id": "def-public.SavedObjectsCreateOptions.migrationVersion", "type": "Object", "tags": [], - "label": "typeToNamespacesMap", + "label": "migrationVersion", "description": [ - "\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace." + "{@inheritDoc SavedObjectsMigrationVersion}" ], "signature": [ - "Map | undefined" + "SavedObjectsMigrationVersion", + " | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.preference", + "id": "def-public.SavedObjectsCreateOptions.coreMigrationVersion", "type": "string", "tags": [], - "label": "preference", + "label": "coreMigrationVersion", "description": [ - "An optional ES preference value to be used for the query" + "A semver value that is used when upgrading objects between Kibana versions." ], "signature": [ "string | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindOptions.pit", - "type": "Object", + "id": "def-public.SavedObjectsCreateOptions.references", + "type": "Array", "tags": [], - "label": "pit", + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsDeleteOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsDeleteOptions", + "description": [], + "signature": [ + "SavedObjectsDeleteOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsDeleteOptions.force", + "type": "CompoundType", + "tags": [], + "label": "force", "description": [ - "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." + "Force deletion of an object that exists in multiple namespaces" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsPitParams", - "text": "SavedObjectsPitParams" - }, - " | undefined" + "boolean | undefined" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false } ], @@ -7725,7 +8194,10 @@ "tags": [], "label": "SavedObjectsFindOptionsReference", "description": [], - "path": "src/core/server/saved_objects/types.ts", + "signature": [ + "SavedObjectsFindOptionsReference" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false, "children": [ { @@ -7735,7 +8207,7 @@ "tags": [], "label": "type", "description": [], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { @@ -7745,7 +8217,7 @@ "tags": [], "label": "id", "description": [], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false } ], @@ -7753,14 +8225,81 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportActionRequiredWarning", + "id": "def-public.SavedObjectsFindResponse", "type": "Interface", "tags": [], - "label": "SavedObjectsImportActionRequiredWarning", + "label": "SavedObjectsFindResponse", "description": [ - "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" + "\nReturn type of the Saved Objects `find()` method.\n" + ], + "signature": [ + "SavedObjectsFindResponse", + " extends ", + "SavedObjectsBatchResponse", + "" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindResponse.aggregations", + "type": "Uncategorized", + "tags": [], + "label": "aggregations", + "description": [], + "signature": [ + "A | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindResponse.total", + "type": "number", + "tags": [], + "label": "total", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindResponse.perPage", + "type": "number", + "tags": [], + "label": "perPage", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsFindResponse.page", + "type": "number", + "tags": [], + "label": "page", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportActionRequiredWarning", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportActionRequiredWarning", + "description": [ + "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" + ], + "signature": [ + "SavedObjectsImportActionRequiredWarning" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -7773,7 +8312,7 @@ "signature": [ "\"action_required\"" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7785,7 +8324,7 @@ "description": [ "The translated message to display to the user." ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7797,7 +8336,7 @@ "description": [ "The path (without the basePath) that the user should be redirect to address this warning." ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7812,7 +8351,7 @@ "signature": [ "string | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -7827,7 +8366,10 @@ "description": [ "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "SavedObjectsImportAmbiguousConflictError" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -7840,7 +8382,7 @@ "signature": [ "\"ambiguous_conflict\"" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7853,7 +8395,7 @@ "signature": [ "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -7868,7 +8410,10 @@ "description": [ "\nRepresents a failure to import due to a conflict." ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "SavedObjectsImportConflictError" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -7881,7 +8426,7 @@ "signature": [ "\"conflict\"" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7894,7 +8439,7 @@ "signature": [ "string | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -7909,7 +8454,10 @@ "description": [ "\nRepresents a failure to import." ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "SavedObjectsImportFailure" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -7919,7 +8467,7 @@ "tags": [], "label": "id", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7929,7 +8477,7 @@ "tags": [], "label": "type", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7942,7 +8490,7 @@ "signature": [ "{ title?: string | undefined; icon?: string | undefined; }" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7957,7 +8505,7 @@ "signature": [ "boolean | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -7968,47 +8516,17 @@ "label": "error", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportConflictError", - "text": "SavedObjectsImportConflictError" - }, + "SavedObjectsImportConflictError", " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportAmbiguousConflictError", - "text": "SavedObjectsImportAmbiguousConflictError" - }, + "SavedObjectsImportAmbiguousConflictError", " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportUnsupportedTypeError", - "text": "SavedObjectsImportUnsupportedTypeError" - }, + "SavedObjectsImportUnsupportedTypeError", " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportMissingReferencesError", - "text": "SavedObjectsImportMissingReferencesError" - }, + "SavedObjectsImportMissingReferencesError", " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportUnknownError", - "text": "SavedObjectsImportUnknownError" - } + "SavedObjectsImportUnknownError" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -8023,7 +8541,10 @@ "description": [ "\nRepresents a failure to import due to missing references." ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "SavedObjectsImportMissingReferencesError" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -8036,7 +8557,7 @@ "signature": [ "\"missing_references\"" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8049,7 +8570,7 @@ "signature": [ "{ type: string; id: string; }[]" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -8064,7 +8585,10 @@ "description": [ "\nThe response describing the result of an import." ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "SavedObjectsImportResponse" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -8074,7 +8598,7 @@ "tags": [], "label": "success", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8084,7 +8608,7 @@ "tags": [], "label": "successCount", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8095,16 +8619,10 @@ "label": "successResults", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportSuccess", - "text": "SavedObjectsImportSuccess" - }, + "SavedObjectsImportSuccess", "[] | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8115,16 +8633,10 @@ "label": "warnings", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportWarning", - "text": "SavedObjectsImportWarning" - }, + "SavedObjectsImportWarning", "[]" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8135,16 +8647,10 @@ "label": "errors", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportFailure", - "text": "SavedObjectsImportFailure" - }, + "SavedObjectsImportFailure", "[] | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -8159,7 +8665,10 @@ "description": [ "\nDescribes a retry operation for importing a saved object." ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "SavedObjectsImportRetry" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -8169,7 +8678,7 @@ "tags": [], "label": "type", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8179,7 +8688,7 @@ "tags": [], "label": "id", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8189,7 +8698,7 @@ "tags": [], "label": "overwrite", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8204,7 +8713,7 @@ "signature": [ "string | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8217,7 +8726,7 @@ "signature": [ "{ type: string; from: string; to: string; }[]" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8232,7 +8741,7 @@ "signature": [ "boolean | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8247,7 +8756,7 @@ "signature": [ "boolean | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -8262,7 +8771,10 @@ "description": [ "\nA simple informative warning that will be displayed to the user.\n" ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "SavedObjectsImportSimpleWarning" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -8275,7 +8787,7 @@ "signature": [ "\"simple\"" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8287,7 +8799,7 @@ "description": [ "The translated message to display to the user" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -8302,7 +8814,10 @@ "description": [ "\nRepresents a successful import." ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "SavedObjectsImportSuccess" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -8312,7 +8827,7 @@ "tags": [], "label": "id", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8322,7 +8837,7 @@ "tags": [], "label": "type", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8337,7 +8852,7 @@ "signature": [ "string | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8352,7 +8867,7 @@ "signature": [ "boolean | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": true, "references": [ { @@ -8375,7 +8890,7 @@ "signature": [ "{ title?: string | undefined; icon?: string | undefined; }" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8390,7 +8905,7 @@ "signature": [ "boolean | undefined" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -8405,7 +8920,10 @@ "description": [ "\nRepresents a failure to import due to an unknown reason." ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "SavedObjectsImportUnknownError" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -8418,7 +8936,7 @@ "signature": [ "\"unknown\"" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8428,7 +8946,7 @@ "tags": [], "label": "message", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { @@ -8438,7 +8956,7 @@ "tags": [], "label": "statusCode", "description": [], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -8453,7 +8971,10 @@ "description": [ "\nRepresents a failure to import due to having an unsupported saved object type." ], - "path": "src/core/server/saved_objects/import/types.ts", + "signature": [ + "SavedObjectsImportUnsupportedTypeError" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -8466,7 +8987,7 @@ "signature": [ "\"unsupported_type\"" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -8481,7 +9002,10 @@ "description": [ "\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n" ], - "path": "src/core/types/saved_objects.ts", + "signature": [ + "SavedObjectsMigrationVersion" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { @@ -8494,7 +9018,7 @@ "signature": [ "[pluginName: string]: string" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -8502,85 +9026,98 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse", + "id": "def-public.SavedObjectsUpdateOptions", "type": "Interface", "tags": [], - "label": "SavedObjectsResolveResponse", - "description": [ - "\n" - ], + "label": "SavedObjectsUpdateOptions", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - "" + "SavedObjectsUpdateOptions", + "" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse.saved_object", - "type": "Object", + "id": "def-public.SavedObjectsUpdateOptions.version", + "type": "string", "tags": [], - "label": "saved_object", - "description": [ - "\nThe saved object that was found." - ], + "label": "version", + "description": [], "signature": [ - "SavedObject", - "" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse.outcome", - "type": "CompoundType", + "id": "def-public.SavedObjectsUpdateOptions.upsert", + "type": "Uncategorized", "tags": [], - "label": "outcome", - "description": [ - "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." - ], + "label": "upsert", + "description": [], "signature": [ - "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" + "Attributes | undefined" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse.alias_target_id", + "id": "def-public.SavedObjectsUpdateOptions.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectTypeIdTuple", + "type": "Interface", + "tags": [], + "label": "SavedObjectTypeIdTuple", + "description": [ + "\nAn identifier for a saved object within a space.\n" + ], + "signature": [ + "SavedObjectTypeIdTuple" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SavedObjectTypeIdTuple.id", "type": "string", "tags": [], - "label": "alias_target_id", + "label": "id", "description": [ - "\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." - ], - "signature": [ - "string | undefined" + "The id of the saved object" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsResolveResponse.alias_purpose", - "type": "CompoundType", + "id": "def-public.SavedObjectTypeIdTuple.type", + "type": "string", "tags": [], - "label": "alias_purpose", + "label": "type", "description": [ - "\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." - ], - "signature": [ - "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" + "The type of the saved object" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -8669,457 +9206,458 @@ }, { "parentPluginId": "core", - "id": "def-public.TelemetryCounter", + "id": "def-public.SimpleSavedObject", "type": "Interface", "tags": [], - "label": "TelemetryCounter", + "label": "SimpleSavedObject", "description": [ - "\nShape of the events emitted by the telemetryCounter$ observable" + "\nVery simple wrapper for SavedObjects loaded from the server\nwith the {@link SavedObjectsClientContract}.\n\nIt provides basic functionality for creating/saving/deleting saved objects,\nbut doesn't include any type-specific implementations.\n" ], "signature": [ - "TelemetryCounter" + "SimpleSavedObject", + "" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.TelemetryCounter.type", - "type": "CompoundType", + "id": "def-public.SimpleSavedObject.attributes", + "type": "Uncategorized", "tags": [], - "label": "type", - "description": [ - "\n{@link TelemetryCounterType}" - ], + "label": "attributes", + "description": [], "signature": [ - "\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\"" + "T" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.TelemetryCounter.source", + "id": "def-public.SimpleSavedObject._version", "type": "string", "tags": [], - "label": "source", - "description": [ - "\nWho emitted the event? It can be \"client\" or the name of the shipper." + "label": "_version", + "description": [], + "signature": [ + "string | undefined" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.TelemetryCounter.event_type", + "id": "def-public.SimpleSavedObject.id", "type": "string", "tags": [], - "label": "event_type", - "description": [ - "\nThe event type the success/failure/drop event refers to." - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "label": "id", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.TelemetryCounter.code", + "id": "def-public.SimpleSavedObject.type", "type": "string", "tags": [], - "label": "code", - "description": [ - "\nCode to provide additional information about the success or failure. Examples are 200/400/504/ValidationError/UnknownError" - ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "label": "type", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.TelemetryCounter.count", - "type": "number", + "id": "def-public.SimpleSavedObject.migrationVersion", + "type": "Object", "tags": [], - "label": "count", - "description": [ - "\nThe number of events that this counter refers to." + "label": "migrationVersion", + "description": [], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" ], - "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.ThemeServiceSetup", - "type": "Interface", - "tags": [], - "label": "ThemeServiceSetup", - "description": [], - "signature": [ - "ThemeServiceSetup" - ], - "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.ThemeServiceSetup.theme$", - "type": "Object", + "id": "def-public.SimpleSavedObject.coreMigrationVersion", + "type": "string", "tags": [], - "label": "theme$", + "label": "coreMigrationVersion", "description": [], "signature": [ - "Observable", - "<", - "CoreTheme", - ">" + "string | undefined" ], - "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.ThemeServiceStart", - "type": "Interface", - "tags": [], - "label": "ThemeServiceStart", - "description": [], - "signature": [ - "ThemeServiceStart" - ], - "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.ThemeServiceStart.theme$", + "id": "def-public.SimpleSavedObject.error", "type": "Object", "tags": [], - "label": "theme$", + "label": "error", "description": [], "signature": [ - "Observable", - "<", - "CoreTheme", - ">" + "SavedObjectError", + " | undefined" ], - "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.ToastOptions", - "type": "Interface", - "tags": [], - "label": "ToastOptions", - "description": [ - "\nOptions available for {@link IToasts} APIs." - ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.ToastOptions.toastLifeTimeMs", - "type": "number", + "id": "def-public.SimpleSavedObject.references", + "type": "Array", "tags": [], - "label": "toastLifeTimeMs", - "description": [ - "\nHow long should the toast remain on screen." - ], + "label": "references", + "description": [], "signature": [ - "number | undefined" + "SavedObjectReference", + "[]" ], - "path": "src/core/public/notifications/toasts/toasts_api.tsx", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.UiSettingsParams", - "type": "Interface", - "tags": [], - "label": "UiSettingsParams", - "description": [ - "\nUiSettings parameters defined by the plugins." - ], - "signature": [ - "UiSettingsParams", - "" - ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.name", + "id": "def-public.SimpleSavedObject.updatedAt", "type": "string", "tags": [], - "label": "name", - "description": [ - "title in the UI" - ], + "label": "updatedAt", + "description": [], "signature": [ "string | undefined" ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.value", - "type": "Uncategorized", + "id": "def-public.SimpleSavedObject.namespaces", + "type": "Array", "tags": [], - "label": "value", + "label": "namespaces", "description": [ - "default value to fall back to if a user doesn't provide any" + "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." ], "signature": [ - "T | undefined" + "string[] | undefined" ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.description", - "type": "string", + "id": "def-public.SimpleSavedObject.get", + "type": "Function", "tags": [], - "label": "description", - "description": [ - "description provided to a user in UI" - ], + "label": "get", + "description": [], "signature": [ - "string | undefined" + "(key: string) => any" ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.get.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.category", - "type": "Array", + "id": "def-public.SimpleSavedObject.set", + "type": "Function", "tags": [], - "label": "category", - "description": [ - "used to group the configured setting in the UI" - ], + "label": "set", + "description": [], "signature": [ - "string[] | undefined" + "(key: string, value: any) => T" ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.set.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.set.$2", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.options", - "type": "CompoundType", + "id": "def-public.SimpleSavedObject.has", + "type": "Function", "tags": [], - "label": "options", - "description": [ - "array of permitted values for this setting" - ], + "label": "has", + "description": [], "signature": [ - "number[] | string[] | undefined" + "(key: string) => boolean" ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.SimpleSavedObject.has.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.optionLabels", - "type": "Object", + "id": "def-public.SimpleSavedObject.save", + "type": "Function", "tags": [], - "label": "optionLabels", - "description": [ - "text labels for 'select' type UI element" - ], + "label": "save", + "description": [], "signature": [ - "Record | undefined" + "() => Promise<", + "SimpleSavedObject", + ">" ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", - "deprecated": false + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.requiresPageReload", - "type": "CompoundType", + "id": "def-public.SimpleSavedObject.delete", + "type": "Function", "tags": [], - "label": "requiresPageReload", - "description": [ - "a flag indicating whether new value applying requires page reloading" - ], + "label": "delete", + "description": [], "signature": [ - "boolean | undefined" + "() => Promise<{}>" ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", - "deprecated": false - }, + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.TelemetryCounter", + "type": "Interface", + "tags": [], + "label": "TelemetryCounter", + "description": [ + "\nShape of the events emitted by the telemetryCounter$ observable" + ], + "signature": [ + "TelemetryCounter" + ], + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.readonly", + "id": "def-public.TelemetryCounter.type", "type": "CompoundType", "tags": [], - "label": "readonly", + "label": "type", "description": [ - "a flag indicating that value cannot be changed" + "\n{@link TelemetryCounterType}" ], "signature": [ - "boolean | undefined" + "\"failed\" | \"enqueued\" | \"sent_to_shipper\" | \"succeeded\" | \"dropped\"" ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.sensitive", - "type": "CompoundType", + "id": "def-public.TelemetryCounter.source", + "type": "string", "tags": [], - "label": "sensitive", + "label": "source", "description": [ - "\na flag indicating that value might contain user sensitive data.\nused by telemetry to mask the value of the setting when sent." - ], - "signature": [ - "boolean | undefined" + "\nWho emitted the event? It can be \"client\" or the name of the shipper." ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.type", - "type": "CompoundType", + "id": "def-public.TelemetryCounter.event_type", + "type": "string", "tags": [], - "label": "type", + "label": "event_type", "description": [ - "defines a type of UI element {@link UiSettingsType}" - ], - "signature": [ - "UiSettingsType", - " | undefined" + "\nThe event type the success/failure/drop event refers to." ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.deprecation", - "type": "Object", + "id": "def-public.TelemetryCounter.code", + "type": "string", "tags": [], - "label": "deprecation", + "label": "code", "description": [ - "optional deprecation information. Used to generate a deprecation warning." - ], - "signature": [ - "DeprecationSettings", - " | undefined" + "\nCode to provide additional information about the success or failure. Examples are 200/400/504/ValidationError/UnknownError" ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.order", + "id": "def-public.TelemetryCounter.count", "type": "number", "tags": [], - "label": "order", + "label": "count", "description": [ - "\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n" - ], - "signature": [ - "number | undefined" + "\nThe number of events that this counter refers to." ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "path": "node_modules/@types/kbn__analytics-client/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ThemeServiceSetup", + "type": "Interface", + "tags": [], + "label": "ThemeServiceSetup", + "description": [], + "signature": [ + "ThemeServiceSetup" + ], + "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.schema", + "id": "def-public.ThemeServiceSetup.theme$", "type": "Object", "tags": [], - "label": "schema", + "label": "theme$", "description": [], "signature": [ - "Type", - "" + "Observable", + "<", + "CoreTheme", + ">" ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.ThemeServiceStart", + "type": "Interface", + "tags": [], + "label": "ThemeServiceStart", + "description": [], + "signature": [ + "ThemeServiceStart" + ], + "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.UiSettingsParams.metric", + "id": "def-public.ThemeServiceStart.theme$", "type": "Object", - "tags": [ - "deprecated" - ], - "label": "metric", - "description": [ - "\nMetric to track once this property changes" - ], + "tags": [], + "label": "theme$", + "description": [], "signature": [ - "{ type: string; name: string; } | undefined" + "Observable", + "<", + "CoreTheme", + ">" ], - "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", - "deprecated": true, - "references": [ - { - "plugin": "advancedSettings", - "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/server/ui_settings.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/server/ui_settings.ts" - }, - { - "plugin": "discover", - "path": "src/plugins/discover/server/ui_settings.ts" - } - ] + "path": "node_modules/@types/kbn__core-theme-browser/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.UiSettingsState", + "id": "def-public.ToastOptions", "type": "Interface", "tags": [], - "label": "UiSettingsState", - "description": [], - "signature": [ - "UiSettingsState" + "label": "ToastOptions", + "description": [ + "\nOptions available for {@link IToasts} APIs." ], - "path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts", + "path": "src/core/public/notifications/toasts/toasts_api.tsx", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.UiSettingsState.Unnamed", - "type": "IndexSignature", + "id": "def-public.ToastOptions.toastLifeTimeMs", + "type": "number", "tags": [], - "label": "[key: string]: PublicUiSettingsParams & UserProvidedValues", - "description": [], + "label": "toastLifeTimeMs", + "description": [ + "\nHow long should the toast remain on screen." + ], "signature": [ - "[key: string]: ", - "PublicUiSettingsParams", - " & ", - "UserProvidedValues", - "" + "number | undefined" ], - "path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts", + "path": "src/core/public/notifications/toasts/toasts_api.tsx", "deprecated": false } ], @@ -9127,15 +9665,15 @@ }, { "parentPluginId": "core", - "id": "def-public.UserProvidedValues", + "id": "def-public.UiSettingsParams", "type": "Interface", "tags": [], - "label": "UserProvidedValues", + "label": "UiSettingsParams", "description": [ - "\nDescribes the values explicitly set by user." + "\nUiSettings parameters defined by the plugins." ], "signature": [ - "UserProvidedValues", + "UiSettingsParams", "" ], "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", @@ -9143,11 +9681,28 @@ "children": [ { "parentPluginId": "core", - "id": "def-public.UserProvidedValues.userValue", + "id": "def-public.UiSettingsParams.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "title in the UI" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.value", "type": "Uncategorized", "tags": [], - "label": "userValue", - "description": [], + "label": "value", + "description": [ + "default value to fall back to if a user doesn't provide any" + ], "signature": [ "T | undefined" ], @@ -9156,31 +9711,297 @@ }, { "parentPluginId": "core", - "id": "def-public.UserProvidedValues.isOverridden", + "id": "def-public.UiSettingsParams.description", + "type": "string", + "tags": [], + "label": "description", + "description": [ + "description provided to a user in UI" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.category", + "type": "Array", + "tags": [], + "label": "category", + "description": [ + "used to group the configured setting in the UI" + ], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.options", "type": "CompoundType", "tags": [], - "label": "isOverridden", - "description": [], + "label": "options", + "description": [ + "array of permitted values for this setting" + ], "signature": [ - "boolean | undefined" + "number[] | string[] | undefined" ], "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", "deprecated": false - } - ], - "initialIsOpen": false - } - ], - "enums": [], - "misc": [ - { - "parentPluginId": "core", - "id": "def-public.AnalyticsServiceSetup", - "type": "Type", - "tags": [], - "label": "AnalyticsServiceSetup", - "description": [ - "\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}" + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.optionLabels", + "type": "Object", + "tags": [], + "label": "optionLabels", + "description": [ + "text labels for 'select' type UI element" + ], + "signature": [ + "Record | undefined" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.requiresPageReload", + "type": "CompoundType", + "tags": [], + "label": "requiresPageReload", + "description": [ + "a flag indicating whether new value applying requires page reloading" + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.readonly", + "type": "CompoundType", + "tags": [], + "label": "readonly", + "description": [ + "a flag indicating that value cannot be changed" + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.sensitive", + "type": "CompoundType", + "tags": [], + "label": "sensitive", + "description": [ + "\na flag indicating that value might contain user sensitive data.\nused by telemetry to mask the value of the setting when sent." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [ + "defines a type of UI element {@link UiSettingsType}" + ], + "signature": [ + "UiSettingsType", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.deprecation", + "type": "Object", + "tags": [], + "label": "deprecation", + "description": [ + "optional deprecation information. Used to generate a deprecation warning." + ], + "signature": [ + "DeprecationSettings", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.order", + "type": "number", + "tags": [], + "label": "order", + "description": [ + "\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n" + ], + "signature": [ + "number | undefined" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.schema", + "type": "Object", + "tags": [], + "label": "schema", + "description": [], + "signature": [ + "Type", + "" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsParams.metric", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "metric", + "description": [ + "\nMetric to track once this property changes" + ], + "signature": [ + "{ type: string; name: string; } | undefined" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": true, + "references": [ + { + "plugin": "advancedSettings", + "path": "src/plugins/advanced_settings/public/management_app/lib/to_editable_config.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/server/ui_settings.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/server/ui_settings.ts" + }, + { + "plugin": "discover", + "path": "src/plugins/discover/server/ui_settings.ts" + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.UiSettingsState", + "type": "Interface", + "tags": [], + "label": "UiSettingsState", + "description": [], + "signature": [ + "UiSettingsState" + ], + "path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.UiSettingsState.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: PublicUiSettingsParams & UserProvidedValues", + "description": [], + "signature": [ + "[key: string]: ", + "PublicUiSettingsParams", + " & ", + "UserProvidedValues", + "" + ], + "path": "node_modules/@types/kbn__core-ui-settings-browser/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.UserProvidedValues", + "type": "Interface", + "tags": [], + "label": "UserProvidedValues", + "description": [ + "\nDescribes the values explicitly set by user." + ], + "signature": [ + "UserProvidedValues", + "" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-public.UserProvidedValues.userValue", + "type": "Uncategorized", + "tags": [], + "label": "userValue", + "description": [], + "signature": [ + "T | undefined" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-public.UserProvidedValues.isOverridden", + "type": "CompoundType", + "tags": [], + "label": "isOverridden", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-ui-settings-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "core", + "id": "def-public.AnalyticsServiceSetup", + "type": "Type", + "tags": [], + "label": "AnalyticsServiceSetup", + "description": [ + "\nExposes the public APIs of the AnalyticsClient during the setup phase.\n{@link AnalyticsClient}" ], "signature": [ "{ optIn: (optInConfig: ", @@ -9492,7 +10313,7 @@ "label": "KibanaExecutionContext", "description": [], "signature": [ - "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; child?: ", + "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; readonly meta?: { [key: string]: string | number | boolean | undefined; } | undefined; child?: ", "KibanaExecutionContext", " | undefined; }" ], @@ -9663,7 +10484,7 @@ "SavedObjectAttributeSingle", "[]" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -9681,37 +10502,45 @@ "SavedObjectAttributes", " | null | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsImportWarning", + "id": "def-public.SavedObjectsFindOptions", "type": "Type", "tags": [], - "label": "SavedObjectsImportWarning", - "description": [ - "\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportSimpleWarning", - "text": "SavedObjectsImportSimpleWarning" - }, + "label": "SavedObjectsFindOptions", + "description": [], + "signature": [ + "{ type: string | string[]; filter?: any; search?: string | undefined; page?: number | undefined; aggs?: Record | undefined; fields?: string[] | undefined; perPage?: number | undefined; sortField?: string | undefined; searchFields?: string[] | undefined; hasReference?: ", + "SavedObjectsFindOptionsReference", " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportActionRequiredWarning", - "text": "SavedObjectsImportActionRequiredWarning" - } + "SavedObjectsFindOptionsReference", + "[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; preference?: string | undefined; }" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-browser/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-public.SavedObjectsImportWarning", + "type": "Type", + "tags": [], + "label": "SavedObjectsImportWarning", + "description": [ + "\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n" + ], + "signature": [ + "SavedObjectsImportSimpleWarning", + " | ", + "SavedObjectsImportActionRequiredWarning" ], - "path": "src/core/server/saved_objects/import/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -9727,7 +10556,7 @@ "signature": [ "\"single\" | \"multiple\" | \"multiple-isolated\" | \"agnostic\"" ], - "path": "src/core/server/saved_objects/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -10334,7 +11163,15 @@ "tags": [], "label": "EventLoopDelaysMonitor", "description": [], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", + "signature": [ + "EventLoopDelaysMonitor", + " implements ", + "IEventLoopDelaysMonitor", + "<", + "IntervalHistogram", + ">" + ], + "path": "node_modules/@types/kbn__core-metrics-collectors-server-internal/index.d.ts", "deprecated": false, "children": [ { @@ -10349,7 +11186,7 @@ "signature": [ "any" ], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", + "path": "node_modules/@types/kbn__core-metrics-collectors-server-internal/index.d.ts", "deprecated": false, "children": [], "returnComment": [] @@ -10361,19 +11198,13 @@ "tags": [], "label": "collect", "description": [ - "\nCollect gathers event loop delays metrics from nodejs perf_hooks.monitorEventLoopDelay\nthe histogram calculations start from the last time `reset` was called or this\nEventLoopDelaysMonitor instance was created.\n\nReturns metrics in milliseconds." + "\nCollect gathers event loop delays metrics from nodejs perf_hooks.monitorEventLoopDelay\nthe histogram calculations start from the last time `reset` was called or this\nEventLoopDelaysMonitor instance was created.\n\nReturns metrics in milliseconds.\n " ], "signature": [ "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IntervalHistogram", - "text": "IntervalHistogram" - } + "IntervalHistogram" ], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", + "path": "node_modules/@types/kbn__core-metrics-collectors-server-internal/index.d.ts", "deprecated": false, "children": [], "returnComment": [] @@ -10390,7 +11221,7 @@ "signature": [ "() => void" ], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", + "path": "node_modules/@types/kbn__core-metrics-collectors-server-internal/index.d.ts", "deprecated": false, "children": [], "returnComment": [] @@ -10407,7 +11238,7 @@ "signature": [ "() => void" ], - "path": "src/core/server/metrics/event_loop_delays/event_loop_delays_monitor.ts", + "path": "node_modules/@types/kbn__core-metrics-collectors-server-internal/index.d.ts", "deprecated": false, "children": [], "returnComment": [] @@ -11393,7 +12224,10 @@ "description": [ "\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n" ], - "path": "src/core/types/capabilities.ts", + "signature": [ + "Capabilities" + ], + "path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts", "deprecated": false, "children": [ { @@ -11408,7 +12242,7 @@ "signature": [ "{ [x: string]: boolean; }" ], - "path": "src/core/types/capabilities.ts", + "path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts", "deprecated": false }, { @@ -11423,7 +12257,7 @@ "signature": [ "{ [sectionId: string]: Record; }" ], - "path": "src/core/types/capabilities.ts", + "path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts", "deprecated": false }, { @@ -11438,7 +12272,7 @@ "signature": [ "{ [x: string]: boolean; }" ], - "path": "src/core/types/capabilities.ts", + "path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts", "deprecated": false }, { @@ -11453,7 +12287,7 @@ "signature": [ "[key: string]: Record>" ], - "path": "src/core/types/capabilities.ts", + "path": "node_modules/@types/kbn__core-capabilities-common/index.d.ts", "deprecated": false } ], @@ -11468,7 +12302,10 @@ "description": [ "\nAPIs to manage the {@link Capabilities} that will be used by the application.\n\nPlugins relying on capabilities to toggle some of their features should register them during the setup phase\nusing the `registerProvider` method.\n\nPlugins having the responsibility to restrict capabilities depending on a given context should register\ntheir capabilities switcher using the `registerSwitcher` method.\n\nRefers to the methods documentation for complete description and examples.\n" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "signature": [ + "CapabilitiesSetup" + ], + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false, "children": [ { @@ -11482,16 +12319,10 @@ ], "signature": [ "(provider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesProvider", - "text": "CapabilitiesProvider" - }, + "CapabilitiesProvider", ") => void" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false, "children": [ { @@ -11502,15 +12333,9 @@ "label": "provider", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesProvider", - "text": "CapabilitiesProvider" - } + "CapabilitiesProvider" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false, "isRequired": true } @@ -11528,16 +12353,10 @@ ], "signature": [ "(switcher: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSwitcher", - "text": "CapabilitiesSwitcher" - }, + "CapabilitiesSwitcher", ") => void" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false, "children": [ { @@ -11548,15 +12367,9 @@ "label": "switcher", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSwitcher", - "text": "CapabilitiesSwitcher" - } + "CapabilitiesSwitcher" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false, "isRequired": true } @@ -11575,7 +12388,10 @@ "description": [ "\nAPIs to access the application {@link Capabilities}.\n" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "signature": [ + "CapabilitiesStart" + ], + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false, "children": [ { @@ -11591,18 +12407,12 @@ "(request: ", "KibanaRequest", ", options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ResolveCapabilitiesOptions", - "text": "ResolveCapabilitiesOptions" - }, + "ResolveCapabilitiesOptions", " | undefined) => Promise<", "Capabilities", ">" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false, "children": [ { @@ -11616,7 +12426,7 @@ "KibanaRequest", "" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false, "isRequired": true }, @@ -11628,16 +12438,10 @@ "label": "options", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.ResolveCapabilitiesOptions", - "text": "ResolveCapabilitiesOptions" - }, + "ResolveCapabilitiesOptions", " | undefined" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false, "isRequired": false } @@ -12384,13 +13188,7 @@ "{@link CapabilitiesSetup}" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesSetup", - "text": "CapabilitiesSetup" - } + "CapabilitiesSetup" ], "path": "src/core/server/index.ts", "deprecated": false @@ -12518,13 +13316,7 @@ "{@link MetricsServiceSetup}" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" - } + "MetricsServiceSetup" ], "path": "src/core/server/index.ts", "deprecated": false @@ -12684,13 +13476,7 @@ "{@link CapabilitiesStart}" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CapabilitiesStart", - "text": "CapabilitiesStart" - } + "CapabilitiesStart" ], "path": "src/core/server/index.ts", "deprecated": false @@ -12765,13 +13551,7 @@ "{@link MetricsServiceStart}" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" - } + "MetricsServiceSetup" ], "path": "src/core/server/index.ts", "deprecated": false @@ -14429,7 +15209,7 @@ "Headers used for authentication against Elasticsearch" ], "signature": [ - "{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; connection?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts", "deprecated": false @@ -14468,543 +15248,219 @@ "label": "savedObjectsClient", "description": [], "signature": [ - "{ create: (type: string, attributes: T, options?: ", + "SavedObjectsClientContract" + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpAuth", + "type": "Interface", + "tags": [], + "label": "HttpAuth", + "description": [], + "signature": [ + "HttpAuth" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpAuth.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}" + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => { status: ", + "AuthStatus", + "; state: T; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", + "parentPluginId": "core", + "id": "def-server.HttpAuth.get.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.HttpAuth.isAuthenticated", + "type": "Function", + "tags": [], + "label": "isAuthenticated", + "description": [ + "\nReturns authentication status for a request.\n{@link IsAuthenticated}" + ], + "signature": [ + "(request: ", + "KibanaRequest", + ") => boolean" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", + "parentPluginId": "core", + "id": "def-server.HttpAuth.isAuthenticated.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.HttpResources", + "type": "Interface", + "tags": [], + "label": "HttpResources", + "description": [ + "\nHttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP.\nProvides API allowing plug-ins to respond with:\n- a pre-configured HTML page bootstrapping Kibana client app\n- custom HTML page\n- custom JS script file." + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.HttpResources.register", + "type": "Function", + "tags": [], + "label": "register", + "description": [ + "To register a route handler executing passed function to form response." + ], + "signature": [ + " Promise<", + " = ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" }, - ">; checkConflicts: (objects?: ", + ">(route: ", + "RouteConfig", + ", handler: ", { "pluginId": "core", "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRequestHandler", + "text": "HttpResourcesRequestHandler" }, - "[], options?: ", + ") => void" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "parentPluginId": "core", + "id": "def-server.HttpResources.register.$1", + "type": "Object", + "tags": [], + "label": "route", + "description": [], + "signature": [ + "RouteConfig", + "" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": true }, - ") => 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "parentPluginId": "core", + "id": "def-server.HttpResources.register.$2", + "type": "Function", + "tags": [], + "label": "handler", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.HttpResourcesRequestHandler", + "text": "HttpResourcesRequestHandler" + }, + "" + ], + "path": "src/core/server/http_resources/types.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/server/deprecations/types.ts", - "deprecated": false + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.HttpAuth", + "id": "def-server.HttpResourcesRenderOptions", "type": "Interface", "tags": [], - "label": "HttpAuth", - "description": [], - "signature": [ - "HttpAuth" + "label": "HttpResourcesRenderOptions", + "description": [ + "\nAllows to configure HTTP response parameters" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "src/core/server/http_resources/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.HttpAuth.get", - "type": "Function", + "id": "def-server.HttpResourcesRenderOptions.headers", + "type": "CompoundType", "tags": [], - "label": "get", + "label": "headers", "description": [ - "\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}" + "\nHTTP Headers with additional information about response." ], "signature": [ - "(request: ", - "KibanaRequest", - ") => { status: ", - "AuthStatus", - "; state: T; }" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpAuth.get.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - "KibanaRequest", - "" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", - "deprecated": false - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.HttpAuth.isAuthenticated", - "type": "Function", - "tags": [], - "label": "isAuthenticated", - "description": [ - "\nReturns authentication status for a request.\n{@link IsAuthenticated}" - ], - "signature": [ - "(request: ", - "KibanaRequest", - ") => boolean" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", - "deprecated": false, - "returnComment": [], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpAuth.isAuthenticated.$1", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - "KibanaRequest", - "" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", - "deprecated": false - } - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResources", - "type": "Interface", - "tags": [], - "label": "HttpResources", - "description": [ - "\nHttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP.\nProvides API allowing plug-ins to respond with:\n- a pre-configured HTML page bootstrapping Kibana client app\n- custom HTML page\n- custom JS script file." - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResources.register", - "type": "Function", - "tags": [], - "label": "register", - "description": [ - "To register a route handler executing passed function to form response." - ], - "signature": [ - "(route: ", - "RouteConfig", - ", handler: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRequestHandler", - "text": "HttpResourcesRequestHandler" - }, - ") => void" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResources.register.$1", - "type": "Object", - "tags": [], - "label": "route", - "description": [], - "signature": [ - "RouteConfig", - "" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResources.register.$2", - "type": "Function", - "tags": [], - "label": "handler", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.HttpResourcesRequestHandler", - "text": "HttpResourcesRequestHandler" - }, - "" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesRenderOptions", - "type": "Interface", - "tags": [], - "label": "HttpResourcesRenderOptions", - "description": [ - "\nAllows to configure HTTP response parameters" - ], - "path": "src/core/server/http_resources/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.HttpResourcesRenderOptions.headers", - "type": "CompoundType", - "tags": [], - "label": "headers", - "description": [ - "\nHTTP Headers with additional information about response." - ], - "signature": [ - "ResponseHeaders", - " | undefined" + "ResponseHeaders", + " | undefined" ], "path": "src/core/server/http_resources/types.ts", "deprecated": false @@ -16212,32 +16668,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: { (this: That, params: ", "GetRequest", " | ", @@ -16290,32 +16720,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -16386,6 +16816,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", " | ", @@ -17614,43 +18070,113 @@ }, { "parentPluginId": "core", - "id": "def-server.IExecutionContextContainer", + "id": "def-server.IEventLoopDelaysMonitor", "type": "Interface", "tags": [], - "label": "IExecutionContextContainer", - "description": [], + "label": "IEventLoopDelaysMonitor", + "description": [ + "\nCreating a new instance from EventLoopDelaysMonitor will\nautomatically start tracking event loop delays.\nSee {@link IntervalHistogram}" + ], "signature": [ - "IExecutionContextContainer" + "IEventLoopDelaysMonitor", + "" ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.IExecutionContextContainer.toString", + "id": "def-server.IEventLoopDelaysMonitor.collect", "type": "Function", "tags": [], - "label": "toString", - "description": [], + "label": "collect", + "description": [ + "\nCollect gathers event loop delays metrics from nodejs perf_hooks.monitorEventLoopDelay\nthe histogram calculations start from the last time `reset` was called or this\nEventLoopDelaysMonitor instance was created.\n\nReturns metrics in milliseconds.\n " + ], "signature": [ - "() => string" + "() => T" ], - "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false, "children": [], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.IExecutionContextContainer.toJSON", + "id": "def-server.IEventLoopDelaysMonitor.reset", "type": "Function", "tags": [], - "label": "toJSON", - "description": [], - "signature": [ - "() => Readonly<", - "KibanaExecutionContext", - ">" + "label": "reset", + "description": [ + "\nResets the collected histogram data." + ], + "signature": [ + "() => void" + ], + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IEventLoopDelaysMonitor.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [ + "\nDisables updating the interval timer for collecting new data points." + ], + "signature": [ + "() => void" + ], + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IExecutionContextContainer", + "type": "Interface", + "tags": [], + "label": "IExecutionContextContainer", + "description": [], + "signature": [ + "IExecutionContextContainer" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IExecutionContextContainer.toString", + "type": "Function", + "tags": [], + "label": "toString", + "description": [], + "signature": [ + "() => string" + ], + "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.IExecutionContextContainer.toJSON", + "type": "Function", + "tags": [], + "label": "toJSON", + "description": [], + "signature": [ + "() => Readonly<", + "KibanaExecutionContext", + ">" ], "path": "node_modules/@types/kbn__core-execution-context-server/index.d.ts", "deprecated": false, @@ -18061,7 +18587,10 @@ "description": [ "\nan IntervalHistogram object that samples and reports the event loop delay over time.\nThe delays will be reported in milliseconds.\n" ], - "path": "src/core/server/metrics/types.ts", + "signature": [ + "IntervalHistogram" + ], + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false, "children": [ { @@ -18071,7 +18600,7 @@ "tags": [], "label": "fromTimestamp", "description": [], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -18081,7 +18610,7 @@ "tags": [], "label": "lastUpdatedAt", "description": [], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -18091,7 +18620,7 @@ "tags": [], "label": "min", "description": [], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -18101,7 +18630,7 @@ "tags": [], "label": "max", "description": [], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -18111,7 +18640,7 @@ "tags": [], "label": "mean", "description": [], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -18121,7 +18650,7 @@ "tags": [], "label": "exceeds", "description": [], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -18131,7 +18660,7 @@ "tags": [], "label": "stddev", "description": [], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -18144,7 +18673,7 @@ "signature": [ "{ 50: number; 75: number; 95: number; 99: number; }" ], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false } ], @@ -18837,76 +19366,1366 @@ }, { "parentPluginId": "core", - "id": "def-server.IScopedClusterClient", + "id": "def-server.ISavedObjectsPointInTimeFinder", "type": "Interface", "tags": [], - "label": "IScopedClusterClient", + "label": "ISavedObjectsPointInTimeFinder", + "description": [], + "signature": [ + "ISavedObjectsPointInTimeFinder", + "" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsPointInTimeFinder.find", + "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nAn async generator which wraps calls to `savedObjectsClient.find` and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a set\nof results is received that's smaller than the designated `perPage` size." + ], + "signature": [ + "() => AsyncGenerator<", + "SavedObjectsFindResponse", + ", any, unknown>" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsPointInTimeFinder.close", + "type": "Function", + "tags": [], + "label": "close", + "description": [ + "\nCloses the Point-In-Time associated with this finder instance.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason." + ], + "signature": [ + "() => Promise" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository", + "type": "Interface", + "tags": [], + "label": "ISavedObjectsRepository", "description": [ - "\nServes the same purpose as the normal {@link IClusterClient | cluster client} but exposes\nan additional `asCurrentUser` method that doesn't use credentials of the Kibana internal\nuser (as `asInternalUser` does) to request Elasticsearch API, but rather passes HTTP headers\nextracted from the current user request to the API instead.\n" + "\nThe savedObjects repository contract.\n" ], "signature": [ - "IScopedClusterClient" + "ISavedObjectsRepository" ], - "path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.IScopedClusterClient.asInternalUser", - "type": "Object", + "id": "def-server.ISavedObjectsRepository.create", + "type": "Function", + "tags": [ + "property", + "property", + "property", + "property", + "property" + ], + "label": "create", + "description": [ + "\nPersists an object\n" + ], + "signature": [ + "(type: string, attributes: T, options?: ", + "SavedObjectsCreateOptions", + " | undefined) => Promise<", + "SavedObject", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.create.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.create.$2", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.create.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsCreateOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { id, type, version, attributes }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.bulkCreate", + "type": "Function", + "tags": [ + "property", + "property" + ], + "label": "bulkCreate", + "description": [ + "\nCreates multiple documents at once\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsBulkCreateObject", + "[], options?: ", + "SavedObjectsCreateOptions", + " | undefined) => Promise<", + "SavedObjectsBulkResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.bulkCreate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- [{ type, id, attributes, references, migrationVersion }]" + ], + "signature": [ + "SavedObjectsBulkCreateObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.bulkCreate.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsCreateOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.checkConflicts", + "type": "Function", "tags": [], - "label": "asInternalUser", + "label": "checkConflicts", "description": [ - "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the internal Kibana user." + "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten." ], "signature": [ - "{ name: string | symbol; transform: ", - "default", - "; search: { >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "SearchResponse", - ">; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "SearchResponse", - ", unknown>>; >(this: That, params?: ", - "SearchRequest", - " | ", - "SearchRequest", - " | undefined, options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "SearchResponse", - ">; }; cluster: ", - "default", - "; eql: ", - "default", - "; create: { (this: That, params: ", - "CreateRequest", - " | ", - "CreateRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "WriteResponseBase", - ">; (this: That, params: ", + "(objects: ", + "SavedObjectsCheckConflictsObject", + "[], options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObjectsCheckConflictsResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.checkConflicts.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "SavedObjectsCheckConflictsObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.checkConflicts.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBaseOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.delete", + "type": "Function", + "tags": [ + "property" + ], + "label": "delete", + "description": [ + "\nDeletes an object\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + "SavedObjectsDeleteOptions", + " | undefined) => Promise<{}>" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.delete.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.delete.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.delete.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsDeleteOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.deleteByNamespace", + "type": "Function", + "tags": [], + "label": "deleteByNamespace", + "description": [ + "\nDeletes all objects from the provided namespace.\n" + ], + "signature": [ + "(namespace: string, options?: ", + "SavedObjectsDeleteByNamespaceOptions", + " | undefined) => Promise" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.deleteByNamespace.$1", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.deleteByNamespace.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsDeleteByNamespaceOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.find", + "type": "Function", + "tags": [ + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property" + ], + "label": "find", + "description": [], + "signature": [ + "(options: ", + "SavedObjectsFindOptions", + ") => Promise<", + "SavedObjectsFindResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.find.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsFindOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.bulkGet", + "type": "Function", + "tags": [ + "property" + ], + "label": "bulkGet", + "description": [ + "\nReturns an array of objects by id\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsBulkGetObject", + "[], options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObjectsBulkResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.bulkGet.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array of objects containing id, type and optionally fields" + ], + "signature": [ + "SavedObjectsBulkGetObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.bulkGet.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBaseOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { saved_objects: [{ id, type, version, attributes }] }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.bulkResolve", + "type": "Function", + "tags": [ + "property" + ], + "label": "bulkResolve", + "description": [ + "\nResolves an array of objects by id, using any legacy URL aliases if they exist\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsBulkResolveObject", + "[], options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObjectsBulkResolveResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.bulkResolve.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array of objects containing id, type" + ], + "signature": [ + "SavedObjectsBulkResolveObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.bulkResolve.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBaseOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { resolved_objects: [{ saved_object, outcome }] }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.get", + "type": "Function", + "tags": [ + "property" + ], + "label": "get", + "description": [ + "\nGets a single object\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObject", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.get.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.get.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.get.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBaseOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { id, type, version, attributes }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.resolve", + "type": "Function", + "tags": [ + "property" + ], + "label": "resolve", + "description": [ + "\nResolves a single object, using any legacy URL alias if it exists\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObjectsResolveResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.resolve.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.resolve.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.resolve.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBaseOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { saved_object, outcome }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.update", + "type": "Function", + "tags": [ + "property", + "property", + "property" + ], + "label": "update", + "description": [ + "\nUpdates an object\n" + ], + "signature": [ + "(type: string, id: string, attributes: Partial, options?: ", + "SavedObjectsUpdateOptions", + " | undefined) => Promise<", + "SavedObjectsUpdateResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.update.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.update.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.update.$3", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "Partial" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.update.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsUpdateOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.collectMultiNamespaceReferences", + "type": "Function", + "tags": [], + "label": "collectMultiNamespaceReferences", + "description": [ + "\nGets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace\ntype.\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsCollectMultiNamespaceReferencesObject", + "[], options?: ", + "SavedObjectsCollectMultiNamespaceReferencesOptions", + " | undefined) => Promise<", + "SavedObjectsCollectMultiNamespaceReferencesResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.collectMultiNamespaceReferences.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "The objects to get the references for." + ], + "signature": [ + "SavedObjectsCollectMultiNamespaceReferencesObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.collectMultiNamespaceReferences.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsCollectMultiNamespaceReferencesOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.updateObjectsSpaces", + "type": "Function", + "tags": [], + "label": "updateObjectsSpaces", + "description": [ + "\nUpdates one or more objects to add and/or remove them from specified spaces.\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsUpdateObjectsSpacesObject", + "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + "SavedObjectsUpdateObjectsSpacesOptions", + " | undefined) => Promise<", + "SavedObjectsUpdateObjectsSpacesResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.updateObjectsSpaces.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "SavedObjectsUpdateObjectsSpacesObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.updateObjectsSpaces.$2", + "type": "Array", + "tags": [], + "label": "spacesToAdd", + "description": [], + "signature": [ + "string[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.updateObjectsSpaces.$3", + "type": "Array", + "tags": [], + "label": "spacesToRemove", + "description": [], + "signature": [ + "string[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.updateObjectsSpaces.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsUpdateObjectsSpacesOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.bulkUpdate", + "type": "Function", + "tags": [ + "property", + "property" + ], + "label": "bulkUpdate", + "description": [ + "\nUpdates multiple objects in bulk\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsBulkUpdateObject", + "[], options?: ", + "SavedObjectsBulkUpdateOptions", + " | undefined) => Promise<", + "SavedObjectsBulkUpdateResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.bulkUpdate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- [{ type, id, attributes, options: { version, namespace } references }]" + ], + "signature": [ + "SavedObjectsBulkUpdateObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.bulkUpdate.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBulkUpdateOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.removeReferencesTo", + "type": "Function", + "tags": [], + "label": "removeReferencesTo", + "description": [ + "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + "SavedObjectsRemoveReferencesToOptions", + " | undefined) => Promise<", + "SavedObjectsRemoveReferencesToResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.removeReferencesTo.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.removeReferencesTo.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.removeReferencesTo.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsRemoveReferencesToOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.incrementCounter", + "type": "Function", + "tags": [], + "label": "incrementCounter", + "description": [ + "\nIncrements all the specified counter fields (by one by default). Creates the document\nif one doesn't exist for the given id.\n" + ], + "signature": [ + "(type: string, id: string, counterFields: (string | ", + "SavedObjectsIncrementCounterField", + ")[], options?: ", + "SavedObjectsIncrementCounterOptions", + " | undefined) => Promise<", + "SavedObject", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.incrementCounter.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- The type of saved object whose fields should be incremented" + ], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.incrementCounter.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- The id of the document whose fields should be incremented" + ], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.incrementCounter.$3", + "type": "Array", + "tags": [], + "label": "counterFields", + "description": [ + "- An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField }" + ], + "signature": [ + "(string | ", + "SavedObjectsIncrementCounterField", + ")[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.incrementCounter.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link SavedObjectsIncrementCounterOptions }" + ], + "signature": [ + "SavedObjectsIncrementCounterOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "The saved object after the specified fields were incremented" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.openPointInTimeForType", + "type": "Function", + "tags": [ + "property", + "property" + ], + "label": "openPointInTimeForType", + "description": [ + "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to `SavedObjects.find` to search against that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" + ], + "signature": [ + "(type: string | string[], options?: ", + "SavedObjectsOpenPointInTimeOptions", + " | undefined) => Promise<", + "SavedObjectsOpenPointInTimeResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.openPointInTimeForType.$1", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | string[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.openPointInTimeForType.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link SavedObjectsOpenPointInTimeOptions }" + ], + "signature": [ + "SavedObjectsOpenPointInTimeOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { id: string }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.closePointInTime", + "type": "Function", + "tags": [], + "label": "closePointInTime", + "description": [ + "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES\nvia the Elasticsearch client, and is included in the Saved Objects Client\nas a convenience for consumers who are using `openPointInTimeForType`.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" + ], + "signature": [ + "(id: string, options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObjectsClosePointInTimeResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.closePointInTime.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.closePointInTime.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link SavedObjectsClosePointInTimeOptions }" + ], + "signature": [ + "SavedObjectsBaseOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- {@link SavedObjectsClosePointInTimeResponse }" + ] + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.createPointInTimeFinder", + "type": "Function", + "tags": [], + "label": "createPointInTimeFinder", + "description": [ + "\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThis generator wraps calls to {@link SavedObjectsRepository.find} and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a\nset of results is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n" + ], + "signature": [ + "(findOptions: ", + "SavedObjectsCreatePointInTimeFinderOptions", + ", dependencies?: ", + "SavedObjectsCreatePointInTimeFinderDependencies", + " | undefined) => ", + "ISavedObjectsPointInTimeFinder", + "" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.createPointInTimeFinder.$1", + "type": "Object", + "tags": [], + "label": "findOptions", + "description": [], + "signature": [ + "SavedObjectsCreatePointInTimeFinderOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsRepository.createPointInTimeFinder.$2", + "type": "Object", + "tags": [], + "label": "dependencies", + "description": [], + "signature": [ + "SavedObjectsCreatePointInTimeFinderDependencies", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.IScopedClusterClient", + "type": "Interface", + "tags": [], + "label": "IScopedClusterClient", + "description": [ + "\nServes the same purpose as the normal {@link IClusterClient | cluster client} but exposes\nan additional `asCurrentUser` method that doesn't use credentials of the Kibana internal\nuser (as `asInternalUser` does) to request Elasticsearch API, but rather passes HTTP headers\nextracted from the current user request to the API instead.\n" + ], + "signature": [ + "IScopedClusterClient" + ], + "path": "node_modules/@types/kbn__core-elasticsearch-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.IScopedClusterClient.asInternalUser", + "type": "Object", + "tags": [], + "label": "asInternalUser", + "description": [ + "\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the internal Kibana user." + ], + "signature": [ + "{ name: string | symbol; transform: ", + "default", + "; search: { >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "SearchResponse", + ">; >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "SearchResponse", + ", unknown>>; >(this: That, params?: ", + "SearchRequest", + " | ", + "SearchRequest", + " | undefined, options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "SearchResponse", + ">; }; cluster: ", + "default", + "; eql: ", + "default", + "; create: { (this: That, params: ", + "CreateRequest", + " | ", + "CreateRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "WriteResponseBase", + ">; (this: That, params: ", "CreateRequest", " | ", "CreateRequest", @@ -18954,32 +20773,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: { (this: That, params: ", "GetRequest", " | ", @@ -19032,32 +20825,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -19128,6 +20921,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", " | ", @@ -20157,32 +21976,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: { (this: That, params: ", "GetRequest", " | ", @@ -20235,32 +22028,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -20331,6 +22124,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", " | ", @@ -21813,7 +23632,7 @@ "\nReadonly copy of incoming request headers." ], "signature": [ - "{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; connection?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false @@ -22645,7 +24464,10 @@ "description": [ "\nAPIs to retrieves metrics gathered and exposed by the core platform.\n" ], - "path": "src/core/server/metrics/types.ts", + "signature": [ + "MetricsServiceSetup" + ], + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false, "children": [ { @@ -22657,7 +24479,7 @@ "description": [ "Interval metrics are collected in milliseconds" ], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -22673,16 +24495,10 @@ "() => ", "Observable", "<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.OpsMetrics", - "text": "OpsMetrics" - }, + "OpsMetrics", ">" ], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false, "children": [], "returnComment": [] @@ -23196,7 +25012,10 @@ "description": [ "\nRegroups metrics gathered by all the collectors.\nThis contains metrics about the os/runtime, the kibana process and the http server.\n" ], - "path": "src/core/server/metrics/types.ts", + "signature": [ + "OpsMetrics" + ], + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false, "children": [ { @@ -23211,7 +25030,7 @@ "signature": [ "Date" ], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23226,15 +25045,9 @@ "\nProcess related metrics." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.OpsProcessMetrics", - "text": "OpsProcessMetrics" - } + "OpsProcessMetrics" ], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": true, "removeBy": "8.8.0", "references": [ @@ -23245,6 +25058,18 @@ { "plugin": "kibanaUsageCollection", "path": "src/plugins/kibana_usage_collection/server/collectors/ops_stats/ops_stats_collector.ts" + }, + { + "plugin": "@kbn/core-metrics-server-internal", + "path": "packages/core/metrics/core-metrics-server-internal/src/ops_metrics_collector.ts" + }, + { + "plugin": "@kbn/core-metrics-server-internal", + "path": "packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.ts" + }, + { + "plugin": "@kbn/core-metrics-server-internal", + "path": "packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.test.ts" } ] }, @@ -23258,16 +25083,10 @@ "Process related metrics. Reports an array of objects for each kibana pid." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.OpsProcessMetrics", - "text": "OpsProcessMetrics" - }, + "OpsProcessMetrics", "[]" ], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23280,15 +25099,9 @@ "OS related metrics" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.OpsOsMetrics", - "text": "OpsOsMetrics" - } + "OpsOsMetrics" ], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23303,7 +25116,7 @@ "signature": [ "{ avg_in_millis: number; max_in_millis: number; }" ], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23318,7 +25131,7 @@ "signature": [ "{ disconnects: number; total: number; statusCodes: Record; }" ], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23330,7 +25143,7 @@ "description": [ "number of current concurrent connections to the server" ], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false } ], @@ -23345,7 +25158,10 @@ "description": [ "\nOS related metrics" ], - "path": "src/core/server/metrics/collectors/types.ts", + "signature": [ + "OpsOsMetrics" + ], + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false, "children": [ { @@ -23360,7 +25176,7 @@ "signature": [ "\"linux\" | \"aix\" | \"android\" | \"darwin\" | \"freebsd\" | \"haiku\" | \"openbsd\" | \"sunos\" | \"win32\" | \"cygwin\" | \"netbsd\"" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23372,7 +25188,7 @@ "description": [ "The os platform release, prefixed by the platform name" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23387,7 +25203,7 @@ "signature": [ "string | undefined" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23402,7 +25218,7 @@ "signature": [ "string | undefined" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23417,7 +25233,7 @@ "signature": [ "{ '1m': number; '5m': number; '15m': number; }" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23432,7 +25248,7 @@ "signature": [ "{ total_in_bytes: number; free_in_bytes: number; used_in_bytes: number; }" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23444,7 +25260,7 @@ "description": [ "the OS uptime" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23459,7 +25275,7 @@ "signature": [ "{ control_group: string; usage_nanos: number; } | undefined" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23474,7 +25290,7 @@ "signature": [ "{ control_group: string; cfs_period_micros: number; cfs_quota_micros: number; stat: { number_of_elapsed_periods: number; number_of_times_throttled: number; time_throttled_nanos: number; }; } | undefined" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false } ], @@ -23489,7 +25305,10 @@ "description": [ "\nProcess related metrics" ], - "path": "src/core/server/metrics/collectors/types.ts", + "signature": [ + "OpsProcessMetrics" + ], + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false, "children": [ { @@ -23501,7 +25320,7 @@ "description": [ "pid of the kibana process" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23516,7 +25335,7 @@ "signature": [ "{ heap: { total_in_bytes: number; used_in_bytes: number; size_limit: number; }; resident_set_size_in_bytes: number; }" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23528,7 +25347,7 @@ "description": [ "mean event loop delay since last collection" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23541,15 +25360,9 @@ "node event loop delay histogram since last collection" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.IntervalHistogram", - "text": "IntervalHistogram" - } + "IntervalHistogram" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23561,7 +25374,7 @@ "description": [ "uptime of the kibana process" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false } ], @@ -23576,7 +25389,10 @@ "description": [ "\nserver related metrics" ], - "path": "src/core/server/metrics/collectors/types.ts", + "signature": [ + "OpsServerMetrics" + ], + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false, "children": [ { @@ -23591,7 +25407,7 @@ "signature": [ "{ avg_in_millis: number; max_in_millis: number; }" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23606,7 +25422,7 @@ "signature": [ "{ disconnects: number; total: number; statusCodes: Record; }" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false }, { @@ -23618,7 +25434,7 @@ "description": [ "number of current concurrent connections to the server" ], - "path": "src/core/server/metrics/collectors/types.ts", + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", "deprecated": false } ], @@ -24455,32 +26271,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: { (this: That, params: ", "GetRequest", " | ", @@ -24533,32 +26323,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -24629,6 +26419,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", " | ", @@ -25482,119 +27298,4295 @@ " | undefined): Promise<", "TransportResult", "<", - "TermvectorsResponse", - ", unknown>>; (this: That, params: ", - "TermvectorsRequest", - " | ", - "TermvectorsRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "TermvectorsResponse", - ">; }; textStructure: ", - "default", - "; updateByQuery: { (this: That, params: ", - "UpdateByQueryRequest", - " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateByQueryResponse", - ">; (this: That, params: ", - "UpdateByQueryRequest", + "TermvectorsResponse", + ", unknown>>; (this: That, params: ", + "TermvectorsRequest", + " | ", + "TermvectorsRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "TermvectorsResponse", + ">; }; textStructure: ", + "default", + "; updateByQuery: { (this: That, params: ", + "UpdateByQueryRequest", + " | ", + "UpdateByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateByQueryResponse", + ">; (this: That, params: ", + "UpdateByQueryRequest", + " | ", + "UpdateByQueryRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateByQueryResponse", + ", unknown>>; (this: That, params: ", + "UpdateByQueryRequest", + " | ", + "UpdateByQueryRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateByQueryResponse", + ">; }; updateByQueryRethrottle: { (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithOutMeta", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptionsWithMeta", + " | undefined): Promise<", + "TransportResult", + "<", + "UpdateByQueryRethrottleResponse", + ", unknown>>; (this: That, params: ", + "UpdateByQueryRethrottleRequest", + " | ", + "UpdateByQueryRethrottleRequest", + ", options?: ", + "TransportRequestOptions", + " | undefined): Promise<", + "UpdateByQueryRethrottleResponse", + ">; }; watcher: ", + "default", + "; xpack: ", + "default", + "; }" + ], + "path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PollEsNodesVersionOptions.log", + "type": "Object", + "tags": [], + "label": "log", + "description": [], + "signature": [ + "Logger" + ], + "path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PollEsNodesVersionOptions.kibanaVersion", + "type": "string", + "tags": [], + "label": "kibanaVersion", + "description": [], + "path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PollEsNodesVersionOptions.ignoreVersionMismatch", + "type": "boolean", + "tags": [], + "label": "ignoreVersionMismatch", + "description": [], + "path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.PollEsNodesVersionOptions.esVersionCheckInterval", + "type": "number", + "tags": [], + "label": "esVersionCheckInterval", + "description": [], + "path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin", + "type": "Interface", + "tags": [], + "label": "PrebootPlugin", + "description": [ + "\nThe interface that should be returned by a `PluginInitializer` for a `preboot` plugin.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.PrebootPlugin", + "text": "PrebootPlugin" + }, + "" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin.setup", + "type": "Function", + "tags": [], + "label": "setup", + "description": [], + "signature": [ + "(core: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CorePreboot", + "text": "CorePreboot" + }, + ", plugins: TPluginsSetup) => TSetup" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin.setup.$1", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CorePreboot", + "text": "CorePreboot" + } + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin.setup.$2", + "type": "Uncategorized", + "tags": [], + "label": "plugins", + "description": [], + "signature": [ + "TPluginsSetup" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.PrebootPlugin.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [], + "signature": [ + "(() => void) | undefined" + ], + "path": "src/core/server/plugins/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RegisterDeprecationsConfig", + "type": "Interface", + "tags": [], + "label": "RegisterDeprecationsConfig", + "description": [], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RegisterDeprecationsConfig.getDeprecations", + "type": "Function", + "tags": [], + "label": "getDeprecations", + "description": [], + "signature": [ + "(context: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.GetDeprecationsContext", + "text": "GetDeprecationsContext" + }, + ") => ", + "MaybePromise", + "<", + "DeprecationsDetails", + "[]>" + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RegisterDeprecationsConfig.getDeprecations.$1", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.GetDeprecationsContext", + "text": "GetDeprecationsContext" + } + ], + "path": "src/core/server/deprecations/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerContext", + "type": "Interface", + "tags": [], + "label": "RequestHandlerContext", + "description": [ + "\nBase context passed to a route handler, containing the `core` context part.\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.RequestHandlerContext", + "text": "RequestHandlerContext" + }, + " extends ", + "RequestHandlerContextBase" + ], + "path": "src/core/server/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RequestHandlerContext.core", + "type": "Object", + "tags": [], + "label": "core", + "description": [], + "signature": [ + "Promise<", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCorePluginApi", + "section": "def-server.CoreRequestHandlerContext", + "text": "CoreRequestHandlerContext" + }, + ">" + ], + "path": "src/core/server/index.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ResolveCapabilitiesOptions", + "type": "Interface", + "tags": [], + "label": "ResolveCapabilitiesOptions", + "description": [ + "\nDefines a set of additional options for the `resolveCapabilities` method of {@link CapabilitiesStart}.\n" + ], + "signature": [ + "ResolveCapabilitiesOptions" + ], + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ResolveCapabilitiesOptions.useDefaultCapabilities", + "type": "boolean", + "tags": [], + "label": "useDefaultCapabilities", + "description": [ + "\nIndicates if capability switchers are supposed to return a default set of capabilities." + ], + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfig", + "type": "Interface", + "tags": [], + "label": "RouteConfig", + "description": [ + "\nRoute specific configuration." + ], + "signature": [ + "RouteConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteConfig.path", + "type": "string", + "tags": [], + "label": "path", + "description": [ + "\nThe endpoint _within_ the router path to register the route.\n" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfig.validate", + "type": "CompoundType", + "tags": [], + "label": "validate", + "description": [ + "\nA schema created with `@kbn/config-schema` that every request will be validated against.\n" + ], + "signature": [ + "false | ", + "RouteValidatorFullConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfig.options", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "\nAdditional route options {@link RouteConfigOptions}." + ], + "signature": [ + "RouteConfigOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions", + "type": "Interface", + "tags": [], + "label": "RouteConfigOptions", + "description": [ + "\nAdditional route options." + ], + "signature": [ + "RouteConfigOptions", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.authRequired", + "type": "CompoundType", + "tags": [], + "label": "authRequired", + "description": [ + "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered." + ], + "signature": [ + "boolean | \"optional\" | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.xsrfRequired", + "type": "Uncategorized", + "tags": [], + "label": "xsrfRequired", + "description": [ + "\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default" + ], + "signature": [ + "(Method extends \"get\" ? never : boolean) | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.tags", + "type": "Object", + "tags": [], + "label": "tags", + "description": [ + "\nAdditional metadata tag strings to attach to the route." + ], + "signature": [ + "readonly string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.body", + "type": "Uncategorized", + "tags": [], + "label": "body", + "description": [ + "\nAdditional body options {@link RouteConfigOptionsBody}." + ], + "signature": [ + "(Method extends \"options\" | \"get\" ? undefined : ", + "RouteConfigOptionsBody", + ") | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptions.timeout", + "type": "Object", + "tags": [], + "label": "timeout", + "description": [ + "\nDefines per-route timeouts." + ], + "signature": [ + "{ payload?: (Method extends \"options\" | \"get\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptionsBody", + "type": "Interface", + "tags": [], + "label": "RouteConfigOptionsBody", + "description": [ + "\nAdditional body options for a route" + ], + "signature": [ + "RouteConfigOptionsBody" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptionsBody.accepts", + "type": "CompoundType", + "tags": [], + "label": "accepts", + "description": [ + "\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*" + ], + "signature": [ + "string | string[] | ", + "RouteContentType", + "[] | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptionsBody.maxBytes", + "type": "number", + "tags": [], + "label": "maxBytes", + "description": [ + "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`." + ], + "signature": [ + "number | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptionsBody.output", + "type": "CompoundType", + "tags": [], + "label": "output", + "description": [ + "\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure." + ], + "signature": [ + "\"data\" | \"stream\" | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteConfigOptionsBody.parse", + "type": "CompoundType", + "tags": [], + "label": "parse", + "description": [ + "\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure." + ], + "signature": [ + "boolean | \"gunzip\" | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteValidationResultFactory", + "type": "Interface", + "tags": [], + "label": "RouteValidationResultFactory", + "description": [ + "\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n" + ], + "signature": [ + "RouteValidationResultFactory" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteValidationResultFactory.ok", + "type": "Function", + "tags": [], + "label": "ok", + "description": [], + "signature": [ + "(value: T) => { value: T; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteValidationResultFactory.ok.$1", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "T" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.RouteValidationResultFactory.badRequest", + "type": "Function", + "tags": [], + "label": "badRequest", + "description": [], + "signature": [ + "(error: string | Error, path?: string[] | undefined) => { error: ", + "RouteValidationError", + "; }" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteValidationResultFactory.badRequest.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "string | Error" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.RouteValidationResultFactory.badRequest.$2", + "type": "Array", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteValidatorConfig", + "type": "Interface", + "tags": [], + "label": "RouteValidatorConfig", + "description": [ + "\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n" + ], + "signature": [ + "RouteValidatorConfig", + "" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteValidatorConfig.params", + "type": "CompoundType", + "tags": [], + "label": "params", + "description": [ + "\nValidation logic for the URL params" + ], + "signature": [ + "RouteValidationSpec", + "

| undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteValidatorConfig.query", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [ + "\nValidation logic for the Query params" + ], + "signature": [ + "RouteValidationSpec", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteValidatorConfig.body", + "type": "CompoundType", + "tags": [], + "label": "body", + "description": [ + "\nValidation logic for the body payload" + ], + "signature": [ + "RouteValidationSpec", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.RouteValidatorOptions", + "type": "Interface", + "tags": [], + "label": "RouteValidatorOptions", + "description": [ + "\nAdditional options for the RouteValidator class to modify its default behaviour.\n" + ], + "signature": [ + "RouteValidatorOptions" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.RouteValidatorOptions.unsafe", + "type": "Object", + "tags": [], + "label": "unsafe", + "description": [ + "\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation" + ], + "signature": [ + "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" + ], + "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObject", + "type": "Interface", + "tags": [], + "label": "SavedObject", + "description": [], + "signature": [ + "SavedObject", + "" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + " The type of Saved Object. Each plugin can define it's own custom Saved Object types." + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObject.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObject.updated_at", + "type": "string", + "tags": [], + "label": "updated_at", + "description": [ + "Timestamp of the last time this document had been updated." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObject.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "SavedObjectError", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObject.attributes", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [ + "{@inheritdoc SavedObjectAttributes}" + ], + "signature": [ + "T" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObject.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [ + "{@inheritdoc SavedObjectReference}" + ], + "signature": [ + "SavedObjectReference", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObject.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [ + "{@inheritdoc SavedObjectsMigrationVersion}" + ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObject.coreMigrationVersion", + "type": "string", + "tags": [], + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObject.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." + ], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObject.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectAttributes", + "type": "Interface", + "tags": [], + "label": "SavedObjectAttributes", + "description": [ + "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" + ], + "signature": [ + "SavedObjectAttributes" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectAttributes.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: SavedObjectAttribute", + "description": [], + "signature": [ + "[key: string]: ", + "SavedObjectAttribute" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReference", + "type": "Interface", + "tags": [], + "label": "SavedObjectReference", + "description": [ + "\nA reference to another saved object.\n" + ], + "signature": [ + "SavedObjectReference" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReference.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReference.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReference.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReferenceWithContext", + "type": "Interface", + "tags": [], + "label": "SavedObjectReferenceWithContext", + "description": [ + "\nA returned input object or one of its references, with additional context.\n" + ], + "signature": [ + "SavedObjectReferenceWithContext" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReferenceWithContext.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "The type of the referenced object" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReferenceWithContext.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of the referenced object" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReferenceWithContext.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "The origin ID of the referenced object (if it has one)" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReferenceWithContext.spaces", + "type": "Array", + "tags": [], + "label": "spaces", + "description": [ + "The space(s) that the referenced object exists in" + ], + "signature": [ + "string[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReferenceWithContext.inboundReferences", + "type": "Array", + "tags": [], + "label": "inboundReferences", + "description": [ + "\nReferences to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains\ninbound references for the scope of this operation" + ], + "signature": [ + "{ type: string; id: string; name: string; }[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReferenceWithContext.isMissing", + "type": "CompoundType", + "tags": [], + "label": "isMissing", + "description": [ + "Whether or not this object or reference is missing" + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReferenceWithContext.spacesWithMatchingAliases", + "type": "Array", + "tags": [], + "label": "spacesWithMatchingAliases", + "description": [ + "The space(s) that legacy URL aliases matching this type/id exist in" + ], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectReferenceWithContext.spacesWithMatchingOrigins", + "type": "Array", + "tags": [], + "label": "spacesWithMatchingOrigins", + "description": [ + "The space(s) that objects matching this origin exist in (including this one)" + ], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBaseOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBaseOptions", + "description": [ + "\nBase options used by most of the savedObject APIs." + ], + "signature": [ + "SavedObjectsBaseOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBaseOptions.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [ + "Specify the namespace for this operation" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkCreateObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkCreateObject", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsBulkCreateObject", + "" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkCreateObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkCreateObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkCreateObject.attributes", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkCreateObject.version", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkCreateObject.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkCreateObject.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [ + "{@inheritDoc SavedObjectsMigrationVersion}" + ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkCreateObject.coreMigrationVersion", + "type": "string", + "tags": [], + "label": "coreMigrationVersion", + "description": [ + "\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkCreateObject.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "Optional ID of the original saved object, if this object's `id` was regenerated" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkCreateObject.initialNamespaces", + "type": "Array", + "tags": [], + "label": "initialNamespaces", + "description": [ + "\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used." + ], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkGetObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkGetObject", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsBulkGetObject" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkGetObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkGetObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkGetObject.fields", + "type": "Array", + "tags": [], + "label": "fields", + "description": [ + "SavedObject fields to include in the response" + ], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkGetObject.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nOptional namespace(s) for the object to be retrieved in. If this is defined, it will supersede the namespace ID that is in the\ntop-level options.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used." + ], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkResolveObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkResolveObject", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsBulkResolveObject" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkResolveObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkResolveObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkResolveResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkResolveResponse", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsBulkResolveResponse", + "" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkResolveResponse.resolved_objects", + "type": "Array", + "tags": [], + "label": "resolved_objects", + "description": [], + "signature": [ + "SavedObjectsResolveResponse", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkResponse", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsBulkResponse", + "" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkResponse.saved_objects", + "type": "Array", + "tags": [], + "label": "saved_objects", + "description": [], + "signature": [ + "SavedObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkUpdateObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkUpdateObject", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsBulkUpdateObject", + " extends Pick<", + "SavedObjectsUpdateOptions", + ", \"version\" | \"references\">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkUpdateObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkUpdateObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + " The type of this Saved Object. Each plugin can define it's own custom Saved Object types." + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkUpdateObject.attributes", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [ + "{@inheritdoc SavedObjectAttributes}" + ], + "signature": [ + "{ [P in keyof T]?: T[P] | undefined; }" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkUpdateObject.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [ + "\nOptional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsBulkUpdateOptions}.\n\nNote: the default namespace's string representation is `'default'`, and its ID representation is `undefined`." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkUpdateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkUpdateOptions", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsBulkUpdateOptions", + " extends ", + "SavedObjectsBaseOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkUpdateOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "signature": [ + "MutatingOperationRefreshSetting", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkUpdateResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkUpdateResponse", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsBulkUpdateResponse", + "" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsBulkUpdateResponse.saved_objects", + "type": "Array", + "tags": [], + "label": "saved_objects", + "description": [], + "signature": [ + "SavedObjectsUpdateResponse", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCheckConflictsObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCheckConflictsObject", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsCheckConflictsObject" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCheckConflictsObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCheckConflictsObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCheckConflictsResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCheckConflictsResponse", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsCheckConflictsResponse" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCheckConflictsResponse.errors", + "type": "Array", + "tags": [], + "label": "errors", + "description": [], + "signature": [ + "{ id: string; type: string; error: ", + "SavedObjectError", + "; }[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract", + "type": "Interface", + "tags": [], + "label": "SavedObjectsClientContract", + "description": [ + "\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state.\n\n## SavedObjectsClient errors\n\nSince the SavedObjectsClient has its hands in everything we\nare a little paranoid about the way we present errors back to\nto application code. Ideally, all errors will be either:\n\n 1. Caused by bad implementation (ie. undefined is not a function) and\n as such unpredictable\n 2. An error that has been classified and decorated appropriately\n by the decorators in {@link SavedObjectsErrorHelpers}\n\nType 1 errors are inevitable, but since all expected/handle-able errors\nshould be Type 2 the `isXYZError()` helpers exposed at\n`SavedObjectsErrorHelpers` should be used to understand and manage error\nresponses from the `SavedObjectsClient`.\n\nType 2 errors are decorated versions of the source error, so if\nthe elasticsearch client threw an error it will be decorated based\non its type. That means that rather than looking for `error.body.error.type` or\ndoing substring checks on `error.body.error.reason`, just use the helpers to\nunderstand the meaning of the error:\n\n ```js\n if (SavedObjectsErrorHelpers.isNotFoundError(error)) {\n // handle 404\n }\n\n if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) {\n // 401 handling should be automatic, but in case you wanted to know\n }\n\n // always rethrow the error unless you handle it\n throw error;\n ```\n\n### 404s from missing index\n\nFrom the perspective of application code and APIs the SavedObjectsClient is\na black box that persists objects. One of the internal details that users have\nno control over is that we use an elasticsearch index for persistence and that\nindex might be missing.\n\nAt the time of writing we are in the process of transitioning away from the\noperating assumption that the SavedObjects index is always available. Part of\nthis transition is handling errors resulting from an index missing. These used\nto trigger a 500 error in most cases, and in others cause 404s with different\nerror messages.\n\nFrom my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The\nobject the request/call was targeting could not be found. This is why #14141\ntakes special care to ensure that 404 errors are generic and don't distinguish\nbetween index missing or document missing.\n\nSee {@link SavedObjectsClient}\nSee {@link SavedObjectsErrorHelpers}\n" + ], + "signature": [ + "SavedObjectsClientContract" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [ + "\nPersists a SavedObject\n" + ], + "signature": [ + "(type: string, attributes: T, options?: ", + "SavedObjectsCreateOptions", + " | undefined) => Promise<", + "SavedObject", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.create.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.create.$2", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.create.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsCreateOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.bulkCreate", + "type": "Function", + "tags": [], + "label": "bulkCreate", + "description": [ + "\nPersists multiple documents batched together as a single request\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsBulkCreateObject", + "[], options?: ", + "SavedObjectsCreateOptions", + " | undefined) => Promise<", + "SavedObjectsBulkResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.bulkCreate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "SavedObjectsBulkCreateObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.bulkCreate.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsCreateOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.checkConflicts", + "type": "Function", + "tags": [], + "label": "checkConflicts", + "description": [ + "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten.\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsCheckConflictsObject", + "[], options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObjectsCheckConflictsResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.checkConflicts.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "SavedObjectsCheckConflictsObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.checkConflicts.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBaseOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "\nDeletes a SavedObject\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + "SavedObjectsDeleteOptions", + " | undefined) => Promise<{}>" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.delete.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.delete.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.delete.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsDeleteOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.find", + "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nFind all SavedObjects matching the search query\n" + ], + "signature": [ + "(options: ", + "SavedObjectsFindOptions", + ") => Promise<", + "SavedObjectsFindResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.find.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsFindOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.bulkGet", + "type": "Function", + "tags": [], + "label": "bulkGet", + "description": [ + "\nReturns an array of objects by id\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsBulkGetObject", + "[], options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObjectsBulkResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.bulkGet.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array of ids, or an array of objects containing id, type and optionally fields" + ], + "signature": [ + "SavedObjectsBulkGetObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.bulkGet.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBaseOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nRetrieves a single object\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObject", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.get.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- The type of SavedObject to retrieve" + ], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.get.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- The ID of the SavedObject to retrieve" + ], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.get.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBaseOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.bulkResolve", + "type": "Function", + "tags": [ + "note" + ], + "label": "bulkResolve", + "description": [ + "\nResolves an array of objects by id, using any legacy URL aliases if they exist\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsBulkResolveObject", + "[], options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObjectsBulkResolveResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.bulkResolve.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array of objects containing id, type" + ], + "signature": [ + "SavedObjectsBulkResolveObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.bulkResolve.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBaseOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.resolve", + "type": "Function", + "tags": [], + "label": "resolve", + "description": [ + "\nResolves a single object, using any legacy URL alias if it exists\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObjectsResolveResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.resolve.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- The type of SavedObject to retrieve" + ], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.resolve.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- The ID of the SavedObject to retrieve" + ], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.resolve.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBaseOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.update", + "type": "Function", + "tags": [], + "label": "update", + "description": [ + "\nUpdates an SavedObject\n" + ], + "signature": [ + "(type: string, id: string, attributes: Partial, options?: ", + "SavedObjectsUpdateOptions", + " | undefined) => Promise<", + "SavedObjectsUpdateResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.update.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.update.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.update.$3", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "Partial" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.update.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsUpdateOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.bulkUpdate", + "type": "Function", + "tags": [], + "label": "bulkUpdate", + "description": [ + "\nBulk Updates multiple SavedObject at once\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsBulkUpdateObject", + "[], options?: ", + "SavedObjectsBulkUpdateOptions", + " | undefined) => Promise<", + "SavedObjectsBulkUpdateResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.bulkUpdate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "SavedObjectsBulkUpdateObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.bulkUpdate.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBulkUpdateOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.removeReferencesTo", + "type": "Function", + "tags": [], + "label": "removeReferencesTo", + "description": [ + "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference." + ], + "signature": [ + "(type: string, id: string, options?: ", + "SavedObjectsRemoveReferencesToOptions", + " | undefined) => Promise<", + "SavedObjectsRemoveReferencesToResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.removeReferencesTo.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.removeReferencesTo.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.removeReferencesTo.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsRemoveReferencesToOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.openPointInTimeForType", + "type": "Function", + "tags": [], + "label": "openPointInTimeForType", + "description": [ + "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to {@link SavedObjectsClient.find} to search\nagainst that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method." + ], + "signature": [ + "(type: string | string[], options?: ", + "SavedObjectsOpenPointInTimeOptions", + " | undefined) => Promise<", + "SavedObjectsOpenPointInTimeResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.openPointInTimeForType.$1", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | string[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.openPointInTimeForType.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsOpenPointInTimeOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.closePointInTime", + "type": "Function", + "tags": [], + "label": "closePointInTime", + "description": [ + "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES via the\nElasticsearch client, and is included in the Saved Objects Client as a convenience\nfor consumers who are using {@link SavedObjectsClient.openPointInTimeForType}.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method." + ], + "signature": [ + "(id: string, options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObjectsClosePointInTimeResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.closePointInTime.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.closePointInTime.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBaseOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.createPointInTimeFinder", + "type": "Function", + "tags": [], + "label": "createPointInTimeFinder", + "description": [ + "\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThe generator wraps calls to {@link SavedObjectsClient.find} and iterates\nover multiple pages of results using `_pit` and `search_after`. This will\nopen a new Point-In-Time (PIT), and continue paging until a set of\nresults is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n" + ], + "signature": [ + "(findOptions: ", + "SavedObjectsCreatePointInTimeFinderOptions", + ", dependencies?: ", + "SavedObjectsCreatePointInTimeFinderDependencies", + " | undefined) => ", + "ISavedObjectsPointInTimeFinder", + "" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.createPointInTimeFinder.$1", + "type": "Object", + "tags": [], + "label": "findOptions", + "description": [], + "signature": [ + "SavedObjectsCreatePointInTimeFinderOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.createPointInTimeFinder.$2", + "type": "Object", + "tags": [], + "label": "dependencies", + "description": [], + "signature": [ + "SavedObjectsCreatePointInTimeFinderDependencies", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.collectMultiNamespaceReferences", + "type": "Function", + "tags": [], + "label": "collectMultiNamespaceReferences", + "description": [ + "\nGets all references and transitive references of the listed objects. Ignores any object that is not a multi-namespace type.\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsCollectMultiNamespaceReferencesObject", + "[], options?: ", + "SavedObjectsCollectMultiNamespaceReferencesOptions", + " | undefined) => Promise<", + "SavedObjectsCollectMultiNamespaceReferencesResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.collectMultiNamespaceReferences.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "SavedObjectsCollectMultiNamespaceReferencesObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.collectMultiNamespaceReferences.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsCollectMultiNamespaceReferencesOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.updateObjectsSpaces", + "type": "Function", + "tags": [], + "label": "updateObjectsSpaces", + "description": [ + "\nUpdates one or more objects to add and/or remove them from specified spaces.\n" + ], + "signature": [ + "(objects: ", + "SavedObjectsUpdateObjectsSpacesObject", + "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + "SavedObjectsUpdateObjectsSpacesOptions", + " | undefined) => Promise<", + "SavedObjectsUpdateObjectsSpacesResponse", + ">" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.updateObjectsSpaces.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "SavedObjectsUpdateObjectsSpacesObject", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.updateObjectsSpaces.$2", + "type": "Array", + "tags": [], + "label": "spacesToAdd", + "description": [], + "signature": [ + "string[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.updateObjectsSpaces.$3", + "type": "Array", + "tags": [], + "label": "spacesToRemove", + "description": [], + "signature": [ + "string[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientContract.updateObjectsSpaces.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsUpdateObjectsSpacesOptions", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClosePointInTimeResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsClosePointInTimeResponse", + "description": [], + "signature": [ + "SavedObjectsClosePointInTimeResponse" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClosePointInTimeResponse.succeeded", + "type": "boolean", + "tags": [], + "label": "succeeded", + "description": [ + "\nIf true, all search contexts associated with the PIT id are\nsuccessfully closed." + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClosePointInTimeResponse.num_freed", + "type": "number", + "tags": [], + "label": "num_freed", + "description": [ + "\nThe number of search contexts that have been successfully closed." + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCollectMultiNamespaceReferencesObject", + "description": [ + "\nAn object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the\n`namespaceType: 'multiple'` or `namespaceType: 'multiple-isolated'` option).\n\nNote: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with\nthe `namespaceType: 'multiple'`).\n" + ], + "signature": [ + "SavedObjectsCollectMultiNamespaceReferencesObject" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCollectMultiNamespaceReferencesOptions", + "description": [ + "\nOptions for collecting references.\n" + ], + "signature": [ + "SavedObjectsCollectMultiNamespaceReferencesOptions", + " extends ", + "SavedObjectsBaseOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions.purpose", + "type": "CompoundType", + "tags": [], + "label": "purpose", + "description": [ + "Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences'" + ], + "signature": [ + "\"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCollectMultiNamespaceReferencesResponse", + "description": [ + "\nThe response when object references are collected.\n" + ], + "signature": [ + "SavedObjectsCollectMultiNamespaceReferencesResponse" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse.objects", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + "SavedObjectReferenceWithContext", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCreateOptions", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsCreateOptions", + " extends ", + "SavedObjectsBaseOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "(not recommended) Specify an id for the document" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [ + "Overwrite existing documents (defaults to false)" + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nAn opaque version number which changes on each successful write operation.\nCan be used in conjunction with `overwrite` for implementing optimistic concurrency control." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [ + "{@inheritDoc SavedObjectsMigrationVersion}" + ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.coreMigrationVersion", + "type": "string", + "tags": [], + "label": "coreMigrationVersion", + "description": [ + "\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "signature": [ + "MutatingOperationRefreshSetting", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "Optional ID of the original saved object, if this object's `id` was regenerated" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreateOptions.initialNamespaces", + "type": "Array", + "tags": [], + "label": "initialNamespaces", + "description": [ + "\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used." + ], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCreatePointInTimeFinderDependencies", + "description": [], + "signature": [ + "SavedObjectsCreatePointInTimeFinderDependencies" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies.client", + "type": "Object", + "tags": [], + "label": "client", + "description": [], + "signature": [ + "{ find: (options: ", + "SavedObjectsFindOptions", + ") => Promise<", + "SavedObjectsFindResponse", + ">; closePointInTime: (id: string, options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObjectsClosePointInTimeResponse", + ">; openPointInTimeForType: (type: string | string[], options?: ", + "SavedObjectsOpenPointInTimeOptions", + " | undefined) => Promise<", + "SavedObjectsOpenPointInTimeResponse", + ">; }" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsDeleteByNamespaceOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsDeleteByNamespaceOptions", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsDeleteByNamespaceOptions", + " extends ", + "SavedObjectsBaseOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsDeleteByNamespaceOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch supports only boolean flag for this operation" + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsDeleteOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsDeleteOptions", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsDeleteOptions", + " extends ", + "SavedObjectsBaseOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsDeleteOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "signature": [ + "MutatingOperationRefreshSetting", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsDeleteOptions.force", + "type": "CompoundType", + "tags": [], + "label": "force", + "description": [ + "Force deletion of an object that exists in multiple namespaces" + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsFindOptions", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsFindOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | string[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.page", + "type": "number", + "tags": [], + "label": "page", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.perPage", + "type": "number", + "tags": [], + "label": "perPage", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.sortField", + "type": "string", + "tags": [], + "label": "sortField", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.sortOrder", + "type": "CompoundType", + "tags": [], + "label": "sortOrder", + "description": [], + "signature": [ + "SortOrder", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.fields", + "type": "Array", + "tags": [], + "label": "fields", + "description": [ + "\nAn array of fields to include in the results" + ], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.search", + "type": "string", + "tags": [], + "label": "search", + "description": [ + "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.searchFields", + "type": "Array", + "tags": [], + "label": "searchFields", + "description": [ + "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" + ], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.searchAfter", + "type": "Array", + "tags": [], + "label": "searchAfter", + "description": [ + "\nUse the sort values from the previous page to retrieve the next page of results." + ], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.rootSearchFields", + "type": "Array", + "tags": [], + "label": "rootSearchFields", + "description": [ + "\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together." + ], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.hasReference", + "type": "CompoundType", + "tags": [], + "label": "hasReference", + "description": [ + "\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references." + ], + "signature": [ + "SavedObjectsFindOptionsReference", " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateByQueryResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRequest", + "SavedObjectsFindOptionsReference", + "[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.hasReferenceOperator", + "type": "CompoundType", + "tags": [], + "label": "hasReferenceOperator", + "description": [ + "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" + ], + "signature": [ + "\"AND\" | \"OR\" | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.defaultSearchOperator", + "type": "CompoundType", + "tags": [], + "label": "defaultSearchOperator", + "description": [ + "\nThe search operator to use with the provided filter. Defaults to `OR`" + ], + "signature": [ + "\"AND\" | \"OR\" | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.filter", + "type": "Any", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.aggs", + "type": "Object", + "tags": [ + "alpha" + ], + "label": "aggs", + "description": [ + "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" + ], + "signature": [ + "Record | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.typeToNamespacesMap", + "type": "Object", + "tags": [], + "label": "typeToNamespacesMap", + "description": [ + "\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace." + ], + "signature": [ + "Map | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.preference", + "type": "string", + "tags": [], + "label": "preference", + "description": [ + "An optional ES preference value to be used for the query" + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptions.pit", + "type": "Object", + "tags": [], + "label": "pit", + "description": [ + "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." + ], + "signature": [ + "SavedObjectsPitParams", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptionsReference", + "type": "Interface", + "tags": [], + "label": "SavedObjectsFindOptionsReference", + "description": [], + "signature": [ + "SavedObjectsFindOptionsReference" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptionsReference.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindOptionsReference.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsFindResponse", + "description": [ + "\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n" + ], + "signature": [ + "SavedObjectsFindResponse", + "" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResponse.aggregations", + "type": "Uncategorized", + "tags": [], + "label": "aggregations", + "description": [], + "signature": [ + "A | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResponse.saved_objects", + "type": "Array", + "tags": [], + "label": "saved_objects", + "description": [], + "signature": [ + "SavedObjectsFindResult", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResponse.total", + "type": "number", + "tags": [], + "label": "total", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResponse.per_page", + "type": "number", + "tags": [], + "label": "per_page", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResponse.page", + "type": "number", + "tags": [], + "label": "page", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResponse.pit_id", + "type": "string", + "tags": [], + "label": "pit_id", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResult", + "type": "Interface", + "tags": [], + "label": "SavedObjectsFindResult", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsFindResult", + " extends ", + "SavedObject", + "" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResult.score", + "type": "number", + "tags": [], + "label": "score", + "description": [ + "\nThe Elasticsearch `_score` of this result." + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsFindResult.sort", + "type": "Array", + "tags": [], + "label": "sort", + "description": [ + "\nThe Elasticsearch `sort` value of this result.\n" + ], + "signature": [ + "string[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportActionRequiredWarning", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportActionRequiredWarning", + "description": [ + "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" + ], + "signature": [ + "SavedObjectsImportActionRequiredWarning" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportActionRequiredWarning.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"action_required\"" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportActionRequiredWarning.message", + "type": "string", + "tags": [], + "label": "message", + "description": [ + "The translated message to display to the user." + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportActionRequiredWarning.actionPath", + "type": "string", + "tags": [], + "label": "actionPath", + "description": [ + "The path (without the basePath) that the user should be redirect to address this warning." + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportActionRequiredWarning.buttonLabel", + "type": "string", + "tags": [], + "label": "buttonLabel", + "description": [ + "An optional label to use for the link button. If unspecified, a default label will be used." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportAmbiguousConflictError", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportAmbiguousConflictError", + "description": [ + "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." + ], + "signature": [ + "SavedObjectsImportAmbiguousConflictError" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportAmbiguousConflictError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"ambiguous_conflict\"" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportAmbiguousConflictError.destinations", + "type": "Array", + "tags": [], + "label": "destinations", + "description": [], + "signature": [ + "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportConflictError", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportConflictError", + "description": [ + "\nRepresents a failure to import due to a conflict." + ], + "signature": [ + "SavedObjectsImportConflictError" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportConflictError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"conflict\"" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportConflictError.destinationId", + "type": "string", + "tags": [], + "label": "destinationId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportFailure", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportFailure", + "description": [ + "\nRepresents a failure to import." + ], + "signature": [ + "SavedObjectsImportFailure" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportFailure.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportFailure.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportFailure.meta", + "type": "Object", + "tags": [], + "label": "meta", + "description": [], + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportFailure.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [ + "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportFailure.error", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "SavedObjectsImportConflictError", " | ", - "UpdateByQueryRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryResponse", - ">; }; updateByQueryRethrottle: { (this: That, params: ", - "UpdateByQueryRethrottleRequest", + "SavedObjectsImportAmbiguousConflictError", " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithOutMeta", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; (this: That, params: ", - "UpdateByQueryRethrottleRequest", + "SavedObjectsImportUnsupportedTypeError", " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptionsWithMeta", - " | undefined): Promise<", - "TransportResult", - "<", - "UpdateByQueryRethrottleResponse", - ", unknown>>; (this: That, params: ", - "UpdateByQueryRethrottleRequest", + "SavedObjectsImportMissingReferencesError", " | ", - "UpdateByQueryRethrottleRequest", - ", options?: ", - "TransportRequestOptions", - " | undefined): Promise<", - "UpdateByQueryRethrottleResponse", - ">; }; watcher: ", - "default", - "; xpack: ", - "default", - "; }" + "SavedObjectsImportUnknownError" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportMissingReferencesError", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportMissingReferencesError", + "description": [ + "\nRepresents a failure to import due to missing references." + ], + "signature": [ + "SavedObjectsImportMissingReferencesError" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportMissingReferencesError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"missing_references\"" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportMissingReferencesError.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "{ type: string; id: string; }[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportResponse", + "description": [ + "\nThe response describing the result of an import." + ], + "signature": [ + "SavedObjectsImportResponse" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportResponse.success", + "type": "boolean", + "tags": [], + "label": "success", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportResponse.successCount", + "type": "number", + "tags": [], + "label": "successCount", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportResponse.successResults", + "type": "Array", + "tags": [], + "label": "successResults", + "description": [], + "signature": [ + "SavedObjectsImportSuccess", + "[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportResponse.warnings", + "type": "Array", + "tags": [], + "label": "warnings", + "description": [], + "signature": [ + "SavedObjectsImportWarning", + "[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportResponse.errors", + "type": "Array", + "tags": [], + "label": "errors", + "description": [], + "signature": [ + "SavedObjectsImportFailure", + "[] | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportRetry", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportRetry", + "description": [ + "\nDescribes a retry operation for importing a saved object." + ], + "signature": [ + "SavedObjectsImportRetry" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportRetry.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportRetry.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportRetry.overwrite", + "type": "boolean", + "tags": [], + "label": "overwrite", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportRetry.destinationId", + "type": "string", + "tags": [], + "label": "destinationId", + "description": [ + "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportRetry.replaceReferences", + "type": "Array", + "tags": [], + "label": "replaceReferences", + "description": [], + "signature": [ + "{ type: string; from: string; to: string; }[]" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportRetry.createNewCopy", + "type": "CompoundType", + "tags": [], + "label": "createNewCopy", + "description": [ + "\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportRetry.ignoreMissingReferences", + "type": "CompoundType", + "tags": [], + "label": "ignoreMissingReferences", + "description": [ + "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportSimpleWarning", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportSimpleWarning", + "description": [ + "\nA simple informative warning that will be displayed to the user.\n" + ], + "signature": [ + "SavedObjectsImportSimpleWarning" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportSimpleWarning.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"simple\"" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportSimpleWarning.message", + "type": "string", + "tags": [], + "label": "message", + "description": [ + "The translated message to display to the user" ], - "path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportSuccess", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportSuccess", + "description": [ + "\nRepresents a successful import." + ], + "signature": [ + "SavedObjectsImportSuccess" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.PollEsNodesVersionOptions.log", - "type": "Object", + "id": "def-server.SavedObjectsImportSuccess.id", + "type": "string", "tags": [], - "label": "log", + "label": "id", "description": [], - "signature": [ - "Logger" - ], - "path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PollEsNodesVersionOptions.kibanaVersion", + "id": "def-server.SavedObjectsImportSuccess.type", "type": "string", "tags": [], - "label": "kibanaVersion", + "label": "type", "description": [], - "path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PollEsNodesVersionOptions.ignoreVersionMismatch", - "type": "boolean", + "id": "def-server.SavedObjectsImportSuccess.destinationId", + "type": "string", "tags": [], - "label": "ignoreVersionMismatch", - "description": [], - "path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts", + "label": "destinationId", + "description": [ + "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." + ], + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PollEsNodesVersionOptions.esVersionCheckInterval", - "type": "number", + "id": "def-server.SavedObjectsImportSuccess.createNewCopy", + "type": "CompoundType", + "tags": [ + "deprecated" + ], + "label": "createNewCopy", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": true, + "references": [ + { + "plugin": "spaces", + "path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx" + }, + { + "plugin": "savedObjectsManagement", + "path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts" + } + ] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportSuccess.meta", + "type": "Object", "tags": [], - "label": "esVersionCheckInterval", + "label": "meta", "description": [], - "path": "node_modules/@types/kbn__core-elasticsearch-server-internal/index.d.ts", + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportSuccess.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [ + "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -25602,205 +31594,204 @@ }, { "parentPluginId": "core", - "id": "def-server.PrebootPlugin", + "id": "def-server.SavedObjectsImportUnknownError", "type": "Interface", "tags": [], - "label": "PrebootPlugin", + "label": "SavedObjectsImportUnknownError", "description": [ - "\nThe interface that should be returned by a `PluginInitializer` for a `preboot` plugin.\n" + "\nRepresents a failure to import due to an unknown reason." ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.PrebootPlugin", - "text": "PrebootPlugin" - }, - "" + "SavedObjectsImportUnknownError" ], - "path": "src/core/server/plugins/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.PrebootPlugin.setup", - "type": "Function", + "id": "def-server.SavedObjectsImportUnknownError.type", + "type": "string", "tags": [], - "label": "setup", + "label": "type", "description": [], "signature": [ - "(core: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CorePreboot", - "text": "CorePreboot" - }, - ", plugins: TPluginsSetup) => TSetup" - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.PrebootPlugin.setup.$1", - "type": "Object", - "tags": [], - "label": "core", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CorePreboot", - "text": "CorePreboot" - } - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.PrebootPlugin.setup.$2", - "type": "Uncategorized", - "tags": [], - "label": "plugins", - "description": [], - "signature": [ - "TPluginsSetup" - ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "isRequired": true - } + "\"unknown\"" ], - "returnComment": [] + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.PrebootPlugin.stop", - "type": "Function", + "id": "def-server.SavedObjectsImportUnknownError.message", + "type": "string", "tags": [], - "label": "stop", + "label": "message", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportUnknownError.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportUnsupportedTypeError", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportUnsupportedTypeError", + "description": [ + "\nRepresents a failure to import due to having an unsupported saved object type." + ], + "signature": [ + "SavedObjectsImportUnsupportedTypeError" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportUnsupportedTypeError.type", + "type": "string", + "tags": [], + "label": "type", "description": [], "signature": [ - "(() => void) | undefined" + "\"unsupported_type\"" ], - "path": "src/core/server/plugins/types.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.RegisterDeprecationsConfig", + "id": "def-server.SavedObjectsIncrementCounterField", "type": "Interface", "tags": [], - "label": "RegisterDeprecationsConfig", + "label": "SavedObjectsIncrementCounterField", "description": [], - "path": "src/core/server/deprecations/types.ts", + "signature": [ + "SavedObjectsIncrementCounterField" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RegisterDeprecationsConfig.getDeprecations", - "type": "Function", + "id": "def-server.SavedObjectsIncrementCounterField.fieldName", + "type": "string", "tags": [], - "label": "getDeprecations", - "description": [], - "signature": [ - "(context: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.GetDeprecationsContext", - "text": "GetDeprecationsContext" - }, - ") => ", - "MaybePromise", - "<", - "DeprecationsDetails", - "[]>" + "label": "fieldName", + "description": [ + "The field name to increment the counter by." ], - "path": "src/core/server/deprecations/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RegisterDeprecationsConfig.getDeprecations.$1", - "type": "Object", - "tags": [], - "label": "context", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.GetDeprecationsContext", - "text": "GetDeprecationsContext" - } - ], - "path": "src/core/server/deprecations/types.ts", - "deprecated": false, - "isRequired": true - } + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsIncrementCounterField.incrementBy", + "type": "number", + "tags": [], + "label": "incrementBy", + "description": [ + "The number to increment the field by (defaults to 1)." ], - "returnComment": [] + "signature": [ + "number | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.RequestHandlerContext", + "id": "def-server.SavedObjectsIncrementCounterOptions", "type": "Interface", "tags": [], - "label": "RequestHandlerContext", - "description": [ - "\nBase context passed to a route handler, containing the `core` context part.\n" - ], + "label": "SavedObjectsIncrementCounterOptions", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.RequestHandlerContext", - "text": "RequestHandlerContext" - }, - " extends ", - "RequestHandlerContextBase" + "SavedObjectsIncrementCounterOptions", + " extends ", + "SavedObjectsBaseOptions" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RequestHandlerContext.core", + "id": "def-server.SavedObjectsIncrementCounterOptions.initialize", + "type": "CompoundType", + "tags": [], + "label": "initialize", + "description": [ + "\n(default=false) If true, sets all the counter fields to 0 if they don't\nalready exist. Existing fields will be left as-is and won't be incremented." + ], + "signature": [ + "boolean | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion", "type": "Object", "tags": [], - "label": "core", - "description": [], + "label": "migrationVersion", + "description": [ + "{@link SavedObjectsMigrationVersion}" + ], "signature": [ - "Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.CoreRequestHandlerContext", - "text": "CoreRequestHandlerContext" - }, - ">" + "SavedObjectsMigrationVersion", + " | undefined" ], - "path": "src/core/server/index.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsIncrementCounterOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "\n(default='wait_for') The Elasticsearch refresh setting for this\noperation. See {@link MutatingOperationRefreshSetting}" + ], + "signature": [ + "MutatingOperationRefreshSetting", + " | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsIncrementCounterOptions.upsertAttributes", + "type": "Uncategorized", + "tags": [], + "label": "upsertAttributes", + "description": [ + "\nAttributes to use when upserting the document if it doesn't exist." + ], + "signature": [ + "Attributes | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false } ], @@ -25808,26 +31799,30 @@ }, { "parentPluginId": "core", - "id": "def-server.ResolveCapabilitiesOptions", + "id": "def-server.SavedObjectsMigrationVersion", "type": "Interface", "tags": [], - "label": "ResolveCapabilitiesOptions", + "label": "SavedObjectsMigrationVersion", "description": [ - "\nDefines a set of additional options for the `resolveCapabilities` method of {@link CapabilitiesStart}.\n" + "\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n" + ], + "signature": [ + "SavedObjectsMigrationVersion" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ResolveCapabilitiesOptions.useDefaultCapabilities", - "type": "boolean", + "id": "def-server.SavedObjectsMigrationVersion.Unnamed", + "type": "IndexSignature", "tags": [], - "label": "useDefaultCapabilities", - "description": [ - "\nIndicates if capability switchers are supposed to return a default set of capabilities." + "label": "[pluginName: string]: string", + "description": [], + "signature": [ + "[pluginName: string]: string" ], - "path": "src/core/server/capabilities/capabilities_service.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false } ], @@ -25835,63 +31830,60 @@ }, { "parentPluginId": "core", - "id": "def-server.RouteConfig", + "id": "def-server.SavedObjectsOpenPointInTimeOptions", "type": "Interface", "tags": [], - "label": "RouteConfig", - "description": [ - "\nRoute specific configuration." - ], + "label": "SavedObjectsOpenPointInTimeOptions", + "description": [], "signature": [ - "RouteConfig", - "" + "SavedObjectsOpenPointInTimeOptions" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RouteConfig.path", + "id": "def-server.SavedObjectsOpenPointInTimeOptions.keepAlive", "type": "string", "tags": [], - "label": "path", + "label": "keepAlive", "description": [ - "\nThe endpoint _within_ the router path to register the route.\n" + "\nOptionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`." ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "signature": [ + "string | undefined" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.RouteConfig.validate", - "type": "CompoundType", + "id": "def-server.SavedObjectsOpenPointInTimeOptions.preference", + "type": "string", "tags": [], - "label": "validate", + "label": "preference", "description": [ - "\nA schema created with `@kbn/config-schema` that every request will be validated against.\n" + "\nAn optional ES preference value to be used for the query." ], "signature": [ - "false | ", - "RouteValidatorFullConfig", - "" + "string | undefined" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.RouteConfig.options", - "type": "Object", + "id": "def-server.SavedObjectsOpenPointInTimeOptions.namespaces", + "type": "Array", "tags": [], - "label": "options", + "label": "namespaces", "description": [ - "\nAdditional route options {@link RouteConfigOptions}." + "\nAn optional list of namespaces to be used when opening the PIT.\n\nWhen the spaces plugin is enabled:\n - this will default to the user's current space (as determined by the URL)\n - if specified, the user's current space will be ignored\n - `['*']` will search across all available spaces" ], "signature": [ - "RouteConfigOptions", - " | undefined" + "string[] | undefined" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false } ], @@ -25899,95 +31891,133 @@ }, { "parentPluginId": "core", - "id": "def-server.RouteConfigOptions", + "id": "def-server.SavedObjectsOpenPointInTimeResponse", "type": "Interface", "tags": [], - "label": "RouteConfigOptions", - "description": [ - "\nAdditional route options." - ], + "label": "SavedObjectsOpenPointInTimeResponse", + "description": [], "signature": [ - "RouteConfigOptions", - "" + "SavedObjectsOpenPointInTimeResponse" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.authRequired", - "type": "CompoundType", + "id": "def-server.SavedObjectsOpenPointInTimeResponse.id", + "type": "string", "tags": [], - "label": "authRequired", + "label": "id", "description": [ - "\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource, and will be authenticated if provided credentials are valid.\n Can be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered." + "\nPIT ID returned from ES." ], - "signature": [ - "boolean | \"optional\" | undefined" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsPitParams", + "type": "Interface", + "tags": [], + "label": "SavedObjectsPitParams", + "description": [], + "signature": [ + "SavedObjectsPitParams" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.xsrfRequired", - "type": "Uncategorized", + "id": "def-server.SavedObjectsPitParams.id", + "type": "string", "tags": [], - "label": "xsrfRequired", - "description": [ - "\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default" - ], - "signature": [ - "(Method extends \"get\" ? never : boolean) | undefined" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "label": "id", + "description": [], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.tags", - "type": "Object", + "id": "def-server.SavedObjectsPitParams.keepAlive", + "type": "string", "tags": [], - "label": "tags", - "description": [ - "\nAdditional metadata tag strings to attach to the route." - ], + "label": "keepAlive", + "description": [], "signature": [ - "readonly string[] | undefined" + "string | undefined" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRemoveReferencesToOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsRemoveReferencesToOptions", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsRemoveReferencesToOptions", + " extends ", + "SavedObjectsBaseOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.body", - "type": "Uncategorized", + "id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh", + "type": "CompoundType", "tags": [], - "label": "body", + "label": "refresh", "description": [ - "\nAdditional body options {@link RouteConfigOptionsBody}." + "The Elasticsearch Refresh setting for this operation. Defaults to `true`" ], "signature": [ - "(Method extends \"options\" | \"get\" ? undefined : ", - "RouteConfigOptionsBody", - ") | undefined" + "boolean | undefined" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRemoveReferencesToResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsRemoveReferencesToResponse", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsRemoveReferencesToResponse", + " extends ", + "SavedObjectsBaseOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.RouteConfigOptions.timeout", - "type": "Object", + "id": "def-server.SavedObjectsRemoveReferencesToResponse.updated", + "type": "number", "tags": [], - "label": "timeout", + "label": "updated", "description": [ - "\nDefines per-route timeouts." + "The number of objects that have been updated by this operation" ], - "signature": [ - "{ payload?: (Method extends \"options\" | \"get\" ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false } ], @@ -25995,79 +32025,79 @@ }, { "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody", + "id": "def-server.SavedObjectsResolveResponse", "type": "Interface", "tags": [], - "label": "RouteConfigOptionsBody", + "label": "SavedObjectsResolveResponse", "description": [ - "\nAdditional body options for a route" + "\n" ], "signature": [ - "RouteConfigOptionsBody" + "SavedObjectsResolveResponse", + "" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.accepts", - "type": "CompoundType", + "id": "def-server.SavedObjectsResolveResponse.saved_object", + "type": "Object", "tags": [], - "label": "accepts", + "label": "saved_object", "description": [ - "\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*" + "\nThe saved object that was found." ], "signature": [ - "string | string[] | ", - "RouteContentType", - "[] | undefined" + "SavedObject", + "" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.maxBytes", - "type": "number", + "id": "def-server.SavedObjectsResolveResponse.outcome", + "type": "CompoundType", "tags": [], - "label": "maxBytes", + "label": "outcome", "description": [ - "\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayload`." + "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." ], "signature": [ - "number | undefined" + "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.output", - "type": "CompoundType", + "id": "def-server.SavedObjectsResolveResponse.alias_target_id", + "type": "string", "tags": [], - "label": "output", + "label": "alias_target_id", "description": [ - "\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure." + "\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." ], "signature": [ - "\"data\" | \"stream\" | undefined" + "string | undefined" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.RouteConfigOptionsBody.parse", + "id": "def-server.SavedObjectsResolveResponse.alias_purpose", "type": "CompoundType", "tags": [], - "label": "parse", + "label": "alias_purpose", "description": [ - "\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure." + "\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." ], "signature": [ - "boolean | \"gunzip\" | undefined" + "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false } ], @@ -26075,160 +32105,77 @@ }, { "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory", + "id": "def-server.SavedObjectsUpdateObjectsSpacesObject", "type": "Interface", "tags": [], - "label": "RouteValidationResultFactory", + "label": "SavedObjectsUpdateObjectsSpacesObject", "description": [ - "\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n" + "\nAn object that should have its spaces updated.\n" ], "signature": [ - "RouteValidationResultFactory" + "SavedObjectsUpdateObjectsSpacesObject" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.ok", - "type": "Function", + "id": "def-server.SavedObjectsUpdateObjectsSpacesObject.id", + "type": "string", "tags": [], - "label": "ok", - "description": [], - "signature": [ - "(value: T) => { value: T; }" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.ok.$1", - "type": "Uncategorized", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "T" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", - "deprecated": false, - "isRequired": true - } + "label": "id", + "description": [ + "The type of the object to update" ], - "returnComment": [] + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.badRequest", - "type": "Function", + "id": "def-server.SavedObjectsUpdateObjectsSpacesObject.type", + "type": "string", "tags": [], - "label": "badRequest", - "description": [], - "signature": [ - "(error: string | Error, path?: string[] | undefined) => { error: ", - "RouteValidationError", - "; }" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.badRequest.$1", - "type": "CompoundType", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "string | Error" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidationResultFactory.badRequest.$2", - "type": "Array", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", - "deprecated": false, - "isRequired": false - } + "label": "type", + "description": [ + "The ID of the object to update" ], - "returnComment": [] + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig", + "id": "def-server.SavedObjectsUpdateObjectsSpacesOptions", "type": "Interface", "tags": [], - "label": "RouteValidatorConfig", + "label": "SavedObjectsUpdateObjectsSpacesOptions", "description": [ - "\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n" + "\nOptions for the update operation.\n" ], "signature": [ - "RouteValidatorConfig", - "" + "SavedObjectsUpdateObjectsSpacesOptions", + " extends ", + "SavedObjectsBaseOptions" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig.params", - "type": "CompoundType", - "tags": [], - "label": "params", - "description": [ - "\nValidation logic for the URL params" - ], - "signature": [ - "RouteValidationSpec", - "

| undefined" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig.query", - "type": "CompoundType", - "tags": [], - "label": "query", - "description": [ - "\nValidation logic for the Query params" - ], - "signature": [ - "RouteValidationSpec", - " | undefined" - ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.RouteValidatorConfig.body", + "id": "def-server.SavedObjectsUpdateObjectsSpacesOptions.refresh", "type": "CompoundType", "tags": [], - "label": "body", + "label": "refresh", "description": [ - "\nValidation logic for the body payload" + "The Elasticsearch Refresh setting for this operation" ], "signature": [ - "RouteValidationSpec", - " | undefined" + "MutatingOperationRefreshSetting", + " | undefined" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false } ], @@ -26236,32 +32183,31 @@ }, { "parentPluginId": "core", - "id": "def-server.RouteValidatorOptions", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponse", "type": "Interface", "tags": [], - "label": "RouteValidatorOptions", + "label": "SavedObjectsUpdateObjectsSpacesResponse", "description": [ - "\nAdditional options for the RouteValidator class to modify its default behaviour.\n" + "\nThe response when objects' spaces are updated.\n" ], "signature": [ - "RouteValidatorOptions" + "SavedObjectsUpdateObjectsSpacesResponse" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.RouteValidatorOptions.unsafe", - "type": "Object", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponse.objects", + "type": "Array", "tags": [], - "label": "unsafe", - "description": [ - "\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation" - ], + "label": "objects", + "description": [], "signature": [ - "{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined" + "SavedObjectsUpdateObjectsSpacesResponseObject", + "[]" ], - "path": "node_modules/@types/kbn__core-http-server/index.d.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false } ], @@ -26269,176 +32215,169 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObject", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject", "type": "Interface", "tags": [], - "label": "SavedObject", - "description": [], + "label": "SavedObjectsUpdateObjectsSpacesResponseObject", + "description": [ + "\nDetails about a specific object's update result.\n" + ], "signature": [ - "SavedObject", - "" + "SavedObjectsUpdateObjectsSpacesResponseObject" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObject.id", - "type": "string", - "tags": [], - "label": "id", - "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", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObject.type", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.type", "type": "string", "tags": [], "label": "type", "description": [ - " The type of Saved Object. Each plugin can define it's own custom Saved Object types." + "The type of the referenced object" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObject.version", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.id", "type": "string", "tags": [], - "label": "version", + "label": "id", "description": [ - "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." - ], - "signature": [ - "string | undefined" + "The ID of the referenced object" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObject.updated_at", - "type": "string", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.spaces", + "type": "Array", "tags": [], - "label": "updated_at", + "label": "spaces", "description": [ - "Timestamp of the last time this document had been updated." + "The space(s) that the referenced object exists in" ], "signature": [ - "string | undefined" + "string[]" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObject.error", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.error", "type": "Object", "tags": [], "label": "error", - "description": [], - "signature": [ - "SavedObjectError", - " | undefined" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObject.attributes", - "type": "Uncategorized", - "tags": [], - "label": "attributes", "description": [ - "{@inheritdoc SavedObjectAttributes}" + "Included if there was an error updating this object's spaces" ], "signature": [ - "T" + "SavedObjectError", + " | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUpdateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateOptions", + "description": [ + "\n" + ], + "signature": [ + "SavedObjectsUpdateOptions", + " extends ", + "SavedObjectsBaseOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObject.references", - "type": "Array", + "id": "def-server.SavedObjectsUpdateOptions.version", + "type": "string", "tags": [], - "label": "references", + "label": "version", "description": [ - "{@inheritdoc SavedObjectReference}" + "\nAn opaque version number which changes on each successful write operation.\nCan be used for implementing optimistic concurrency control." ], "signature": [ - "SavedObjectReference", - "[]" + "string | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObject.migrationVersion", - "type": "Object", + "id": "def-server.SavedObjectsUpdateOptions.references", + "type": "Array", "tags": [], - "label": "migrationVersion", + "label": "references", "description": [ - "{@inheritdoc SavedObjectsMigrationVersion}" + "{@inheritdoc SavedObjectReference}" ], "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" + "SavedObjectReference", + "[] | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObject.coreMigrationVersion", - "type": "string", + "id": "def-server.SavedObjectsUpdateOptions.refresh", + "type": "CompoundType", "tags": [], - "label": "coreMigrationVersion", + "label": "refresh", "description": [ - "A semver value that is used when upgrading objects between Kibana versions." + "The Elasticsearch Refresh setting for this operation" ], "signature": [ - "string | undefined" + "MutatingOperationRefreshSetting", + " | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObject.namespaces", - "type": "Array", + "id": "def-server.SavedObjectsUpdateOptions.upsert", + "type": "Uncategorized", "tags": [], - "label": "namespaces", + "label": "upsert", "description": [ - "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." + "If specified, will be used to perform an upsert if the document doesn't exist" ], "signature": [ - "string[] | undefined" + "Attributes | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObject.originId", - "type": "string", + "id": "def-server.SavedObjectsUpdateOptions.retryOnConflict", + "type": "number", "tags": [], - "label": "originId", + "label": "retryOnConflict", "description": [ - "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." + "\nThe Elasticsearch `retry_on_conflict` setting for this operation.\nDefaults to `0` when `version` is provided, `3` otherwise." ], "signature": [ - "string | undefined" + "number | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false } ], @@ -26446,101 +32385,47 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectAttributes", + "id": "def-server.SavedObjectsUpdateResponse", "type": "Interface", "tags": [], - "label": "SavedObjectAttributes", + "label": "SavedObjectsUpdateResponse", "description": [ - "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" + "\n" + ], + "signature": [ + "SavedObjectsUpdateResponse", + " extends Omit<", + "SavedObject", + ", \"attributes\" | \"references\">" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectAttributes.Unnamed", - "type": "IndexSignature", + "id": "def-server.SavedObjectsUpdateResponse.attributes", + "type": "Object", "tags": [], - "label": "[key: string]: SavedObjectAttribute", + "label": "attributes", "description": [], "signature": [ - "[key: string]: ", - "SavedObjectAttribute" + "{ [P in keyof T]?: T[P] | undefined; }" ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectReference", - "type": "Interface", - "tags": [], - "label": "SavedObjectReference", - "description": [ - "\nA reference to another saved object.\n" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectReference.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectReference.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectReference.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/types/saved_objects.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationVersion", - "type": "Interface", - "tags": [], - "label": "SavedObjectsMigrationVersion", - "description": [ - "\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n" - ], - "path": "src/core/types/saved_objects.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationVersion.Unnamed", - "type": "IndexSignature", + "id": "def-server.SavedObjectsUpdateResponse.references", + "type": "Array", "tags": [], - "label": "[pluginName: string]: string", + "label": "references", "description": [], "signature": [ - "[pluginName: string]: string" + "SavedObjectReference", + "[] | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false } ], @@ -27591,13 +33476,7 @@ ], "signature": [ "(savedObjectsClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ") => ", { "pluginId": "core", @@ -27618,13 +33497,7 @@ "label": "savedObjectsClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "src/core/server/ui_settings/types.ts", "deprecated": false, @@ -28210,7 +34083,7 @@ "Capabilities", ">" ], - "path": "src/core/server/capabilities/types.ts", + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false, "returnComment": [], "children": [], @@ -28230,13 +34103,13 @@ "KibanaRequest", ", uiCapabilities: ", "Capabilities", - ", useDefaultCapabilities: boolean) => Partial<", - "Capabilities", - "> | Promise ", + "MaybePromise", + ">" ], - "path": "src/core/server/capabilities/types.ts", + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false, "returnComment": [], "children": [ @@ -28251,7 +34124,7 @@ "KibanaRequest", "" ], - "path": "src/core/server/capabilities/types.ts", + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false }, { @@ -28264,7 +34137,7 @@ "signature": [ "Capabilities" ], - "path": "src/core/server/capabilities/types.ts", + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false }, { @@ -28274,7 +34147,7 @@ "tags": [], "label": "useDefaultCapabilities", "description": [], - "path": "src/core/server/capabilities/types.ts", + "path": "node_modules/@types/kbn__core-capabilities-server/index.d.ts", "deprecated": false } ], @@ -28529,6 +34402,8 @@ "EcsError", " | undefined; event?: ", "EcsEvent", + " | undefined; faas?: ", + "EcsFaas", " | undefined; file?: ", "EcsFile", " | undefined; group?: ", @@ -28589,7 +34464,7 @@ "label": "EcsEventCategory", "description": [], "signature": [ - "\"database\" | \"package\" | \"network\" | \"web\" | \"file\" | \"host\" | \"session\" | \"registry\" | \"process\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" + "\"database\" | \"email\" | \"package\" | \"network\" | \"web\" | \"file\" | \"host\" | \"session\" | \"registry\" | \"process\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" ], "path": "node_modules/@types/kbn__logging/index.d.ts", "deprecated": false, @@ -28631,7 +34506,7 @@ "label": "EcsEventType", "description": [], "signature": [ - "\"start\" | \"error\" | \"end\" | \"group\" | \"user\" | \"info\" | \"admin\" | \"protocol\" | \"access\" | \"allowed\" | \"change\" | \"connection\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" + "\"start\" | \"error\" | \"end\" | \"group\" | \"user\" | \"info\" | \"admin\" | \"protocol\" | \"connection\" | \"access\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" ], "path": "node_modules/@types/kbn__logging/index.d.ts", "deprecated": false, @@ -28741,32 +34616,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: { (this: That, params: ", "GetRequest", " | ", @@ -28819,32 +34668,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -28915,6 +34764,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", " | ", @@ -30066,7 +35941,7 @@ "\nHttp request headers to read." ], "signature": [ - "{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; connection?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, @@ -30305,7 +36180,7 @@ "label": "KibanaExecutionContext", "description": [], "signature": [ - "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; child?: ", + "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; readonly meta?: { [key: string]: string | number | boolean | undefined; } | undefined; child?: ", "KibanaExecutionContext", " | undefined; }" ], @@ -30399,7 +36274,7 @@ "\nSet of well-known HTTP headers." ], "signature": [ - "\"from\" | \"origin\" | \"warning\" | \"location\" | \"date\" | \"expires\" | \"range\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"connection\" | \"authorization\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" + "\"from\" | \"origin\" | \"warning\" | \"location\" | \"date\" | \"expires\" | \"range\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" ], "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, @@ -30539,15 +36414,25 @@ "\n{@inheritdoc MetricsServiceSetup}\n" ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCorePluginApi", - "section": "def-server.MetricsServiceSetup", - "text": "MetricsServiceSetup" - } + "MetricsServiceSetup" + ], + "path": "node_modules/@types/kbn__core-metrics-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.MutatingOperationRefreshSetting", + "type": "Type", + "tags": [], + "label": "MutatingOperationRefreshSetting", + "description": [ + "\nElasticsearch Refresh setting for mutating operation" + ], + "signature": [ + "boolean | \"wait_for\"" ], - "path": "src/core/server/metrics/types.ts", + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -31309,7 +37194,7 @@ "\nHttp response headers to set." ], "signature": [ - "Record<\"from\" | \"origin\" | \"warning\" | \"location\" | \"date\" | \"expires\" | \"range\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"connection\" | \"authorization\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" + "Record<\"from\" | \"origin\" | \"warning\" | \"location\" | \"date\" | \"expires\" | \"range\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" ], "path": "node_modules/@types/kbn__core-http-server/index.d.ts", "deprecated": false, @@ -31571,7 +37456,7 @@ "SavedObjectAttributeSingle", "[]" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, @@ -31589,7 +37474,77 @@ "SavedObjectAttributes", " | null | undefined" ], - "path": "src/core/types/saved_objects.ts", + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClosePointInTimeOptions", + "type": "Type", + "tags": [], + "label": "SavedObjectsClosePointInTimeOptions", + "description": [], + "signature": [ + "SavedObjectsBaseOptions" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "type": "Type", + "tags": [], + "label": "SavedObjectsCreatePointInTimeFinderOptions", + "description": [], + "signature": [ + "{ type: string | string[]; filter?: any; search?: string | undefined; aggs?: Record | undefined; fields?: string[] | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: ", + "SortOrder", + " | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; hasReference?: ", + "SavedObjectsFindOptionsReference", + " | ", + "SavedObjectsFindOptionsReference", + "[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map | undefined; preference?: string | undefined; }" + ], + "path": "node_modules/@types/kbn__core-saved-objects-api-server/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportWarning", + "type": "Type", + "tags": [], + "label": "SavedObjectsImportWarning", + "description": [ + "\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n" + ], + "signature": [ + "SavedObjectsImportSimpleWarning", + " | ", + "SavedObjectsImportActionRequiredWarning" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsNamespaceType", + "type": "Type", + "tags": [], + "label": "SavedObjectsNamespaceType", + "description": [ + "\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n" + ], + "signature": [ + "\"single\" | \"multiple\" | \"multiple-isolated\" | \"agnostic\"" + ], + "path": "node_modules/@types/kbn__core-saved-objects-common/index.d.ts", "deprecated": false, "initialIsOpen": false }, diff --git a/api_docs/core.mdx b/api_docs/core.mdx index 97ec05bb3b98c..6bf9b143686b7 100644 --- a/api_docs/core.mdx +++ b/api_docs/core.mdx @@ -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-25 +date: 2022-07-28 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 | |-------------------|-----------|------------------------|-----------------| -| 2470 | 5 | 664 | 17 | +| 2498 | 2 | 413 | 8 | ## Client diff --git a/api_docs/core_application.mdx b/api_docs/core_application.mdx index faa8242147241..20f35da12cad0 100644 --- a/api_docs/core_application.mdx +++ b/api_docs/core_application.mdx @@ -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-25 +date: 2022-07-28 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 | |-------------------|-----------|------------------------|-----------------| -| 2470 | 5 | 664 | 17 | +| 2498 | 2 | 413 | 8 | ## Client diff --git a/api_docs/core_chrome.mdx b/api_docs/core_chrome.mdx index 4a287852be382..55a6ed1778c99 100644 --- a/api_docs/core_chrome.mdx +++ b/api_docs/core_chrome.mdx @@ -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-25 +date: 2022-07-28 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 | |-------------------|-----------|------------------------|-----------------| -| 2470 | 5 | 664 | 17 | +| 2498 | 2 | 413 | 8 | ## Client diff --git a/api_docs/core_saved_objects.devdocs.json b/api_docs/core_saved_objects.devdocs.json index 3d6073848c4ff..e4b71a3e1832d 100644 --- a/api_docs/core_saved_objects.devdocs.json +++ b/api_docs/core_saved_objects.devdocs.json @@ -1,277 +1,186 @@ { "id": "core.savedObjects", "client": { - "classes": [ + "classes": [], + "functions": [], + "interfaces": [ { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject", - "type": "Class", + "id": "def-public.SavedObjectsStart", + "type": "Interface", "tags": [], - "label": "SimpleSavedObject", - "description": [ - "\nThis class is a very simple wrapper for SavedObjects loaded from the server\nwith the {@link SavedObjectsClientContract}.\n\nIt provides basic functionality for creating/saving/deleting saved objects,\nbut doesn't include any type-specific implementations.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - "" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "label": "SavedObjectsStart", + "description": [], + "path": "src/core/public/saved_objects/saved_objects_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.attributes", - "type": "Uncategorized", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "T" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject._version", - "type": "string", - "tags": [], - "label": "_version", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.migrationVersion", - "type": "Object", - "tags": [], - "label": "migrationVersion", - "description": [], - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.coreMigrationVersion", - "type": "string", - "tags": [], - "label": "coreMigrationVersion", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.error", + "id": "def-public.SavedObjectsStart.client", "type": "Object", "tags": [], - "label": "error", - "description": [], - "signature": [ - "SavedObjectError", - " | undefined" + "label": "client", + "description": [ + "{@link SavedObjectsClientContract}" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [], "signature": [ - "SavedObjectReference", - "[]" + "SavedObjectsClientContract" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/public/saved_objects/saved_objects_service.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers", + "type": "Class", + "tags": [], + "label": "SavedObjectsErrorHelpers", + "description": [], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.updatedAt", - "type": "string", + "id": "def-server.SavedObjectsErrorHelpers.isSavedObjectsClientError", + "type": "Function", "tags": [], - "label": "updatedAt", + "label": "isSavedObjectsClientError", "description": [], "signature": [ - "string | undefined" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [ - "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." + "(error: any) => error is ", + "DecoratedError" ], - "signature": [ - "string[] | undefined" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.isSavedObjectsClientError.$1", + "type": "Any", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "any" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.Unnamed", + "id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError", "type": "Function", "tags": [], - "label": "Constructor", + "label": "decorateBadRequestError", "description": [], "signature": [ - "any" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.Unnamed.$1", + "id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError.$1", "type": "Object", "tags": [], - "label": "client", + "label": "error", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "Error" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.Unnamed.$2", - "type": "Object", + "id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError.$2", + "type": "string", "tags": [], - "label": "{\n id,\n type,\n version,\n attributes,\n error,\n references,\n migrationVersion,\n coreMigrationVersion,\n namespaces,\n updated_at: updatedAt,\n }", + "label": "reason", "description": [], "signature": [ - "SavedObject", - "" + "string | undefined" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.get", + "id": "def-server.SavedObjectsErrorHelpers.createBadRequestError", "type": "Function", "tags": [], - "label": "get", + "label": "createBadRequestError", "description": [], "signature": [ - "(key: string) => any" + "(reason?: string | undefined) => ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.get.$1", + "id": "def-server.SavedObjectsErrorHelpers.createBadRequestError.$1", "type": "string", "tags": [], - "label": "key", + "label": "reason", "description": [], "signature": [ - "string" + "string | undefined" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.set", + "id": "def-server.SavedObjectsErrorHelpers.createUnsupportedTypeError", "type": "Function", "tags": [], - "label": "set", + "label": "createUnsupportedTypeError", "description": [], "signature": [ - "(key: string, value: any) => T" + "(type: string) => ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.set.$1", + "id": "def-server.SavedObjectsErrorHelpers.createUnsupportedTypeError.$1", "type": "string", "tags": [], - "label": "key", + "label": "type", "description": [], "signature": [ "string" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.set.$2", - "type": "Any", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true } @@ -280,28 +189,31 @@ }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.has", + "id": "def-server.SavedObjectsErrorHelpers.isBadRequestError", "type": "Function", "tags": [], - "label": "has", + "label": "isBadRequestError", "description": [], "signature": [ - "(key: string) => boolean" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.has.$1", - "type": "string", + "id": "def-server.SavedObjectsErrorHelpers.isBadRequestError.$1", + "type": "CompoundType", "tags": [], - "label": "key", + "label": "error", "description": [], "signature": [ - "string" + "Error | ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true } @@ -310,505 +222,263 @@ }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.save", + "id": "def-server.SavedObjectsErrorHelpers.createInvalidVersionError", "type": "Function", "tags": [], - "label": "save", + "label": "createInvalidVersionError", "description": [], "signature": [ - "() => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">" + "(versionInput?: string | undefined) => ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.createInvalidVersionError.$1", + "type": "string", + "tags": [], + "label": "versionInput", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": false + } + ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SimpleSavedObject.delete", + "id": "def-server.SavedObjectsErrorHelpers.isInvalidVersionError", "type": "Function", "tags": [], - "label": "delete", + "label": "isInvalidVersionError", "description": [], "signature": [ - "() => Promise<{}>" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], - "path": "src/core/public/saved_objects/simple_saved_object.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - } - ], - "functions": [], - "interfaces": [ - { - "parentPluginId": "core", - "id": "def-public.ResolvedSimpleSavedObject", - "type": "Interface", - "tags": [], - "label": "ResolvedSimpleSavedObject", - "description": [ - "\nThis interface is a very simple wrapper for SavedObjects resolved from the server\nwith the {@link SavedObjectsClientContract}.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.ResolvedSimpleSavedObject", - "text": "ResolvedSimpleSavedObject" - }, - "" - ], - "path": "src/core/public/saved_objects/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.ResolvedSimpleSavedObject.saved_object", - "type": "Object", - "tags": [], - "label": "saved_object", - "description": [ - "\nThe saved object that was found." - ], - "signature": [ + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - "" + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.isInvalidVersionError.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error | ", + "DecoratedError" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "src/core/public/saved_objects/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.ResolvedSimpleSavedObject.outcome", - "type": "CompoundType", + "id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError", + "type": "Function", "tags": [], - "label": "outcome", - "description": [ - "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." - ], + "label": "decorateNotAuthorizedError", + "description": [], "signature": [ - "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" - ], - "path": "src/core/public/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.ResolvedSimpleSavedObject.alias_target_id", - "type": "string", - "tags": [], - "label": "alias_target_id", - "description": [ - "\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], - "signature": [ - "string | undefined" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError.$1", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError.$2", + "type": "string", + "tags": [], + "label": "reason", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/public/saved_objects/types.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.ResolvedSimpleSavedObject.alias_purpose", - "type": "CompoundType", + "id": "def-server.SavedObjectsErrorHelpers.isNotAuthorizedError", + "type": "Function", "tags": [], - "label": "alias_purpose", - "description": [ - "\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." - ], + "label": "isNotAuthorizedError", + "description": [], "signature": [ - "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], - "path": "src/core/public/saved_objects/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBatchResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBatchResponse", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.isNotAuthorizedError.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error | ", + "DecoratedError" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - "" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsBatchResponse.savedObjects", - "type": "Array", + "id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError", + "type": "Function", "tags": [], - "label": "savedObjects", + "label": "decorateForbiddenError", "description": [], "signature": [ + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError.$1", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": true }, - "[]" + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError.$2", + "type": "string", + "tags": [], + "label": "reason", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkCreateObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkCreateObject", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" + "returnComment": [] }, - " extends ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - } - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkCreateObject.type", - "type": "string", + "id": "def-server.SavedObjectsErrorHelpers.isForbiddenError", + "type": "Function", "tags": [], - "label": "type", + "label": "isForbiddenError", "description": [], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false + "signature": [ + "(error: Error | ", + "DecoratedError", + ") => boolean" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.isForbiddenError.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error | ", + "DecoratedError" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkCreateObject.attributes", - "type": "Uncategorized", + "id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError", + "type": "Function", "tags": [], - "label": "attributes", + "label": "decorateRequestEntityTooLargeError", "description": [], "signature": [ - "T" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkCreateOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkCreateOptions", - "description": [], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkCreateOptions.overwrite", - "type": "CompoundType", - "tags": [], - "label": "overwrite", - "description": [ - "If a document with the given `id` already exists, overwrite it's contents (default=false)." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkResolveResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkResolveResponse", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - "" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkResolveResponse.resolved_objects", - "type": "Array", - "tags": [], - "label": "resolved_objects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.ResolvedSimpleSavedObject", - "text": "ResolvedSimpleSavedObject" - }, - "[]" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkUpdateObject", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateObject.attributes", - "type": "Uncategorized", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "T" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateObject.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateObject.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [], - "signature": [ - "SavedObjectReference", - "[] | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkUpdateOptions", - "description": [], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsBulkUpdateOptions.namespace", - "type": "string", - "tags": [], - "label": "namespace", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract", - "type": "Interface", - "tags": [], - "label": "SavedObjectsClientContract", - "description": [ - "\nThe client-side SavedObjectsClient is a thin convenience library around the SavedObjects\nHTTP API for interacting with Saved Objects.\n" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.create", - "type": "Function", - "tags": [], - "label": "create", - "description": [ - "\nPersists an object" - ], - "signature": [ - "(type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.create.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.create.$2", - "type": "Uncategorized", + "id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError.$1", + "type": "Object", "tags": [], - "label": "attributes", + "label": "error", "description": [], "signature": [ - "T" + "Error" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.create.$3", - "type": "Object", + "id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError.$2", + "type": "string", "tags": [], - "label": "options", + "label": "reason", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined" + "string | undefined" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": false } @@ -817,147 +487,76 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.bulkCreate", + "id": "def-server.SavedObjectsErrorHelpers.isRequestEntityTooLargeError", "type": "Function", "tags": [], - "label": "bulkCreate", - "description": [ - "\nCreates multiple documents at once" - ], + "label": "isRequestEntityTooLargeError", + "description": [], "signature": [ - "(objects: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateOptions", - "text": "SavedObjectsBulkCreateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.bulkCreate.$1", - "type": "Array", + "id": "def-server.SavedObjectsErrorHelpers.isRequestEntityTooLargeError.$1", + "type": "CompoundType", "tags": [], - "label": "objects", + "label": "error", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[]" + "Error | ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.bulkCreate.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkCreateOptions", - "text": "SavedObjectsBulkCreateOptions" - }, - " | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": false } ], - "returnComment": [ - "The result of the create operation containing created saved objects." - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.delete", + "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError", "type": "Function", "tags": [], - "label": "delete", - "description": [ - "\nDeletes an object" - ], + "label": "createGenericNotFoundError", + "description": [], "signature": [ - "(type: string, id: string, options?: ", - "SavedObjectsDeleteOptions", - " | undefined) => Promise<{}>" + "(type?: string | null, id?: string | null) => ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.delete.$1", - "type": "string", + "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError.$1", + "type": "CompoundType", "tags": [], "label": "type", "description": [], "signature": [ - "string" + "string | null" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.delete.$2", - "type": "string", + "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError.$2", + "type": "CompoundType", "tags": [], "label": "id", "description": [], "signature": [ - "string" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.delete.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - "SavedObjectsDeleteOptions", - " | undefined" + "string | null" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": false } @@ -966,295 +565,175 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.find", + "id": "def-server.SavedObjectsErrorHelpers.createIndexAliasNotFoundError", "type": "Function", - "tags": [ - "property", - "property", - "property", - "property", - "property", - "property", - "property" - ], - "label": "find", - "description": [ - "\nSearch for objects\n" - ], + "tags": [], + "label": "createIndexAliasNotFoundError", + "description": [], "signature": [ - "(options: SavedObjectsFindOptions) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsFindResponsePublic", - "text": "SavedObjectsFindResponsePublic" - }, - ">" + "(alias: string) => ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.find.$1", - "type": "Object", + "id": "def-server.SavedObjectsErrorHelpers.createIndexAliasNotFoundError.$1", + "type": "string", "tags": [], - "label": "options", + "label": "alias", "description": [], "signature": [ - "SavedObjectsFindOptions" + "string" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "A find result with objects matching the specified search." - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.get", + "id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError", "type": "Function", "tags": [], - "label": "get", - "description": [ - "\nFetches a single object\n" - ], + "label": "decorateIndexAliasNotFoundError", + "description": [], "signature": [ - "(type: string, id: string) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">" + "(error: Error, alias: string) => ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.get.$1", - "type": "string", + "id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError.$1", + "type": "Object", "tags": [], - "label": "type", + "label": "error", "description": [], "signature": [ - "string" + "Error" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.get.$2", + "id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError.$2", "type": "string", "tags": [], - "label": "id", + "label": "alias", "description": [], "signature": [ "string" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "The saved object for the given type and id." - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.bulkGet", + "id": "def-server.SavedObjectsErrorHelpers.isNotFoundError", "type": "Function", "tags": [], - "label": "bulkGet", - "description": [ - "\nReturns an array of objects by id\n" - ], + "label": "isNotFoundError", + "description": [], "signature": [ - "(objects: { id: string; type: string; }[]) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.bulkGet.$1", - "type": "Array", + "id": "def-server.SavedObjectsErrorHelpers.isNotFoundError.$1", + "type": "CompoundType", "tags": [], - "label": "objects", - "description": [ - "- an array ids, or an array of objects containing id and optionally type" - ], + "label": "error", + "description": [], "signature": [ - "{ id: string; type: string; }[]" + "Error | ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "The saved objects with the given type and ids requested" - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.resolve", + "id": "def-server.SavedObjectsErrorHelpers.decorateConflictError", "type": "Function", - "tags": [ - "note" - ], - "label": "resolve", - "description": [ - "\nResolves a single object\n" - ], + "tags": [], + "label": "decorateConflictError", + "description": [], "signature": [ - "(type: string, id: string) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.ResolvedSimpleSavedObject", - "text": "ResolvedSimpleSavedObject" - }, - ">" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.resolve.$1", - "type": "string", + "id": "def-server.SavedObjectsErrorHelpers.decorateConflictError.$1", + "type": "Object", "tags": [], - "label": "type", + "label": "error", "description": [], "signature": [ - "string" + "Error" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.resolve.$2", + "id": "def-server.SavedObjectsErrorHelpers.decorateConflictError.$2", "type": "string", "tags": [], - "label": "id", + "label": "reason", "description": [], "signature": [ - "string" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "The resolve result for the saved object for the given type and id." - ] - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.bulkResolve", - "type": "Function", - "tags": [ - "note" - ], - "label": "bulkResolve", - "description": [ - "\nResolves an array of objects by id, using any legacy URL aliases if they exist\n" - ], - "signature": [ - "(objects: { id: string; type: string; }[]) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - ">" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.bulkResolve.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [ - "- an array of objects containing id, type" - ], - "signature": [ - "{ id: string; type: string; }[]" + "string | undefined" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], - "returnComment": [ - "The bulk resolve result for the saved objects for the given types and ids." - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.update", + "id": "def-server.SavedObjectsErrorHelpers.createConflictError", "type": "Function", - "tags": [ - "prop", - "prop" - ], - "label": "update", - "description": [ - "\nUpdates an object\n" - ], + "tags": [], + "label": "createConflictError", + "description": [], "signature": [ - "(type: string, id: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - " | undefined) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, - ">" + "(type: string, id: string, reason?: string | undefined) => ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.update.$1", + "id": "def-server.SavedObjectsErrorHelpers.createConflictError.$1", "type": "string", "tags": [], "label": "type", @@ -1262,13 +741,13 @@ "signature": [ "string" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.update.$2", + "id": "def-server.SavedObjectsErrorHelpers.createConflictError.$2", "type": "string", "tags": [], "label": "id", @@ -1276,42 +755,21 @@ "signature": [ "string" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.update.$3", - "type": "Uncategorized", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "T" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.update.$4", - "type": "Object", + "id": "def-server.SavedObjectsErrorHelpers.createConflictError.$3", + "type": "string", "tags": [], - "label": "options", + "label": "reason", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - " | undefined" + "string | undefined" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": false } @@ -1320,541 +778,355 @@ }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.bulkUpdate", + "id": "def-server.SavedObjectsErrorHelpers.isConflictError", "type": "Function", "tags": [], - "label": "bulkUpdate", - "description": [ - "\nUpdate multiple documents at once\n" - ], + "label": "isConflictError", + "description": [], "signature": [ - "(objects: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[]) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" - }, - ">" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsClientContract.bulkUpdate.$1", - "type": "Array", + "id": "def-server.SavedObjectsErrorHelpers.isConflictError.$1", + "type": "CompoundType", "tags": [], - "label": "objects", - "description": [ - "- [{ type, id, attributes, options: { version, references } }]" - ], + "label": "error", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[]" + "Error | ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "The result of the update operation containing both failed and updated saved objects." - ] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsCreateOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCreateOptions", - "description": [], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsCreateOptions.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "\n(Not recommended) Specify an id instead of having the saved objects service generate one for you." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsCreateOptions.overwrite", - "type": "CompoundType", + "id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError", + "type": "Function", "tags": [], - "label": "overwrite", - "description": [ - "If a document with the given `id` already exists, overwrite it's contents (default=false)." - ], + "label": "decorateTooManyRequestsError", + "description": [], "signature": [ - "boolean | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsCreateOptions.migrationVersion", - "type": "Object", - "tags": [], - "label": "migrationVersion", - "description": [ - "{@inheritDoc SavedObjectsMigrationVersion}" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError.$1", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError.$2", + "type": "string", + "tags": [], + "label": "reason", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": false + } ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsCreateOptions.coreMigrationVersion", - "type": "string", + "id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError", + "type": "Function", "tags": [], - "label": "coreMigrationVersion", - "description": [ - "A semver value that is used when upgrading objects between Kibana versions." - ], + "label": "createTooManyRequestsError", + "description": [], "signature": [ - "string | undefined" + "(type: string, id: string) => ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsCreateOptions.references", - "type": "Array", + "id": "def-server.SavedObjectsErrorHelpers.isTooManyRequestsError", + "type": "Function", "tags": [], - "label": "references", + "label": "isTooManyRequestsError", "description": [], "signature": [ - "SavedObjectReference", - "[] | undefined" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindResponsePublic", - "type": "Interface", - "tags": [], - "label": "SavedObjectsFindResponsePublic", - "description": [ - "\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsFindResponsePublic", - "text": "SavedObjectsFindResponsePublic" - }, - " extends ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsBatchResponse", - "text": "SavedObjectsBatchResponse" + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.isTooManyRequestsError.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error | ", + "DecoratedError" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, - "" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindResponsePublic.aggregations", - "type": "Uncategorized", + "id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError", + "type": "Function", "tags": [], - "label": "aggregations", + "label": "decorateEsCannotExecuteScriptError", "description": [], "signature": [ - "A | undefined" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError.$1", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError.$2", + "type": "string", + "tags": [], + "label": "reason", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindResponsePublic.total", - "type": "number", + "id": "def-server.SavedObjectsErrorHelpers.isEsCannotExecuteScriptError", + "type": "Function", "tags": [], - "label": "total", + "label": "isEsCannotExecuteScriptError", "description": [], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false + "signature": [ + "(error: Error | ", + "DecoratedError", + ") => boolean" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.isEsCannotExecuteScriptError.$1", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "Error | ", + "DecoratedError" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-public.SavedObjectsFindResponsePublic.perPage", - "type": "number", + "id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError", + "type": "Function", "tags": [], - "label": "perPage", + "label": "decorateEsUnavailableError", "description": [], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsFindResponsePublic.page", - "type": "number", - "tags": [], - "label": "page", - "description": [], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsStart", - "type": "Interface", - "tags": [], - "label": "SavedObjectsStart", - "description": [], - "path": "src/core/public/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsStart.client", - "type": "Object", - "tags": [], - "label": "client", - "description": [ - "{@link SavedObjectsClientContract}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } - ], - "path": "src/core/public/saved_objects/saved_objects_service.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsUpdateOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsUpdateOptions", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - "" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsUpdateOptions.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsUpdateOptions.upsert", - "type": "Uncategorized", - "tags": [], - "label": "upsert", - "description": [], - "signature": [ - "Attributes | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-public.SavedObjectsUpdateOptions.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [], - "signature": [ - "SavedObjectReference", - "[] | undefined" - ], - "path": "src/core/public/saved_objects/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], - "enums": [], - "misc": [], - "objects": [] - }, - "server": { - "classes": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClient", - "type": "Class", - "tags": [], - "label": "SavedObjectsClient", - "description": [ - "\n" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.errors", - "type": "Object", - "tags": [], - "label": "errors", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - } - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.errors", - "type": "Object", - "tags": [], - "label": "errors", - "description": [], - "signature": [ - "typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - } - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.create", - "type": "Function", - "tags": [], - "label": "create", - "description": [ - "\nPersists a SavedObject\n" - ], "signature": [ - "(type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.create.$1", - "type": "string", + "id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError.$1", + "type": "Object", "tags": [], - "label": "type", + "label": "error", "description": [], "signature": [ - "string" + "Error" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.create.$2", - "type": "Uncategorized", + "id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError.$2", + "type": "string", "tags": [], - "label": "attributes", + "label": "reason", "description": [], "signature": [ - "T" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, - "isRequired": true - }, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.isEsUnavailableError", + "type": "Function", + "tags": [], + "label": "isEsUnavailableError", + "description": [], + "signature": [ + "(error: Error | ", + "DecoratedError", + ") => boolean" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.create.$3", - "type": "Object", + "id": "def-server.SavedObjectsErrorHelpers.isEsUnavailableError.$1", + "type": "CompoundType", "tags": [], - "label": "options", + "label": "error", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined" + "Error | ", + "DecoratedError" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.bulkCreate", + "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError", "type": "Function", "tags": [], - "label": "bulkCreate", - "description": [ - "\nPersists multiple documents batched together as a single request\n" - ], + "label": "decorateGeneralError", + "description": [], "signature": [ - "(objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">" + "(error: Error, reason?: string | undefined) => ", + "DecoratedError" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.bulkCreate.$1", - "type": "Array", + "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError.$1", + "type": "Object", "tags": [], - "label": "objects", + "label": "error", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[]" + "Error" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.bulkCreate.$2", - "type": "Object", + "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError.$2", + "type": "string", "tags": [], - "label": "options", + "label": "reason", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": false } @@ -1863,113 +1135,121 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.checkConflicts", + "id": "def-server.SavedObjectsErrorHelpers.isGeneralError", "type": "Function", "tags": [], - "label": "checkConflicts", - "description": [ - "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten.\n" - ], + "label": "isGeneralError", + "description": [], "signature": [ - "(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" - }, - ">" + "(error: Error | ", + "DecoratedError", + ") => boolean" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.checkConflicts.$1", - "type": "Array", + "id": "def-server.SavedObjectsErrorHelpers.isGeneralError.$1", + "type": "CompoundType", "tags": [], - "label": "objects", + "label": "error", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[]" + "Error | ", + "DecoratedError" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError", + "type": "Function", + "tags": [], + "label": "createGenericNotFoundEsUnavailableError", + "description": [], + "signature": [ + "(type?: string | null, id?: string | null) => ", + "DecoratedError" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError.$1", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | null" + ], + "path": "src/core/server/saved_objects/service/lib/errors.ts", + "deprecated": false, + "isRequired": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.checkConflicts.$2", - "type": "Object", + "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError.$2", + "type": "CompoundType", "tags": [], - "label": "options", + "label": "id", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } + "string | null" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/errors.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportError", + "type": "Class", + "tags": [], + "label": "SavedObjectsExportError", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" }, + " extends Error" + ], + "path": "src/core/server/saved_objects/export/errors.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.delete", + "id": "def-server.SavedObjectsExportError.Unnamed", "type": "Function", "tags": [], - "label": "delete", - "description": [ - "\nDeletes a SavedObject\n" - ], + "label": "Constructor", + "description": [], "signature": [ - "(type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - ") => Promise<{}>" + "any" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.delete.$1", + "id": "def-server.SavedObjectsExportError.Unnamed.$1", "type": "string", "tags": [], "label": "type", @@ -1977,95 +1257,72 @@ "signature": [ "string" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.delete.$2", + "id": "def-server.SavedObjectsExportError.Unnamed.$2", "type": "string", "tags": [], - "label": "id", + "label": "message", "description": [], "signature": [ "string" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.delete.$3", + "id": "def-server.SavedObjectsExportError.Unnamed.$3", "type": "Object", "tags": [], - "label": "options", + "label": "attributes", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - } + "Record | undefined" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.find", + "id": "def-server.SavedObjectsExportError.exportSizeExceeded", "type": "Function", "tags": [], - "label": "find", - "description": [ - "\nFind all SavedObjects matching the search query\n" - ], + "label": "exportSizeExceeded", + "description": [], "signature": [ - "(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - }, - ") => Promise<", + "(limit: number) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ">" + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + } ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.find.$1", - "type": "Object", + "id": "def-server.SavedObjectsExportError.exportSizeExceeded.$1", + "type": "number", "tags": [], - "label": "options", + "label": "limit", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - } + "number" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "isRequired": true } @@ -2074,83 +1331,38 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.bulkGet", + "id": "def-server.SavedObjectsExportError.objectFetchError", "type": "Function", "tags": [], - "label": "bulkGet", - "description": [ - "\nReturns an array of objects by id\n" - ], + "label": "objectFetchError", + "description": [], "signature": [ - "(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<", + "(objects: ", + "SavedObject", + "[]) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">" + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + } ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.bulkGet.$1", + "id": "def-server.SavedObjectsExportError.objectFetchError.$1", "type": "Array", "tags": [], "label": "objects", - "description": [ - "- an array of ids, or an array of objects containing id, type and optionally fields" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.bulkGet.$2", - "type": "Object", - "tags": [], - "label": "options", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } + "SavedObject", + "[]" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "isRequired": true } @@ -2159,78 +1371,54 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.get", + "id": "def-server.SavedObjectsExportError.objectTransformError", "type": "Function", "tags": [], - "label": "get", + "label": "objectTransformError", "description": [ - "\nRetrieves a single object\n" + "\nError returned when a {@link SavedObjectsExportTransform | export transform} threw an error" ], "signature": [ - "(type: string, id: string, options?: ", + "(objects: ", + "SavedObject", + "[], cause: Error) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">" + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + } ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.get.$1", - "type": "string", + "id": "def-server.SavedObjectsExportError.objectTransformError.$1", + "type": "Array", "tags": [], - "label": "type", - "description": [ - "- The type of SavedObject to retrieve" - ], + "label": "objects", + "description": [], "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.get.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "- The ID of the SavedObject to retrieve" - ], - "signature": [ - "string" + "SavedObject", + "[]" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.get.$3", + "id": "def-server.SavedObjectsExportError.objectTransformError.$2", "type": "Object", "tags": [], - "label": "options", + "label": "cause", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } + "Error" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "isRequired": true } @@ -2239,172 +1427,97 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.bulkResolve", + "id": "def-server.SavedObjectsExportError.invalidTransformError", "type": "Function", - "tags": [ - "note" - ], - "label": "bulkResolve", + "tags": [], + "label": "invalidTransformError", "description": [ - "\nResolves an array of objects by id, using any legacy URL aliases if they exist\n" + "\nError returned when a {@link SavedObjectsExportTransform | export transform} performed an invalid operation\nduring the transform, such as removing objects from the export, or changing an object's type or id." ], "signature": [ - "(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<", + "(objectKeys: string[]) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - ">" + "section": "def-server.SavedObjectsExportError", + "text": "SavedObjectsExportError" + } ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.bulkResolve.$1", + "id": "def-server.SavedObjectsExportError.invalidTransformError.$1", "type": "Array", "tags": [], - "label": "objects", - "description": [ - "- an array of objects containing id, type" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveObject", - "text": "SavedObjectsBulkResolveObject" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.bulkResolve.$2", - "type": "Object", - "tags": [], - "label": "options", + "label": "objectKeys", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined" + "string[]" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/export/errors.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError", + "type": "Class", + "tags": [], + "label": "SavedObjectsImportError", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" }, + " extends Error" + ], + "path": "src/core/server/saved_objects/import/errors.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.resolve", + "id": "def-server.SavedObjectsImportError.importSizeExceeded", "type": "Function", "tags": [], - "label": "resolve", - "description": [ - "\nResolves a single object, using any legacy URL alias if it exists\n" - ], + "label": "importSizeExceeded", + "description": [], "signature": [ - "(type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", + "(limit: number) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - ">" + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + } ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/import/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.resolve.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "- The type of SavedObject to retrieve" - ], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.resolve.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "- The ID of the SavedObject to retrieve" - ], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.resolve.$3", - "type": "Object", + "id": "def-server.SavedObjectsImportError.importSizeExceeded.$1", + "type": "number", "tags": [], - "label": "options", + "label": "limit", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } + "number" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/import/errors.ts", "deprecated": false, "isRequired": true } @@ -2413,95 +1526,72 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.update", + "id": "def-server.SavedObjectsImportError.nonUniqueImportObjects", "type": "Function", "tags": [], - "label": "update", - "description": [ - "\nUpdates an SavedObject\n" - ], + "label": "nonUniqueImportObjects", + "description": [], "signature": [ - "(type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", + "(nonUniqueEntries: string[]) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">" + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + } ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/import/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.update.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.update.$2", - "type": "string", + "id": "def-server.SavedObjectsImportError.nonUniqueImportObjects.$1", + "type": "Array", "tags": [], - "label": "id", + "label": "nonUniqueEntries", "description": [], "signature": [ - "string" + "string[]" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/import/errors.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects", + "type": "Function", + "tags": [], + "label": "nonUniqueRetryObjects", + "description": [], + "signature": [ + "(nonUniqueRetryObjects: string[]) => ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.update.$3", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "Partial" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + } + ], + "path": "src/core/server/saved_objects/import/errors.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.update.$4", - "type": "Object", + "id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects.$1", + "type": "Array", "tags": [], - "label": "options", + "label": "nonUniqueRetryObjects", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - "" + "string[]" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/import/errors.ts", "deprecated": false, "isRequired": true } @@ -2510,122 +1600,127 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.bulkUpdate", + "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations", "type": "Function", "tags": [], - "label": "bulkUpdate", - "description": [ - "\nBulk Updates multiple SavedObject at once\n" - ], + "label": "nonUniqueRetryDestinations", + "description": [], "signature": [ - "(objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " | undefined) => Promise<", + "(nonUniqueRetryDestinations: string[]) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">" + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + } ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/import/errors.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.bulkUpdate.$1", + "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations.$1", "type": "Array", "tags": [], - "label": "objects", + "label": "nonUniqueRetryDestinations", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[]" + "string[]" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/import/errors.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportError.referencesFetchError", + "type": "Function", + "tags": [], + "label": "referencesFetchError", + "description": [], + "signature": [ + "(objects: ", + "SavedObject", + "[]) => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsImportError", + "text": "SavedObjectsImportError" + } + ], + "path": "src/core/server/saved_objects/import/errors.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.bulkUpdate.$2", - "type": "Object", + "id": "def-server.SavedObjectsImportError.referencesFetchError.$1", + "type": "Array", "tags": [], - "label": "options", + "label": "objects", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " | undefined" + "SavedObject", + "[]" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/import/errors.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository", + "type": "Class", + "tags": [], + "label": "SavedObjectsRepository", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRepository", + "text": "SavedObjectsRepository" }, + " implements ", + "ISavedObjectsRepository" + ], + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.removeReferencesTo", + "id": "def-server.SavedObjectsRepository.create", "type": "Function", "tags": [], - "label": "removeReferencesTo", + "label": "create", "description": [ - "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference." + "\n{@inheritDoc ISavedObjectsRepository.create}" ], "signature": [ - "(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" - }, - ">" + "(type: string, attributes: T, options?: ", + "SavedObjectsCreateOptions", + ") => Promise<", + "SavedObject", + ">" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.removeReferencesTo.$1", + "id": "def-server.SavedObjectsRepository.create.$1", "type": "string", "tags": [], "label": "type", @@ -2633,110 +1728,88 @@ "signature": [ "string" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.removeReferencesTo.$2", - "type": "string", + "id": "def-server.SavedObjectsRepository.create.$2", + "type": "Uncategorized", "tags": [], - "label": "id", + "label": "attributes", "description": [], "signature": [ - "string" + "T" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.removeReferencesTo.$3", + "id": "def-server.SavedObjectsRepository.create.$3", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " | undefined" + "SavedObjectsCreateOptions" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.openPointInTimeForType", + "id": "def-server.SavedObjectsRepository.bulkCreate", "type": "Function", "tags": [], - "label": "openPointInTimeForType", + "label": "bulkCreate", "description": [ - "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to {@link SavedObjectsClient.find} to search\nagainst that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method." + "\n{@inheritDoc ISavedObjectsRepository.bulkCreate}" ], "signature": [ - "(type: string | string[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - }, + "(objects: ", + "SavedObjectsBulkCreateObject", + "[], options?: ", + "SavedObjectsCreateOptions", ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" - }, - ">" + "SavedObjectsBulkResponse", + ">" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.openPointInTimeForType.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsRepository.bulkCreate.$1", + "type": "Array", "tags": [], - "label": "type", + "label": "objects", "description": [], "signature": [ - "string | string[]" + "SavedObjectsBulkCreateObject", + "[]" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.openPointInTimeForType.$2", + "id": "def-server.SavedObjectsRepository.bulkCreate.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - } + "SavedObjectsCreateOptions" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true } @@ -2745,390 +1818,303 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.closePointInTime", + "id": "def-server.SavedObjectsRepository.checkConflicts", "type": "Function", "tags": [], - "label": "closePointInTime", + "label": "checkConflicts", "description": [ - "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES via the\nElasticsearch client, and is included in the Saved Objects Client as a convenience\nfor consumers who are using {@link SavedObjectsClient.openPointInTimeForType}.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method." + "\n{@inheritDoc ISavedObjectsRepository.checkConflicts}" ], "signature": [ - "(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" - }, + "(objects?: ", + "SavedObjectsCheckConflictsObject", + "[], options?: ", + "SavedObjectsBaseOptions", + ") => Promise<", + "SavedObjectsCheckConflictsResponse", ">" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.closePointInTime.$1", - "type": "string", + "id": "def-server.SavedObjectsRepository.checkConflicts.$1", + "type": "Array", "tags": [], - "label": "id", + "label": "objects", "description": [], "signature": [ - "string" + "SavedObjectsCheckConflictsObject", + "[]" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.closePointInTime.$2", + "id": "def-server.SavedObjectsRepository.checkConflicts.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined" + "SavedObjectsBaseOptions" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.createPointInTimeFinder", + "id": "def-server.SavedObjectsRepository.delete", "type": "Function", "tags": [], - "label": "createPointInTimeFinder", + "label": "delete", "description": [ - "\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThe generator wraps calls to {@link SavedObjectsClient.find} and iterates\nover multiple pages of results using `_pit` and `search_after`. This will\nopen a new Point-In-Time (PIT), and continue paging until a set of\nresults is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n" + "\n{@inheritDoc ISavedObjectsRepository.delete}" ], "signature": [ - "(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" - }, - "" + "(type: string, id: string, options?: ", + "SavedObjectsDeleteOptions", + ") => Promise<{}>" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.createPointInTimeFinder.$1", - "type": "Object", + "id": "def-server.SavedObjectsRepository.delete.$1", + "type": "string", "tags": [], - "label": "findOptions", + "label": "type", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "text": "SavedObjectsCreatePointInTimeFinderOptions" - } + "string" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.createPointInTimeFinder.$2", - "type": "Object", + "id": "def-server.SavedObjectsRepository.delete.$2", + "type": "string", "tags": [], - "label": "dependencies", + "label": "id", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" - }, - " | undefined" + "string" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, - "isRequired": false + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.delete.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsDeleteOptions" + ], + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "deprecated": false, + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.collectMultiNamespaceReferences", + "id": "def-server.SavedObjectsRepository.deleteByNamespace", "type": "Function", "tags": [], - "label": "collectMultiNamespaceReferences", + "label": "deleteByNamespace", "description": [ - "\nGets all references and transitive references of the listed objects. Ignores any object that is not a multi-namespace type.\n" + "\n{@inheritDoc ISavedObjectsRepository.deleteByNamespace}" ], "signature": [ - "(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" - }, - ">" + "(namespace: string, options?: ", + "SavedObjectsDeleteByNamespaceOptions", + ") => Promise" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.collectMultiNamespaceReferences.$1", - "type": "Array", + "id": "def-server.SavedObjectsRepository.deleteByNamespace.$1", + "type": "string", "tags": [], - "label": "objects", + "label": "namespace", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[]" + "string" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.collectMultiNamespaceReferences.$2", + "id": "def-server.SavedObjectsRepository.deleteByNamespace.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined" + "SavedObjectsDeleteByNamespaceOptions" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.updateObjectsSpaces", + "id": "def-server.SavedObjectsRepository.find", "type": "Function", "tags": [], - "label": "updateObjectsSpaces", + "label": "find", "description": [ - "\nUpdates one or more objects to add and/or remove them from specified spaces.\n" + "\n{@inheritDoc ISavedObjectsRepository.find}" ], "signature": [ - "(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" - }, - ">" + "(options: ", + "SavedObjectsFindOptions", + ") => Promise<", + "SavedObjectsFindResponse", + ">" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.updateObjectsSpaces.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.updateObjectsSpaces.$2", - "type": "Array", + "id": "def-server.SavedObjectsRepository.find.$1", + "type": "Object", "tags": [], - "label": "spacesToAdd", + "label": "options", "description": [], "signature": [ - "string[]" + "SavedObjectsFindOptions" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.bulkGet", + "type": "Function", + "tags": [], + "label": "bulkGet", + "description": [ + "\n{@inheritDoc ISavedObjectsRepository.bulkGet}" + ], + "signature": [ + "(objects?: ", + "SavedObjectsBulkGetObject", + "[], options?: ", + "SavedObjectsBaseOptions", + ") => Promise<", + "SavedObjectsBulkResponse", + ">" + ], + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.updateObjectsSpaces.$3", + "id": "def-server.SavedObjectsRepository.bulkGet.$1", "type": "Array", "tags": [], - "label": "spacesToRemove", + "label": "objects", "description": [], "signature": [ - "string[]" + "SavedObjectsBulkGetObject", + "[]" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsClient.updateObjectsSpaces.$4", + "id": "def-server.SavedObjectsRepository.bulkGet.$2", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined" + "SavedObjectsBaseOptions" ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers", - "type": "Class", - "tags": [], - "label": "SavedObjectsErrorHelpers", - "description": [], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isSavedObjectsClientError", + "id": "def-server.SavedObjectsRepository.bulkResolve", "type": "Function", "tags": [], - "label": "isSavedObjectsClientError", - "description": [], + "label": "bulkResolve", + "description": [ + "\n{@inheritDoc ISavedObjectsRepository.bulkResolve}" + ], "signature": [ - "(error: any) => error is ", - "DecoratedError" + "(objects: ", + "SavedObjectsBulkResolveObject", + "[], options?: ", + "SavedObjectsBaseOptions", + ") => Promise<", + "SavedObjectsBulkResolveResponse", + ">" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isSavedObjectsClientError.$1", - "type": "Any", + "id": "def-server.SavedObjectsRepository.bulkResolve.$1", + "type": "Array", "tags": [], - "label": "error", + "label": "objects", "description": [], "signature": [ - "any" + "SavedObjectsBulkResolveObject", + "[]" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.bulkResolve.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBaseOptions" + ], + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true } @@ -3137,138 +2123,126 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError", + "id": "def-server.SavedObjectsRepository.get", "type": "Function", "tags": [], - "label": "decorateBadRequestError", - "description": [], + "label": "get", + "description": [ + "\n{@inheritDoc ISavedObjectsRepository.get}" + ], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "(type: string, id: string, options?: ", + "SavedObjectsBaseOptions", + ") => Promise<", + "SavedObject", + ">" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError.$1", - "type": "Object", + "id": "def-server.SavedObjectsRepository.get.$1", + "type": "string", "tags": [], - "label": "error", + "label": "type", "description": [], "signature": [ - "Error" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateBadRequestError.$2", + "id": "def-server.SavedObjectsRepository.get.$2", "type": "string", "tags": [], - "label": "reason", + "label": "id", "description": [], "signature": [ - "string | undefined" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, - "isRequired": false + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.get.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsBaseOptions" + ], + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "deprecated": false, + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createBadRequestError", + "id": "def-server.SavedObjectsRepository.resolve", "type": "Function", "tags": [], - "label": "createBadRequestError", - "description": [], + "label": "resolve", + "description": [ + "\n{@inheritDoc ISavedObjectsRepository.resolve}" + ], "signature": [ - "(reason?: string | undefined) => ", - "DecoratedError" + "(type: string, id: string, options?: ", + "SavedObjectsBaseOptions", + ") => Promise<", + "SavedObjectsResolveResponse", + ">" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createBadRequestError.$1", + "id": "def-server.SavedObjectsRepository.resolve.$1", "type": "string", "tags": [], - "label": "reason", + "label": "type", "description": [], "signature": [ - "string | undefined" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createUnsupportedTypeError", - "type": "Function", - "tags": [], - "label": "createUnsupportedTypeError", - "description": [], - "signature": [ - "(type: string) => ", - "DecoratedError" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "children": [ + "isRequired": true + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createUnsupportedTypeError.$1", + "id": "def-server.SavedObjectsRepository.resolve.$2", "type": "string", "tags": [], - "label": "type", + "label": "id", "description": [], "signature": [ "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isBadRequestError", - "type": "Function", - "tags": [], - "label": "isBadRequestError", - "description": [], - "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isBadRequestError.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsRepository.resolve.$3", + "type": "Object", "tags": [], - "label": "error", + "label": "options", "description": [], "signature": [ - "Error | ", - "DecoratedError" + "SavedObjectsBaseOptions" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true } @@ -3277,450 +2251,463 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createInvalidVersionError", + "id": "def-server.SavedObjectsRepository.update", "type": "Function", "tags": [], - "label": "createInvalidVersionError", - "description": [], + "label": "update", + "description": [ + "\n{@inheritDoc ISavedObjectsRepository.update}" + ], "signature": [ - "(versionInput?: string | undefined) => ", - "DecoratedError" + "(type: string, id: string, attributes: Partial, options?: ", + "SavedObjectsUpdateOptions", + ") => Promise<", + "SavedObjectsUpdateResponse", + ">" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createInvalidVersionError.$1", + "id": "def-server.SavedObjectsRepository.update.$1", "type": "string", "tags": [], - "label": "versionInput", + "label": "type", "description": [], "signature": [ - "string | undefined" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isInvalidVersionError", - "type": "Function", - "tags": [], - "label": "isInvalidVersionError", - "description": [], - "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "children": [ + "isRequired": true + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isInvalidVersionError.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsRepository.update.$2", + "type": "string", "tags": [], - "label": "error", + "label": "id", "description": [], "signature": [ - "Error | ", - "DecoratedError" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError", - "type": "Function", - "tags": [], - "label": "decorateNotAuthorizedError", - "description": [], - "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError.$1", + "id": "def-server.SavedObjectsRepository.update.$3", "type": "Object", "tags": [], - "label": "error", + "label": "attributes", "description": [], "signature": [ - "Error" + "Partial" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError.$2", - "type": "string", + "id": "def-server.SavedObjectsRepository.update.$4", + "type": "Object", "tags": [], - "label": "reason", + "label": "options", "description": [], "signature": [ - "string | undefined" + "SavedObjectsUpdateOptions", + "" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isNotAuthorizedError", + "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences", "type": "Function", "tags": [], - "label": "isNotAuthorizedError", - "description": [], + "label": "collectMultiNamespaceReferences", + "description": [ + "\n{@inheritDoc ISavedObjectsRepository.collectMultiNamespaceReferences}" + ], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "(objects: ", + "SavedObjectsCollectMultiNamespaceReferencesObject", + "[], options?: ", + "SavedObjectsCollectMultiNamespaceReferencesOptions", + " | undefined) => Promise<", + "SavedObjectsCollectMultiNamespaceReferencesResponse", + ">" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isNotAuthorizedError.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$1", + "type": "Array", "tags": [], - "label": "error", + "label": "objects", "description": [], "signature": [ - "Error | ", - "DecoratedError" + "SavedObjectsCollectMultiNamespaceReferencesObject", + "[]" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsCollectMultiNamespaceReferencesOptions", + " | undefined" + ], + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError", + "id": "def-server.SavedObjectsRepository.updateObjectsSpaces", "type": "Function", "tags": [], - "label": "decorateForbiddenError", - "description": [], + "label": "updateObjectsSpaces", + "description": [ + "\n{@inheritDoc ISavedObjectsRepository.updateObjectsSpaces}" + ], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "(objects: ", + "SavedObjectsUpdateObjectsSpacesObject", + "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + "SavedObjectsUpdateObjectsSpacesOptions", + " | undefined) => Promise<", + "SavedObjectsUpdateObjectsSpacesResponse", + ">" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError.$1", - "type": "Object", + "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$1", + "type": "Array", "tags": [], - "label": "error", + "label": "objects", "description": [], "signature": [ - "Error" + "SavedObjectsUpdateObjectsSpacesObject", + "[]" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateForbiddenError.$2", - "type": "string", + "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$2", + "type": "Array", "tags": [], - "label": "reason", + "label": "spacesToAdd", "description": [], "signature": [ - "string | undefined" + "string[]" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isForbiddenError", - "type": "Function", - "tags": [], - "label": "isForbiddenError", - "description": [], - "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "children": [ + "isRequired": true + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isForbiddenError.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$3", + "type": "Array", "tags": [], - "label": "error", + "label": "spacesToRemove", "description": [], "signature": [ - "Error | ", - "DecoratedError" + "string[]" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsUpdateObjectsSpacesOptions", + " | undefined" + ], + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError", + "id": "def-server.SavedObjectsRepository.bulkUpdate", "type": "Function", "tags": [], - "label": "decorateRequestEntityTooLargeError", - "description": [], + "label": "bulkUpdate", + "description": [ + "\n{@inheritDoc ISavedObjectsRepository.bulkUpdate}" + ], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "(objects: ", + "SavedObjectsBulkUpdateObject", + "[], options?: ", + "SavedObjectsBulkUpdateOptions", + ") => Promise<", + "SavedObjectsBulkUpdateResponse", + ">" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError.$1", - "type": "Object", + "id": "def-server.SavedObjectsRepository.bulkUpdate.$1", + "type": "Array", "tags": [], - "label": "error", + "label": "objects", "description": [], "signature": [ - "Error" + "SavedObjectsBulkUpdateObject", + "[]" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError.$2", - "type": "string", + "id": "def-server.SavedObjectsRepository.bulkUpdate.$2", + "type": "Object", "tags": [], - "label": "reason", + "label": "options", "description": [], "signature": [ - "string | undefined" + "SavedObjectsBulkUpdateOptions" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isRequestEntityTooLargeError", + "id": "def-server.SavedObjectsRepository.removeReferencesTo", "type": "Function", "tags": [], - "label": "isRequestEntityTooLargeError", - "description": [], + "label": "removeReferencesTo", + "description": [ + "\n{@inheritDoc ISavedObjectsRepository.removeReferencesTo}" + ], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "(type: string, id: string, options?: ", + "SavedObjectsRemoveReferencesToOptions", + ") => Promise<", + "SavedObjectsRemoveReferencesToResponse", + ">" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isRequestEntityTooLargeError.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsRepository.removeReferencesTo.$1", + "type": "string", "tags": [], - "label": "error", + "label": "type", "description": [], "signature": [ - "Error | ", - "DecoratedError" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError", - "type": "Function", - "tags": [], - "label": "createGenericNotFoundError", - "description": [], - "signature": [ - "(type?: string | null, id?: string | null) => ", - "DecoratedError" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsRepository.removeReferencesTo.$2", + "type": "string", "tags": [], - "label": "type", + "label": "id", "description": [], "signature": [ - "string | null" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, - "isRequired": false + "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundError.$2", - "type": "CompoundType", + "id": "def-server.SavedObjectsRepository.removeReferencesTo.$3", + "type": "Object", "tags": [], - "label": "id", + "label": "options", "description": [], "signature": [ - "string | null" + "SavedObjectsRemoveReferencesToOptions" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createIndexAliasNotFoundError", + "id": "def-server.SavedObjectsRepository.incrementCounter", "type": "Function", "tags": [], - "label": "createIndexAliasNotFoundError", - "description": [], + "label": "incrementCounter", + "description": [ + "\n{@inheritDoc ISavedObjectsRepository.incrementCounter}" + ], "signature": [ - "(alias: string) => ", - "DecoratedError" + "(type: string, id: string, counterFields: (string | ", + "SavedObjectsIncrementCounterField", + ")[], options?: ", + "SavedObjectsIncrementCounterOptions", + " | undefined) => Promise<", + "SavedObject", + ">" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createIndexAliasNotFoundError.$1", + "id": "def-server.SavedObjectsRepository.incrementCounter.$1", "type": "string", "tags": [], - "label": "alias", + "label": "type", "description": [], "signature": [ "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError", - "type": "Function", - "tags": [], - "label": "decorateIndexAliasNotFoundError", - "description": [], - "signature": [ - "(error: Error, alias: string) => ", - "DecoratedError" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError.$1", - "type": "Object", + "id": "def-server.SavedObjectsRepository.incrementCounter.$2", + "type": "string", "tags": [], - "label": "error", + "label": "id", "description": [], "signature": [ - "Error" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError.$2", - "type": "string", + "id": "def-server.SavedObjectsRepository.incrementCounter.$3", + "type": "Array", "tags": [], - "label": "alias", + "label": "counterFields", "description": [], "signature": [ - "string" + "(string | ", + "SavedObjectsIncrementCounterField", + ")[]" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.incrementCounter.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "SavedObjectsIncrementCounterOptions", + " | undefined" + ], + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isNotFoundError", + "id": "def-server.SavedObjectsRepository.openPointInTimeForType", "type": "Function", "tags": [], - "label": "isNotFoundError", - "description": [], + "label": "openPointInTimeForType", + "description": [ + "\n{@inheritDoc ISavedObjectsRepository.openPointInTimeForType}" + ], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "(type: string | string[], { keepAlive, preference }?: ", + "SavedObjectsOpenPointInTimeOptions", + ") => Promise<", + "SavedObjectsOpenPointInTimeResponse", + ">" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isNotFoundError.$1", + "id": "def-server.SavedObjectsRepository.openPointInTimeForType.$1", "type": "CompoundType", "tags": [], - "label": "error", + "label": "type", "description": [], "signature": [ - "Error | ", - "DecoratedError" + "string | string[]" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepository.openPointInTimeForType.$2", + "type": "Object", + "tags": [], + "label": "{ keepAlive = '5m', preference }", + "description": [], + "signature": [ + "SavedObjectsOpenPointInTimeOptions" + ], + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true } @@ -3729,43 +2716,49 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateConflictError", + "id": "def-server.SavedObjectsRepository.closePointInTime", "type": "Function", "tags": [], - "label": "decorateConflictError", - "description": [], + "label": "closePointInTime", + "description": [ + "\n{@inheritDoc ISavedObjectsRepository.closePointInTime}" + ], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "(id: string, options?: ", + "SavedObjectsBaseOptions", + " | undefined) => Promise<", + "SavedObjectsClosePointInTimeResponse", + ">" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateConflictError.$1", - "type": "Object", + "id": "def-server.SavedObjectsRepository.closePointInTime.$1", + "type": "string", "tags": [], - "label": "error", + "label": "id", "description": [], "signature": [ - "Error" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateConflictError.$2", - "type": "string", + "id": "def-server.SavedObjectsRepository.closePointInTime.$2", + "type": "Object", "tags": [], - "label": "reason", + "label": "options", "description": [], "signature": [ - "string | undefined" + "SavedObjectsBaseOptions", + " | undefined" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": false } @@ -3774,90 +2767,144 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createConflictError", + "id": "def-server.SavedObjectsRepository.createPointInTimeFinder", "type": "Function", "tags": [], - "label": "createConflictError", - "description": [], + "label": "createPointInTimeFinder", + "description": [ + "\n{@inheritDoc ISavedObjectsRepository.createPointInTimeFinder}" + ], "signature": [ - "(type: string, id: string, reason?: string | undefined) => ", - "DecoratedError" + "(findOptions: ", + "SavedObjectsCreatePointInTimeFinderOptions", + ", dependencies?: ", + "SavedObjectsCreatePointInTimeFinderDependencies", + " | undefined) => ", + "ISavedObjectsPointInTimeFinder", + "" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createConflictError.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createConflictError.$2", - "type": "string", + "id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$1", + "type": "Object", "tags": [], - "label": "id", + "label": "findOptions", "description": [], "signature": [ - "string" + "SavedObjectsCreatePointInTimeFinderOptions" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createConflictError.$3", - "type": "string", + "id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$2", + "type": "Object", "tags": [], - "label": "reason", + "label": "dependencies", "description": [], "signature": [ - "string | undefined" + "SavedObjectsCreatePointInTimeFinderDependencies", + " | undefined" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/repository.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsSerializer", + "type": "Class", + "tags": [], + "label": "SavedObjectsSerializer", + "description": [ + "\nA serializer that can be used to manually convert {@link SavedObjectsRawDoc | raw} or\n{@link SavedObjectSanitizedDoc | sanitized} documents to the other kind.\n" + ], + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isConflictError", + "id": "def-server.SavedObjectsSerializer.isRawSavedObject", "type": "Function", "tags": [], - "label": "isConflictError", - "description": [], + "label": "isRawSavedObject", + "description": [ + "\nDetermines whether or not the raw document can be converted to a saved object.\n" + ], "signature": [ - "(error: Error | ", - "DecoratedError", + "(doc: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" + }, ") => boolean" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isConflictError.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsSerializer.isRawSavedObject.$1", + "type": "Object", "tags": [], - "label": "error", - "description": [], + "label": "doc", + "description": [ + "- The raw ES document to be tested" + ], "signature": [ - "Error | ", - "DecoratedError" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" + } ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsSerializer.isRawSavedObject.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- Options for parsing the raw document." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" + } + ], + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, "isRequired": true } @@ -3866,88 +2913,140 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError", + "id": "def-server.SavedObjectsSerializer.rawToSavedObject", "type": "Function", "tags": [], - "label": "decorateTooManyRequestsError", - "description": [], + "label": "rawToSavedObject", + "description": [ + "\nConverts a document from the format that is stored in elasticsearch to the saved object client format.\n" + ], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "(doc: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" + }, + ", options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectSanitizedDoc", + "text": "SavedObjectSanitizedDoc" + }, + "" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError.$1", + "id": "def-server.SavedObjectsSerializer.rawToSavedObject.$1", "type": "Object", "tags": [], - "label": "error", - "description": [], + "label": "doc", + "description": [ + "- The raw ES document to be converted to saved object format." + ], "signature": [ - "Error" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" + } ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError.$2", - "type": "string", + "id": "def-server.SavedObjectsSerializer.rawToSavedObject.$2", + "type": "Object", "tags": [], - "label": "reason", - "description": [], + "label": "options", + "description": [ + "- Options for parsing the raw document." + ], "signature": [ - "string | undefined" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDocParseOptions", + "text": "SavedObjectsRawDocParseOptions" + } ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError", + "id": "def-server.SavedObjectsSerializer.savedObjectToRaw", "type": "Function", "tags": [], - "label": "createTooManyRequestsError", - "description": [], + "label": "savedObjectToRaw", + "description": [ + "\nConverts a document from the saved object client format to the format that is stored in elasticsearch.\n" + ], "signature": [ - "(type: string, id: string) => ", - "DecoratedError" + "(savedObj: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectSanitizedDoc", + "text": "SavedObjectSanitizedDoc" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsRawDoc", + "text": "SavedObjectsRawDoc" + } ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError.$1", - "type": "string", + "id": "def-server.SavedObjectsSerializer.savedObjectToRaw.$1", + "type": "CompoundType", "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" + "label": "savedObj", + "description": [ + "- The saved object to be converted to raw ES format." ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createTooManyRequestsError.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectSanitizedDoc", + "text": "SavedObjectSanitizedDoc" + }, + "" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, "isRequired": true } @@ -3956,265 +3055,247 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isTooManyRequestsError", + "id": "def-server.SavedObjectsSerializer.generateRawId", "type": "Function", "tags": [], - "label": "isTooManyRequestsError", - "description": [], + "label": "generateRawId", + "description": [ + "\nGiven a saved object type and id, generates the compound id that is stored in the raw document.\n" + ], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "(namespace: string | undefined, type: string, id: string) => string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isTooManyRequestsError.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsSerializer.generateRawId.$1", + "type": "string", "tags": [], - "label": "error", - "description": [], + "label": "namespace", + "description": [ + "- The namespace of the saved object" + ], "signature": [ - "Error | ", - "DecoratedError" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError", - "type": "Function", - "tags": [], - "label": "decorateEsCannotExecuteScriptError", - "description": [], - "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "children": [ + "isRequired": false + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError.$1", - "type": "Object", + "id": "def-server.SavedObjectsSerializer.generateRawId.$2", + "type": "string", "tags": [], - "label": "error", - "description": [], + "label": "type", + "description": [ + "- The saved object type" + ], "signature": [ - "Error" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError.$2", + "id": "def-server.SavedObjectsSerializer.generateRawId.$3", "type": "string", "tags": [], - "label": "reason", - "description": [], + "label": "id", + "description": [ + "- The id of the saved object" + ], "signature": [ - "string | undefined" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isEsCannotExecuteScriptError", + "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId", "type": "Function", "tags": [], - "label": "isEsCannotExecuteScriptError", - "description": [], + "label": "generateRawLegacyUrlAliasId", + "description": [ + "\nGiven a saved object type and id, generates the compound id that is stored in the raw document for its legacy URL alias.\n" + ], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "(namespace: string | undefined, type: string, id: string) => string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isEsCannotExecuteScriptError.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$1", + "type": "string", "tags": [], - "label": "error", - "description": [], + "label": "namespace", + "description": [ + "- The namespace of the saved object" + ], "signature": [ - "Error | ", - "DecoratedError" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError", - "type": "Function", - "tags": [], - "label": "decorateEsUnavailableError", - "description": [], - "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "children": [ + "isRequired": false + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError.$1", - "type": "Object", + "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$2", + "type": "string", "tags": [], - "label": "error", - "description": [], + "label": "type", + "description": [ + "- The saved object type" + ], "signature": [ - "Error" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError.$2", + "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$3", "type": "string", "tags": [], - "label": "reason", - "description": [], + "label": "id", + "description": [ + "- The id of the saved object" + ], "signature": [ - "string | undefined" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/serialization/serializer.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUtils", + "type": "Class", + "tags": [], + "label": "SavedObjectsUtils", + "description": [], + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isEsUnavailableError", + "id": "def-server.SavedObjectsUtils.namespaceIdToString", "type": "Function", "tags": [], - "label": "isEsUnavailableError", - "description": [], + "label": "namespaceIdToString", + "description": [ + "\nConverts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with\nthe exception of the `undefined` namespace ID (which has a namespace string of `'default'`).\n" + ], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "(namespace?: string | undefined) => string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/utils.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isEsUnavailableError.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsUtils.namespaceIdToString.$1", + "type": "string", "tags": [], - "label": "error", - "description": [], + "label": "namespace", + "description": [ + "The namespace ID, which must be either a non-empty string or `undefined`." + ], "signature": [ - "Error | ", - "DecoratedError" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/utils.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError", + "id": "def-server.SavedObjectsUtils.namespaceStringToId", "type": "Function", "tags": [], - "label": "decorateGeneralError", - "description": [], + "label": "namespaceStringToId", + "description": [ + "\nConverts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with\nthe exception of the `'default'` namespace string (which has a namespace ID of `undefined`).\n" + ], "signature": [ - "(error: Error, reason?: string | undefined) => ", - "DecoratedError" + "(namespace: string) => string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/utils.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError.$1", - "type": "Object", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "Error" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.decorateGeneralError.$2", + "id": "def-server.SavedObjectsUtils.namespaceStringToId.$1", "type": "string", "tags": [], - "label": "reason", - "description": [], + "label": "namespace", + "description": [ + "The namespace string, which must be non-empty." + ], "signature": [ - "string | undefined" + "string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/utils.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isGeneralError", + "id": "def-server.SavedObjectsUtils.createEmptyFindResponse", "type": "Function", "tags": [], - "label": "isGeneralError", - "description": [], + "label": "createEmptyFindResponse", + "description": [ + "\nCreates an empty response for a find operation. This is only intended to be used by saved objects client wrappers." + ], "signature": [ - "(error: Error | ", - "DecoratedError", - ") => boolean" + "({ page, perPage, }: ", + "SavedObjectsFindOptions", + ") => ", + "SavedObjectsFindResponse", + "" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/utils.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.isGeneralError.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsUtils.createEmptyFindResponse.$1", + "type": "Object", "tags": [], - "label": "error", + "label": "{\n page = FIND_DEFAULT_PAGE,\n perPage = FIND_DEFAULT_PER_PAGE,\n }", "description": [], "signature": [ - "Error | ", - "DecoratedError" + "SavedObjectsFindOptions" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/utils.ts", "deprecated": false, "isRequired": true } @@ -4223,161 +3304,181 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError", + "id": "def-server.SavedObjectsUtils.generateId", "type": "Function", "tags": [], - "label": "createGenericNotFoundEsUnavailableError", - "description": [], + "label": "generateId", + "description": [ + "\nGenerates a random ID for a saved objects." + ], "signature": [ - "(type?: string | null, id?: string | null) => ", - "DecoratedError" + "() => string" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/utils.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsUtils.isRandomId", + "type": "Function", + "tags": [ + "todo" + ], + "label": "isRandomId", + "description": [ + "\nValidates that a saved object ID has been randomly generated.\n" + ], + "signature": [ + "(id: string | undefined) => boolean" + ], + "path": "src/core/server/saved_objects/service/lib/utils.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError.$1", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | null" - ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsErrorHelpers.createGenericNotFoundEsUnavailableError.$2", - "type": "CompoundType", + "id": "def-server.SavedObjectsUtils.isRandomId.$1", + "type": "string", "tags": [], "label": "id", - "description": [], + "description": [ + "The ID of a saved object." + ], "signature": [ - "string | null" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/errors.ts", + "path": "src/core/server/saved_objects/service/lib/utils.ts", "deprecated": false, "isRequired": false } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError", - "type": "Class", - "tags": [], - "label": "SavedObjectsExportError", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" }, - " extends Error" - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.Unnamed", + "id": "def-server.SavedObjectsUtils.getConvertedObjectId", "type": "Function", "tags": [], - "label": "Constructor", - "description": [], + "label": "getConvertedObjectId", + "description": [ + "\nUses a single-namespace object's \"legacy ID\" to determine what its new ID will be after it is converted to a multi-namespace type.\n" + ], "signature": [ - "any" + "(namespace: string | undefined, type: string, id: string) => string" ], - "path": "src/core/server/saved_objects/export/errors.ts", + "path": "src/core/server/saved_objects/service/lib/utils.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.Unnamed.$1", + "id": "def-server.SavedObjectsUtils.getConvertedObjectId.$1", "type": "string", "tags": [], - "label": "type", - "description": [], + "label": "namespace", + "description": [ + "The namespace of the saved object before it is converted." + ], "signature": [ - "string" + "string | undefined" ], - "path": "src/core/server/saved_objects/export/errors.ts", + "path": "src/core/server/saved_objects/service/lib/utils.ts", "deprecated": false, - "isRequired": true + "isRequired": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.Unnamed.$2", + "id": "def-server.SavedObjectsUtils.getConvertedObjectId.$2", "type": "string", "tags": [], - "label": "message", - "description": [], + "label": "type", + "description": [ + "The type of the saved object before it is converted." + ], "signature": [ "string" ], - "path": "src/core/server/saved_objects/export/errors.ts", + "path": "src/core/server/saved_objects/service/lib/utils.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.Unnamed.$3", - "type": "Object", + "id": "def-server.SavedObjectsUtils.getConvertedObjectId.$3", + "type": "string", "tags": [], - "label": "attributes", - "description": [], + "label": "id", + "description": [ + "The ID of the saved object before it is converted." + ], "signature": [ - "Record | undefined" + "string" ], - "path": "src/core/server/saved_objects/export/errors.ts", + "path": "src/core/server/saved_objects/service/lib/utils.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], - "returnComment": [] - }, + "returnComment": [ + "The ID of the saved object after it is converted." + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry", + "type": "Class", + "tags": [], + "label": "SavedObjectTypeRegistry", + "description": [ + "\nRegistry holding information about all the registered {@link SavedObjectsType | saved object types}.\n" + ], + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.exportSizeExceeded", + "id": "def-server.SavedObjectTypeRegistry.registerType", "type": "Function", "tags": [], - "label": "exportSizeExceeded", - "description": [], + "label": "registerType", + "description": [ + "\nRegister a {@link SavedObjectsType | type} inside the registry.\nA type can only be registered once. subsequent calls with the same type name will throw an error." + ], "signature": [ - "(limit: number) => ", + "(type: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" - } + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + ") => void" ], - "path": "src/core/server/saved_objects/export/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.exportSizeExceeded.$1", - "type": "number", + "id": "def-server.SavedObjectTypeRegistry.registerType.$1", + "type": "Object", "tags": [], - "label": "limit", + "label": "type", "description": [], "signature": [ - "number" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "" ], - "path": "src/core/server/saved_objects/export/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "isRequired": true } @@ -4386,38 +3487,38 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectFetchError", + "id": "def-server.SavedObjectTypeRegistry.getType", "type": "Function", "tags": [], - "label": "objectFetchError", - "description": [], + "label": "getType", + "description": [ + "\nReturn the {@link SavedObjectsType | type} definition for given type name." + ], "signature": [ - "(objects: ", - "SavedObject", - "[]) => ", + "(type: string) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" - } + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + " | undefined" ], - "path": "src/core/server/saved_objects/export/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectFetchError.$1", - "type": "Array", + "id": "def-server.SavedObjectTypeRegistry.getType.$1", + "type": "string", "tags": [], - "label": "objects", + "label": "type", "description": [], "signature": [ - "SavedObject", - "[]" + "string" ], - "path": "src/core/server/saved_objects/export/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "isRequired": true } @@ -4426,153 +3527,137 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectTransformError", + "id": "def-server.SavedObjectTypeRegistry.getVisibleTypes", "type": "Function", "tags": [], - "label": "objectTransformError", + "label": "getVisibleTypes", "description": [ - "\nError returned when a {@link SavedObjectsExportTransform | export transform} threw an error" + "\nReturns all visible {@link SavedObjectsType | types}.\n\nA visible type is a type that doesn't explicitly define `hidden=true` during registration." ], "signature": [ - "(objects: ", - "SavedObject", - "[], cause: Error) => ", + "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" - } + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]" ], - "path": "src/core/server/saved_objects/export/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, - "children": [ + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry.getAllTypes", + "type": "Function", + "tags": [], + "label": "getAllTypes", + "description": [ + "\nReturn all {@link SavedObjectsType | types} currently registered, including the hidden ones.\n\nTo only get the visible types (which is the most common use case), use `getVisibleTypes` instead." + ], + "signature": [ + "() => ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectTransformError.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [], - "signature": [ - "SavedObject", - "[]" - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.objectTransformError.$2", - "type": "Object", - "tags": [], - "label": "cause", - "description": [], - "signature": [ - "Error" - ], - "path": "src/core/server/saved_objects/export/errors.ts", - "deprecated": false, - "isRequired": true - } + "[]" ], + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "deprecated": false, + "children": [], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.invalidTransformError", + "id": "def-server.SavedObjectTypeRegistry.getImportableAndExportableTypes", "type": "Function", "tags": [], - "label": "invalidTransformError", + "label": "getImportableAndExportableTypes", "description": [ - "\nError returned when a {@link SavedObjectsExportTransform | export transform} performed an invalid operation\nduring the transform, such as removing objects from the export, or changing an object's type or id." + "\nReturn all {@link SavedObjectsType | types} currently registered that are importable/exportable." ], "signature": [ - "(objectKeys: string[]) => ", + "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportError", - "text": "SavedObjectsExportError" - } + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]" ], - "path": "src/core/server/saved_objects/export/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic", + "type": "Function", + "tags": [], + "label": "isNamespaceAgnostic", + "description": [ + "\nReturns whether the type is namespace-agnostic (global);\nresolves to `false` if the type is not registered" + ], + "signature": [ + "(type: string) => boolean" + ], + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsExportError.invalidTransformError.$1", - "type": "Array", + "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic.$1", + "type": "string", "tags": [], - "label": "objectKeys", + "label": "type", "description": [], "signature": [ - "string[]" + "string" ], - "path": "src/core/server/saved_objects/export/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError", - "type": "Class", - "tags": [], - "label": "SavedObjectsImportError", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" }, - " extends Error" - ], - "path": "src/core/server/saved_objects/import/errors.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.importSizeExceeded", + "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace", "type": "Function", "tags": [], - "label": "importSizeExceeded", - "description": [], + "label": "isSingleNamespace", + "description": [ + "\nReturns whether the type is single-namespace (isolated);\nresolves to `true` if the type is not registered" + ], "signature": [ - "(limit: number) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" - } + "(type: string) => boolean" ], - "path": "src/core/server/saved_objects/import/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.importSizeExceeded.$1", - "type": "number", + "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace.$1", + "type": "string", "tags": [], - "label": "limit", + "label": "type", "description": [], "signature": [ - "number" + "string" ], - "path": "src/core/server/saved_objects/import/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "isRequired": true } @@ -4581,35 +3666,30 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueImportObjects", + "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace", "type": "Function", "tags": [], - "label": "nonUniqueImportObjects", - "description": [], + "label": "isMultiNamespace", + "description": [ + "\nReturns whether the type is multi-namespace (shareable *or* isolated);\nresolves to `false` if the type is not registered" + ], "signature": [ - "(nonUniqueEntries: string[]) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" - } + "(type: string) => boolean" ], - "path": "src/core/server/saved_objects/import/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueImportObjects.$1", - "type": "Array", + "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace.$1", + "type": "string", "tags": [], - "label": "nonUniqueEntries", + "label": "type", "description": [], "signature": [ - "string[]" + "string" ], - "path": "src/core/server/saved_objects/import/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "isRequired": true } @@ -4618,35 +3698,30 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects", + "id": "def-server.SavedObjectTypeRegistry.isShareable", "type": "Function", "tags": [], - "label": "nonUniqueRetryObjects", - "description": [], + "label": "isShareable", + "description": [ + "\nReturns whether the type is multi-namespace (shareable);\nresolves to `false` if the type is not registered" + ], "signature": [ - "(nonUniqueRetryObjects: string[]) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" - } + "(type: string) => boolean" ], - "path": "src/core/server/saved_objects/import/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueRetryObjects.$1", - "type": "Array", + "id": "def-server.SavedObjectTypeRegistry.isShareable.$1", + "type": "string", "tags": [], - "label": "nonUniqueRetryObjects", + "label": "type", "description": [], "signature": [ - "string[]" + "string" ], - "path": "src/core/server/saved_objects/import/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "isRequired": true } @@ -4655,35 +3730,30 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations", + "id": "def-server.SavedObjectTypeRegistry.isHidden", "type": "Function", "tags": [], - "label": "nonUniqueRetryDestinations", - "description": [], + "label": "isHidden", + "description": [ + "\nReturns the `hidden` property for given type, or `false` if\nthe type is not registered." + ], "signature": [ - "(nonUniqueRetryDestinations: string[]) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" - } + "(type: string) => boolean" ], - "path": "src/core/server/saved_objects/import/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.nonUniqueRetryDestinations.$1", - "type": "Array", + "id": "def-server.SavedObjectTypeRegistry.isHidden.$1", + "type": "string", "tags": [], - "label": "nonUniqueRetryDestinations", + "label": "type", "description": [], "signature": [ - "string[]" + "string" ], - "path": "src/core/server/saved_objects/import/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "isRequired": true } @@ -4692,38 +3762,62 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.referencesFetchError", + "id": "def-server.SavedObjectTypeRegistry.getIndex", "type": "Function", "tags": [], - "label": "referencesFetchError", - "description": [], + "label": "getIndex", + "description": [ + "\nReturns the `indexPattern` property for given type, or `undefined` if\nthe type is not registered." + ], "signature": [ - "(objects: ", - "SavedObject", - "[]) => ", + "(type: string) => string | undefined" + ], + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportError", - "text": "SavedObjectsImportError" + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry.getIndex.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "deprecated": false, + "isRequired": true } ], - "path": "src/core/server/saved_objects/import/errors.ts", + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable", + "type": "Function", + "tags": [], + "label": "isImportableAndExportable", + "description": [ + "\nReturns the `management.importableAndExportable` property for given type, or\n`false` if the type is not registered or does not define a management section." + ], + "signature": [ + "(type: string) => boolean" + ], + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsImportError.referencesFetchError.$1", - "type": "Array", + "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable.$1", + "type": "string", "tags": [], - "label": "objects", + "label": "type", "description": [], "signature": [ - "SavedObject", - "[]" + "string" ], - "path": "src/core/server/saved_objects/import/errors.ts", + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", "deprecated": false, "isRequired": true } @@ -4732,79 +3826,135 @@ } ], "initialIsOpen": false - }, + } + ], + "functions": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository", - "type": "Class", + "id": "def-server.mergeSavedObjectMigrationMaps", + "type": "Function", "tags": [], - "label": "SavedObjectsRepository", - "description": [], - "path": "src/core/server/saved_objects/service/lib/repository.ts", + "label": "mergeSavedObjectMigrationMaps", + "description": [ + "\nMerges two saved object migration maps.\n\nIf there is a migration for a given version on only one of the maps,\nthat migration function will be used:\n\nmergeSavedObjectMigrationMaps({ '1.2.3': f }, { '4.5.6': g }) -> { '1.2.3': f, '4.5.6': g }\n\nIf there is a migration for a given version on both maps, the migrations will be composed:\n\nmergeSavedObjectMigrationMaps({ '1.2.3': f }, { '1.2.3': g }) -> { '1.2.3': (doc, context) => f(g(doc, context), context) }\n" + ], + "signature": [ + "(map1: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + }, + ", map2: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + }, + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + } + ], + "path": "src/core/server/saved_objects/migrations/utils.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.create", + "id": "def-server.mergeSavedObjectMigrationMaps.$1", + "type": "Object", + "tags": [], + "label": "map1", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + } + ], + "path": "src/core/server/saved_objects/migrations/utils.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.mergeSavedObjectMigrationMaps.$2", + "type": "Object", + "tags": [], + "label": "map2", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + } + ], + "path": "src/core/server/saved_objects/migrations/utils.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsExporter", + "type": "Interface", + "tags": [], + "label": "ISavedObjectsExporter", + "description": [ + "\nUtility class used to export savedObjects.\n" + ], + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsExporter.exportByTypes", "type": "Function", "tags": [ - "property", - "property", - "property", - "property", - "property" + "throws" ], - "label": "create", + "label": "exportByTypes", "description": [ - "\nPersists an object\n" + "\nGenerates an export stream for given types.\n\nSee the {@link SavedObjectsExportByTypeOptions | options} for more detailed information.\n" ], "signature": [ - "(type: string, attributes: T, options?: ", + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" }, ") => Promise<", - "SavedObject", - ">" + "Readable", + ">" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.create.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.create.$2", - "type": "Uncategorized", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "T" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.create.$3", + "id": "def-server.ISavedObjectsExporter.exportByTypes.$1", "type": "Object", "tags": [], "label": "options", @@ -4814,87 +3964,47 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" } ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "- { id, type, version, attributes }" - ] + "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkCreate", + "id": "def-server.ISavedObjectsExporter.exportByObjects", "type": "Function", "tags": [ - "property", - "property" + "throws" ], - "label": "bulkCreate", + "label": "exportByObjects", "description": [ - "\nCreates multiple documents at once\n" + "\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n" ], "signature": [ - "(objects: ", + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" }, ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">" + "Readable", + ">" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkCreate.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [ - "- [{ type, id, attributes, references, migrationVersion }]" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkCreate.$2", + "id": "def-server.ISavedObjectsExporter.exportByObjects.$1", "type": "Object", "tags": [], "label": "options", @@ -4904,82 +4014,62 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" } ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", + "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" - ] - }, + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectsImporter", + "type": "Interface", + "tags": [], + "label": "ISavedObjectsImporter", + "description": [ + "\nUtility class used to import savedObjects.\n" + ], + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.checkConflicts", + "id": "def-server.ISavedObjectsImporter.import", "type": "Function", - "tags": [], - "label": "checkConflicts", + "tags": [ + "throws" + ], + "label": "import", "description": [ - "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten." + "\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n" ], "signature": [ - "(objects?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[], options?: ", + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsImportOptions", + "text": "SavedObjectsImportOptions" }, ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsResponse", - "text": "SavedObjectsCheckConflictsResponse" - }, + "SavedObjectsImportResponse", ">" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.checkConflicts.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCheckConflictsObject", - "text": "SavedObjectsCheckConflictsObject" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.checkConflicts.$2", + "id": "def-server.ISavedObjectsImporter.import.$1", "type": "Object", "tags": [], "label": "options", @@ -4989,11 +4079,11 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsImportOptions", + "text": "SavedObjectsImportOptions" } ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", "deprecated": false, "isRequired": true } @@ -5002,60 +4092,34 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.delete", + "id": "def-server.ISavedObjectsImporter.resolveImportErrors", "type": "Function", "tags": [ - "property" + "throws" ], - "label": "delete", + "label": "resolveImportErrors", "description": [ - "\nDeletes an object\n" + "\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed information.\n" ], "signature": [ - "(type: string, id: string, options?: ", + "(options: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" + "section": "def-server.SavedObjectsResolveImportErrorsOptions", + "text": "SavedObjectsResolveImportErrorsOptions" }, - ") => Promise<{}>" + ") => Promise<", + "SavedObjectsImportResponse", + ">" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.delete.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.delete.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.delete.$3", + "id": "def-server.ISavedObjectsImporter.resolveImportErrors.$1", "type": "Object", "tags": [], "label": "options", @@ -5065,1538 +4129,828 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" + "section": "def-server.SavedObjectsResolveImportErrorsOptions", + "text": "SavedObjectsResolveImportErrorsOptions" } ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", + "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectExportBaseOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectExportBaseOptions", + "description": [], + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.deleteByNamespace", - "type": "Function", + "id": "def-server.SavedObjectExportBaseOptions.request", + "type": "Object", "tags": [], - "label": "deleteByNamespace", + "label": "request", "description": [ - "\nDeletes all objects from the provided namespace.\n" + "The http request initiating the export." ], "signature": [ - "(namespace: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteByNamespaceOptions", - "text": "SavedObjectsDeleteByNamespaceOptions" - }, - ") => Promise" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.deleteByNamespace.$1", - "type": "string", - "tags": [], - "label": "namespace", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.deleteByNamespace.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteByNamespaceOptions", - "text": "SavedObjectsDeleteByNamespaceOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - } + "KibanaRequest", + "" ], - "returnComment": [ - "- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures }" - ] + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.find", - "type": "Function", - "tags": [ - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property", - "property" + "id": "def-server.SavedObjectExportBaseOptions.includeReferencesDeep", + "type": "CompoundType", + "tags": [], + "label": "includeReferencesDeep", + "description": [ + "flag to also include all related saved objects in the export stream." ], - "label": "find", - "description": [], "signature": [ - "(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" - }, - ">" + "boolean | undefined" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.find.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }" - ] + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkGet", - "type": "Function", - "tags": [ - "property" - ], - "label": "bulkGet", + "id": "def-server.SavedObjectExportBaseOptions.includeNamespaces", + "type": "CompoundType", + "tags": [], + "label": "includeNamespaces", "description": [ - "\nReturns an array of objects by id\n" + "\nFlag to also include namespace information in the export stream. By default, namespace information is not included in exported objects.\nThis is only intended to be used internally during copy-to-space operations, and it is not exposed as an option for the external HTTP\nroute for exports." ], "signature": [ - "(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" - }, - ">" + "boolean | undefined" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkGet.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [ - "- an array of objects containing id, type and optionally fields" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkGetObject", - "text": "SavedObjectsBulkGetObject" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkGet.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - } + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectExportBaseOptions.excludeExportDetails", + "type": "CompoundType", + "tags": [], + "label": "excludeExportDetails", + "description": [ + "flag to not append {@link SavedObjectsExportResultDetails | export details} to the end of the export stream." ], - "returnComment": [ - "- { saved_objects: [{ id, type, version, attributes }] }" - ] + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkResolve", - "type": "Function", - "tags": [ - "property" + "id": "def-server.SavedObjectExportBaseOptions.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [ + "optional namespace to override the namespace used by the savedObjectsClient." ], - "label": "bulkResolve", + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectMigrationContext", + "type": "Interface", + "tags": [], + "label": "SavedObjectMigrationContext", + "description": [ + "\nMigration context provided when invoking a {@link SavedObjectMigrationFn | migration handler}\n" + ], + "path": "src/core/server/saved_objects/migrations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectMigrationContext.log", + "type": "Object", + "tags": [], + "label": "log", "description": [ - "\nResolves an array of objects by id, using any legacy URL aliases if they exist\n" + "\nlogger instance to be used by the migration handler" ], "signature": [ - "(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" - }, - ") => Promise<", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - ">" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkResolve.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [ - "- an array of objects containing id, type" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveObject", - "text": "SavedObjectsBulkResolveObject" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkResolve.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true + "section": "def-server.SavedObjectsMigrationLogger", + "text": "SavedObjectsMigrationLogger" } ], - "returnComment": [ - "- { resolved_objects: [{ saved_object, outcome }] }" - ] + "path": "src/core/server/saved_objects/migrations/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.get", - "type": "Function", - "tags": [ - "property" + "id": "def-server.SavedObjectMigrationContext.migrationVersion", + "type": "string", + "tags": [], + "label": "migrationVersion", + "description": [ + "\nThe migration version that this migration function is defined for" ], - "label": "get", + "path": "src/core/server/saved_objects/migrations/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion", + "type": "string", + "tags": [], + "label": "convertToMultiNamespaceTypeVersion", "description": [ - "\nGets a single object\n" + "\nThe version in which this object type is being converted to a multi-namespace type" ], "signature": [ - "(type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.get.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.get.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.get.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "- { id, type, version, attributes }" - ] + "path": "src/core/server/saved_objects/migrations/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.resolve", - "type": "Function", - "tags": [ - "property" - ], - "label": "resolve", + "id": "def-server.SavedObjectMigrationContext.isSingleNamespaceType", + "type": "boolean", + "tags": [], + "label": "isSingleNamespaceType", "description": [ - "\nResolves a single object, using any legacy URL alias if it exists\n" + "\nWhether this is a single-namespace type or not" ], + "path": "src/core/server/saved_objects/migrations/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectMigrationMap", + "type": "Interface", + "tags": [], + "label": "SavedObjectMigrationMap", + "description": [ + "\nA map of {@link SavedObjectMigrationFn | migration functions} to be used for a given type.\nThe map's keys must be valid semver versions, and they cannot exceed the current Kibana version.\n\nFor a given document, only migrations with a higher version number than that of the document will be applied.\nMigrations are executed in order, starting from the lowest version and ending with the highest one.\n" + ], + "path": "src/core/server/saved_objects/migrations/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectMigrationMap.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[version: string]: SavedObjectMigrationFn", + "description": [], "signature": [ - "(type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", + "[version: string]: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" + "section": "def-server.SavedObjectMigrationFn", + "text": "SavedObjectMigrationFn" }, - ">" + "" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.resolve.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.resolve.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.resolve.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - } + "path": "src/core/server/saved_objects/migrations/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientProviderOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsClientProviderOptions", + "description": [ + "\nOptions to control the creation of the Saved Objects Client." + ], + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientProviderOptions.excludedWrappers", + "type": "Array", + "tags": [], + "label": "excludedWrappers", + "description": [], + "signature": [ + "string[] | undefined" ], - "returnComment": [ - "- { saved_object, outcome }" - ] + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.update", - "type": "Function", - "tags": [ - "property", - "property", - "property" + "id": "def-server.SavedObjectsClientProviderOptions.includedHiddenTypes", + "type": "Array", + "tags": [], + "label": "includedHiddenTypes", + "description": [], + "signature": [ + "string[] | undefined" ], - "label": "update", - "description": [ - "\nUpdates an object\n" + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientWrapperOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsClientWrapperOptions", + "description": [ + "\nOptions passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance." + ], + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientWrapperOptions.client", + "type": "Object", + "tags": [], + "label": "client", + "description": [], + "signature": [ + "SavedObjectsClientContract" ], + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsClientWrapperOptions.typeRegistry", + "type": "Object", + "tags": [], + "label": "typeRegistry", + "description": [], "signature": [ - "(type: string, id: string, attributes: Partial, options?: ", + "{ isHidden: (type: string) => boolean; getType: (type: string) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ") => Promise<", + " | undefined; getVisibleTypes: () => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ">" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ + "[]; getAllTypes: () => ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.update.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, + "[]; getImportableAndExportableTypes: () => ", { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.update.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.update.$3", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "Partial" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.update.$4", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - "" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - } + "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" ], - "returnComment": [] + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences", - "type": "Function", + "id": "def-server.SavedObjectsClientWrapperOptions.request", + "type": "Object", "tags": [], - "label": "collectMultiNamespaceReferences", + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportByObjectOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsExportByObjectOptions", + "description": [ + "\nOptions for the {@link ISavedObjectsExporter.exportByObjects | export by objects API}\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByObjectOptions", + "text": "SavedObjectsExportByObjectOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectExportBaseOptions", + "text": "SavedObjectExportBaseOptions" + } + ], + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportByObjectOptions.objects", + "type": "Array", + "tags": [], + "label": "objects", "description": [ - "\nGets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace\ntype.\n" + "optional array of objects to export." ], "signature": [ - "(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" - }, - ">" + "{ id: string; type: string; }[]" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [ - "The objects to get the references for." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "text": "SavedObjectsCollectMultiNamespaceReferencesObject" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.collectMultiNamespaceReferences.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": false - } + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportByTypeOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsExportByTypeOptions", + "description": [ + "\nOptions for the {@link ISavedObjectsExporter.exportByTypes | export by type API}\n" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportByTypeOptions", + "text": "SavedObjectsExportByTypeOptions" + }, + " extends ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectExportBaseOptions", + "text": "SavedObjectExportBaseOptions" + } + ], + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportByTypeOptions.types", + "type": "Array", + "tags": [], + "label": "types", + "description": [ + "array of saved object types." ], - "returnComment": [] + "signature": [ + "string[]" + ], + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.updateObjectsSpaces", - "type": "Function", + "id": "def-server.SavedObjectsExportByTypeOptions.hasReference", + "type": "Array", "tags": [], - "label": "updateObjectsSpaces", + "label": "hasReference", "description": [ - "\nUpdates one or more objects to add and/or remove them from specified spaces.\n" + "optional array of references to search object for." ], "signature": [ - "(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" - }, - ">" + "SavedObjectsFindOptionsReference", + "[] | undefined" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "text": "SavedObjectsUpdateObjectsSpacesObject" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$2", - "type": "Array", - "tags": [], - "label": "spacesToAdd", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$3", - "type": "Array", - "tags": [], - "label": "spacesToRemove", - "description": [], - "signature": [ - "string[]" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.updateObjectsSpaces.$4", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkUpdate", - "type": "Function", - "tags": [ - "property", - "property" - ], - "label": "bulkUpdate", + "id": "def-server.SavedObjectsExportByTypeOptions.search", + "type": "string", + "tags": [], + "label": "search", "description": [ - "\nUpdates multiple objects in bulk\n" + "optional query string to filter exported objects." ], "signature": [ - "(objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkUpdate.$1", - "type": "Array", - "tags": [], - "label": "objects", - "description": [ - "- [{ type, id, attributes, options: { version, namespace } references }]" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.bulkUpdate.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - } + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportExcludedObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsExportExcludedObject", + "description": [], + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportExcludedObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "id of the excluded object" ], - "returnComment": [ - "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" - ] + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.removeReferencesTo", - "type": "Function", + "id": "def-server.SavedObjectsExportExcludedObject.type", + "type": "string", "tags": [], - "label": "removeReferencesTo", + "label": "type", "description": [ - "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n" - ], - "signature": [ - "(type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - ">" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.removeReferencesTo.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.removeReferencesTo.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.removeReferencesTo.$3", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - } + "type of the excluded object" ], - "returnComment": [] + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.incrementCounter", - "type": "Function", + "id": "def-server.SavedObjectsExportExcludedObject.reason", + "type": "string", "tags": [], - "label": "incrementCounter", + "label": "reason", "description": [ - "\nIncrements all the specified counter fields (by one by default). Creates the document\nif one doesn't exist for the given id.\n" + "optional cause of the exclusion" ], "signature": [ - "(type: string, id: string, counterFields: (string | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterField", - "text": "SavedObjectsIncrementCounterField" - }, - ")[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterOptions", - "text": "SavedObjectsIncrementCounterOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">" + "string | undefined" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.incrementCounter.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "- The type of saved object whose fields should be incremented" - ], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.incrementCounter.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "- The id of the document whose fields should be incremented" - ], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.incrementCounter.$3", - "type": "Array", - "tags": [], - "label": "counterFields", - "description": [ - "- An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField }" - ], - "signature": [ - "(string | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterField", - "text": "SavedObjectsIncrementCounterField" - }, - ")[]" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.incrementCounter.$4", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "- {@link SavedObjectsIncrementCounterOptions }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterOptions", - "text": "SavedObjectsIncrementCounterOptions" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": false - } + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportResultDetails", + "type": "Interface", + "tags": [], + "label": "SavedObjectsExportResultDetails", + "description": [ + "\nStructure of the export result details entry" + ], + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportResultDetails.exportedCount", + "type": "number", + "tags": [], + "label": "exportedCount", + "description": [ + "number of successfully exported objects" ], - "returnComment": [ - "The saved object after the specified fields were incremented" - ] + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.openPointInTimeForType", - "type": "Function", - "tags": [ - "property", - "property" - ], - "label": "openPointInTimeForType", + "id": "def-server.SavedObjectsExportResultDetails.missingRefCount", + "type": "number", + "tags": [], + "label": "missingRefCount", "description": [ - "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to `SavedObjects.find` to search against that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" - ], - "signature": [ - "(type: string | string[], { keepAlive, preference }?: ", - { - "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" - }, - ">" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.openPointInTimeForType.$1", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | string[]" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.openPointInTimeForType.$2", - "type": "Object", - "tags": [], - "label": "{ keepAlive = '5m', preference }", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - } + "number of missing references" ], - "returnComment": [ - "- { id: string }" - ] + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.closePointInTime", - "type": "Function", + "id": "def-server.SavedObjectsExportResultDetails.missingReferences", + "type": "Array", "tags": [], - "label": "closePointInTime", + "label": "missingReferences", "description": [ - "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES\nvia the Elasticsearch client, and is included in the Saved Objects Client\nas a convenience for consumers who are using `openPointInTimeForType`.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" + "missing references details" ], "signature": [ - "(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" - }, - ">" + "{ id: string; type: string; }[]" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.closePointInTime.$1", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.closePointInTime.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "- {@link SavedObjectsClosePointInTimeOptions }" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": false - } + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportResultDetails.excludedObjectsCount", + "type": "number", + "tags": [], + "label": "excludedObjectsCount", + "description": [ + "number of objects that were excluded from the export" ], - "returnComment": [ - "- {@link SavedObjectsClosePointInTimeResponse }" - ] + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.createPointInTimeFinder", - "type": "Function", + "id": "def-server.SavedObjectsExportResultDetails.excludedObjects", + "type": "Array", "tags": [], - "label": "createPointInTimeFinder", + "label": "excludedObjects", "description": [ - "\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThis generator wraps calls to {@link SavedObjectsRepository.find} and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a\nset of results is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n" + "excluded objects details" ], "signature": [ - "(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" + "section": "def-server.SavedObjectsExportExcludedObject", + "text": "SavedObjectsExportExcludedObject" }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" - }, - "" + "[]" ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$1", - "type": "Object", - "tags": [], - "label": "findOptions", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "text": "SavedObjectsCreatePointInTimeFinderOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepository.createPointInTimeFinder.$2", - "type": "Object", - "tags": [], - "label": "dependencies", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "isRequired": false - } + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportTransformContext", + "type": "Interface", + "tags": [], + "label": "SavedObjectsExportTransformContext", + "description": [ + "\nContext passed down to a {@link SavedObjectsExportTransform | export transform function}\n" + ], + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsExportTransformContext.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "\nThe request that initiated the export request. Can be used to create scoped\nservices or client inside the {@link SavedObjectsExportTransform | transformation}" ], - "returnComment": [] + "signature": [ + "KibanaRequest", + "" + ], + "path": "src/core/server/saved_objects/export/types.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer", - "type": "Class", + "id": "def-server.SavedObjectsImportHookResult", + "type": "Interface", "tags": [], - "label": "SavedObjectsSerializer", + "label": "SavedObjectsImportHookResult", "description": [ - "\nA serializer that can be used to manually convert {@link SavedObjectsRawDoc | raw} or\n{@link SavedObjectSanitizedDoc | sanitized} documents to the other kind.\n" + "\nResult from a {@link SavedObjectsImportHook | import hook}\n" ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.isRawSavedObject", - "type": "Function", + "id": "def-server.SavedObjectsImportHookResult.warnings", + "type": "Array", "tags": [], - "label": "isRawSavedObject", + "label": "warnings", "description": [ - "\nDetermines whether or not the raw document can be converted to a saved object.\n" + "\nAn optional list of warnings to display in the UI when the import succeeds." ], "signature": [ - "(doc: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDoc", - "text": "SavedObjectsRawDoc" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDocParseOptions", - "text": "SavedObjectsRawDocParseOptions" - }, - ") => boolean" + "SavedObjectsImportWarning", + "[] | undefined" ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.isRawSavedObject.$1", - "type": "Object", - "tags": [], - "label": "doc", - "description": [ - "- The raw ES document to be tested" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDoc", - "text": "SavedObjectsRawDoc" - } - ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.isRawSavedObject.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "- Options for parsing the raw document." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDocParseOptions", - "text": "SavedObjectsRawDocParseOptions" - } - ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "deprecated": false, - "isRequired": true - } + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportOptions", + "description": [ + "\nOptions to control the import operation." + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportOptions.readStream", + "type": "Object", + "tags": [], + "label": "readStream", + "description": [ + "The stream of {@link SavedObject | saved objects} to import" ], - "returnComment": [] + "signature": [ + "Readable" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.rawToSavedObject", - "type": "Function", + "id": "def-server.SavedObjectsImportOptions.overwrite", + "type": "boolean", "tags": [], - "label": "rawToSavedObject", + "label": "overwrite", "description": [ - "\nConverts a document from the format that is stored in elasticsearch to the saved object client format.\n" + "If true, will override existing object if present. Note: this has no effect when used with the `createNewCopies` option." + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportOptions.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [ + "if specified, will import in given namespace, else will import as global object" ], "signature": [ - "(doc: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDoc", - "text": "SavedObjectsRawDoc" - }, - ", options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDocParseOptions", - "text": "SavedObjectsRawDocParseOptions" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectSanitizedDoc", - "text": "SavedObjectSanitizedDoc" - }, - "" + "string | undefined" ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.rawToSavedObject.$1", - "type": "Object", - "tags": [], - "label": "doc", - "description": [ - "- The raw ES document to be converted to saved object format." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDoc", - "text": "SavedObjectsRawDoc" - } - ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.rawToSavedObject.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [ - "- Options for parsing the raw document." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDocParseOptions", - "text": "SavedObjectsRawDocParseOptions" - } - ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "deprecated": false, - "isRequired": true - } + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsImportOptions.createNewCopies", + "type": "boolean", + "tags": [], + "label": "createNewCopies", + "description": [ + "If true, will create new copies of import objects, each with a random `id` and undefined `originId`." ], - "returnComment": [] + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.savedObjectToRaw", - "type": "Function", + "id": "def-server.SavedObjectsImportOptions.refresh", + "type": "CompoundType", "tags": [], - "label": "savedObjectToRaw", + "label": "refresh", "description": [ - "\nConverts a document from the saved object client format to the format that is stored in elasticsearch.\n" + "Refresh setting, defaults to `wait_for`" ], "signature": [ - "(savedObj: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectSanitizedDoc", - "text": "SavedObjectSanitizedDoc" - }, - ") => ", + "boolean | \"wait_for\" | undefined" + ], + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsMappingProperties", + "type": "Interface", + "tags": [], + "label": "SavedObjectsMappingProperties", + "description": [ + "\nDescribe the fields of a {@link SavedObjectsTypeMappingDefinition | saved object type}.\n" + ], + "path": "src/core/server/saved_objects/mappings/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsMappingProperties.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[field: string]: SavedObjectsFieldMapping", + "description": [], + "signature": [ + "[field: string]: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRawDoc", - "text": "SavedObjectsRawDoc" + "section": "def-server.SavedObjectsFieldMapping", + "text": "SavedObjectsFieldMapping" } ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", + "path": "src/core/server/saved_objects/mappings/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsMigrationLogger", + "type": "Interface", + "tags": [], + "label": "SavedObjectsMigrationLogger", + "description": [], + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsMigrationLogger.debug", + "type": "Function", + "tags": [], + "label": "debug", + "description": [], + "signature": [ + "(msg: string) => void" + ], + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.savedObjectToRaw.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsMigrationLogger.debug.$1", + "type": "string", "tags": [], - "label": "savedObj", - "description": [ - "- The saved object to be converted to raw ES format." - ], + "label": "msg", + "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectSanitizedDoc", - "text": "SavedObjectSanitizedDoc" - }, - "" + "string" ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": false, "isRequired": true } @@ -6605,64 +4959,105 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawId", + "id": "def-server.SavedObjectsMigrationLogger.info", "type": "Function", "tags": [], - "label": "generateRawId", - "description": [ - "\nGiven a saved object type and id, generates the compound id that is stored in the raw document.\n" - ], + "label": "info", + "description": [], "signature": [ - "(namespace: string | undefined, type: string, id: string) => string" + "(msg: string) => void" ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawId.$1", + "id": "def-server.SavedObjectsMigrationLogger.info.$1", "type": "string", "tags": [], - "label": "namespace", - "description": [ - "- The namespace of the saved object" - ], + "label": "msg", + "description": [], "signature": [ - "string | undefined" + "string" ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": false, - "isRequired": false + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsMigrationLogger.warning", + "type": "Function", + "tags": [ + "deprecated" + ], + "label": "warning", + "description": [], + "signature": [ + "(msg: string) => void" + ], + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "deprecated": true, + "removeBy": "8.8.0", + "references": [ + { + "plugin": "maps", + "path": "x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts" }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts" + }, + { + "plugin": "dashboard", + "path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts" + } + ], + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawId.$2", + "id": "def-server.SavedObjectsMigrationLogger.warning.$1", "type": "string", "tags": [], - "label": "type", - "description": [ - "- The saved object type" - ], + "label": "msg", + "description": [], "signature": [ "string" ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": false, "isRequired": true - }, + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsMigrationLogger.warn", + "type": "Function", + "tags": [], + "label": "warn", + "description": [], + "signature": [ + "(msg: string) => void" + ], + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawId.$3", + "id": "def-server.SavedObjectsMigrationLogger.warn.$1", "type": "string", "tags": [], - "label": "id", - "description": [ - "- The id of the saved object" - ], + "label": "msg", + "description": [], "signature": [ "string" ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": false, "isRequired": true } @@ -6671,64 +5066,46 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId", + "id": "def-server.SavedObjectsMigrationLogger.error", "type": "Function", "tags": [], - "label": "generateRawLegacyUrlAliasId", - "description": [ - "\nGiven a saved object type and id, generates the compound id that is stored in the raw document for its legacy URL alias.\n" - ], + "label": "error", + "description": [], "signature": [ - "(namespace: string | undefined, type: string, id: string) => string" + "(msg: string, meta: Meta) => void" ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$1", - "type": "string", - "tags": [], - "label": "namespace", - "description": [ - "- The namespace of the saved object" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$2", + "id": "def-server.SavedObjectsMigrationLogger.error.$1", "type": "string", "tags": [], - "label": "type", - "description": [ - "- The saved object type" - ], + "label": "msg", + "description": [], "signature": [ "string" ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": false, "isRequired": true }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId.$3", - "type": "string", + "id": "def-server.SavedObjectsMigrationLogger.error.$2", + "type": "Uncategorized", "tags": [], - "label": "id", - "description": [ - "- The id of the saved object" - ], + "label": "meta", + "description": [], "signature": [ - "string" + "Meta" ], - "path": "src/core/server/saved_objects/serialization/serializer.ts", + "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", "deprecated": false, "isRequired": true } @@ -6740,42 +5117,156 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils", - "type": "Class", + "id": "def-server.SavedObjectsRawDoc", + "type": "Interface", "tags": [], - "label": "SavedObjectsUtils", - "description": [], - "path": "src/core/server/saved_objects/service/lib/utils.ts", + "label": "SavedObjectsRawDoc", + "description": [ + "\nA raw document as represented directly in the saved object index.\n" + ], + "path": "src/core/server/saved_objects/serialization/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.namespaceIdToString", + "id": "def-server.SavedObjectsRawDoc._id", + "type": "string", + "tags": [], + "label": "_id", + "description": [], + "path": "src/core/server/saved_objects/serialization/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRawDoc._source", + "type": "Object", + "tags": [], + "label": "_source", + "description": [], + "signature": [ + "SavedObjectsRawDocSource" + ], + "path": "src/core/server/saved_objects/serialization/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRawDoc._seq_no", + "type": "number", + "tags": [], + "label": "_seq_no", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/core/server/saved_objects/serialization/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRawDoc._primary_term", + "type": "number", + "tags": [], + "label": "_primary_term", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "src/core/server/saved_objects/serialization/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRawDocParseOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsRawDocParseOptions", + "description": [ + "\nOptions that can be specified when using the saved objects serializer to parse a raw document.\n" + ], + "path": "src/core/server/saved_objects/serialization/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRawDocParseOptions.namespaceTreatment", + "type": "CompoundType", + "tags": [], + "label": "namespaceTreatment", + "description": [ + "\nOptional setting to allow for lax handling of the raw document ID and namespace field. This is needed when a previously\nsingle-namespace object type is converted to a multi-namespace object type, and it is only intended to be used during upgrade\nmigrations.\n\nIf not specified, the default treatment is `strict`." + ], + "signature": [ + "\"strict\" | \"lax\" | undefined" + ], + "path": "src/core/server/saved_objects/serialization/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepositoryFactory", + "type": "Interface", + "tags": [], + "label": "SavedObjectsRepositoryFactory", + "description": [ + "\nFactory provided when invoking a {@link SavedObjectsClientFactoryProvider | client factory provider}\nSee {@link SavedObjectsServiceSetup.setClientFactoryProvider}\n" + ], + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository", "type": "Function", "tags": [], - "label": "namespaceIdToString", + "label": "createScopedRepository", "description": [ - "\nConverts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with\nthe exception of the `undefined` namespace ID (which has a namespace string of `'default'`).\n" + "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n" ], "signature": [ - "(namespace?: string | undefined) => string" + "(req: ", + "KibanaRequest", + ", includedHiddenTypes?: string[] | undefined) => ", + "ISavedObjectsRepository" ], - "path": "src/core/server/saved_objects/service/lib/utils.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.namespaceIdToString.$1", - "type": "string", + "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository.$1", + "type": "Object", "tags": [], - "label": "namespace", + "label": "req", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository.$2", + "type": "Array", + "tags": [], + "label": "includedHiddenTypes", "description": [ - "The namespace ID, which must be either a non-empty string or `undefined`." + "- A list of additional hidden types the repository should have access to." ], "signature": [ - "string | undefined" + "string[] | undefined" ], - "path": "src/core/server/saved_objects/service/lib/utils.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "isRequired": false } @@ -6784,416 +5275,364 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.namespaceStringToId", + "id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository", "type": "Function", "tags": [], - "label": "namespaceStringToId", + "label": "createInternalRepository", "description": [ - "\nConverts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with\nthe exception of the `'default'` namespace string (which has a namespace ID of `undefined`).\n" + "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" ], "signature": [ - "(namespace: string) => string | undefined" + "(includedHiddenTypes?: string[] | undefined) => ", + "ISavedObjectsRepository" ], - "path": "src/core/server/saved_objects/service/lib/utils.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.namespaceStringToId.$1", - "type": "string", + "id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository.$1", + "type": "Array", "tags": [], - "label": "namespace", + "label": "includedHiddenTypes", "description": [ - "The namespace string, which must be non-empty." + "- A list of additional hidden types the repository should have access to." ], "signature": [ - "string" + "string[] | undefined" ], - "path": "src/core/server/saved_objects/service/lib/utils.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRequestHandlerContext", + "type": "Interface", + "tags": [], + "label": "SavedObjectsRequestHandlerContext", + "description": [ + "\nCore's `savedObjects` request handler context." + ], + "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.createEmptyFindResponse", - "type": "Function", + "id": "def-server.SavedObjectsRequestHandlerContext.client", + "type": "Object", "tags": [], - "label": "createEmptyFindResponse", - "description": [ - "\nCreates an empty response for a find operation. This is only intended to be used by saved objects client wrappers." + "label": "client", + "description": [], + "signature": [ + "SavedObjectsClientContract" ], + "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRequestHandlerContext.typeRegistry", + "type": "Object", + "tags": [], + "label": "typeRegistry", + "description": [], "signature": [ - "({ page, perPage, }: ", + "{ isHidden: (type: string) => boolean; getType: (type: string) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ") => ", + " | undefined; getVisibleTypes: () => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - "" - ], - "path": "src/core/server/saved_objects/service/lib/utils.ts", + "[]; getAllTypes: () => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]; getImportableAndExportableTypes: () => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" + ], + "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsRequestHandlerContext.getClient", + "type": "Function", + "tags": [], + "label": "getClient", + "description": [], + "signature": [ + "(options?: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientProviderOptions", + "text": "SavedObjectsClientProviderOptions" + }, + " | undefined) => ", + "SavedObjectsClientContract" + ], + "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.createEmptyFindResponse.$1", + "id": "def-server.SavedObjectsRequestHandlerContext.getClient.$1", "type": "Object", "tags": [], - "label": "{\n page = FIND_DEFAULT_PAGE,\n perPage = FIND_DEFAULT_PER_PAGE,\n }", + "label": "options", "description": [], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptions", - "text": "SavedObjectsFindOptions" - } + "section": "def-server.SavedObjectsClientProviderOptions", + "text": "SavedObjectsClientProviderOptions" + }, + " | undefined" ], - "path": "src/core/server/saved_objects/service/lib/utils.ts", + "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.generateId", + "id": "def-server.SavedObjectsRequestHandlerContext.getExporter", "type": "Function", "tags": [], - "label": "generateId", - "description": [ - "\nGenerates a random ID for a saved objects." - ], - "signature": [ - "() => string" - ], - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.isRandomId", - "type": "Function", - "tags": [ - "todo" - ], - "label": "isRandomId", - "description": [ - "\nValidates that a saved object ID has been randomly generated.\n" - ], + "label": "getExporter", + "description": [], "signature": [ - "(id: string | undefined) => boolean" + "(client: ", + "SavedObjectsClientContract", + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectsExporter", + "text": "ISavedObjectsExporter" + } ], - "path": "src/core/server/saved_objects/service/lib/utils.ts", + "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.isRandomId.$1", - "type": "string", + "id": "def-server.SavedObjectsRequestHandlerContext.getExporter.$1", + "type": "Object", "tags": [], - "label": "id", - "description": [ - "The ID of a saved object." - ], + "label": "client", + "description": [], "signature": [ - "string | undefined" + "SavedObjectsClientContract" ], - "path": "src/core/server/saved_objects/service/lib/utils.ts", + "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", "deprecated": false, - "isRequired": false + "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.getConvertedObjectId", + "id": "def-server.SavedObjectsRequestHandlerContext.getImporter", "type": "Function", "tags": [], - "label": "getConvertedObjectId", - "description": [ - "\nUses a single-namespace object's \"legacy ID\" to determine what its new ID will be after it is converted to a multi-namespace type.\n" - ], + "label": "getImporter", + "description": [], "signature": [ - "(namespace: string | undefined, type: string, id: string) => string" + "(client: ", + "SavedObjectsClientContract", + ") => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectsImporter", + "text": "ISavedObjectsImporter" + } ], - "path": "src/core/server/saved_objects/service/lib/utils.ts", + "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.getConvertedObjectId.$1", - "type": "string", - "tags": [], - "label": "namespace", - "description": [ - "The namespace of the saved object before it is converted." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "deprecated": false, - "isRequired": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.getConvertedObjectId.$2", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "The type of the saved object before it is converted." - ], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/service/lib/utils.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUtils.getConvertedObjectId.$3", - "type": "string", + "id": "def-server.SavedObjectsRequestHandlerContext.getImporter.$1", + "type": "Object", "tags": [], - "label": "id", - "description": [ - "The ID of the saved object before it is converted." - ], + "label": "client", + "description": [], "signature": [ - "string" + "SavedObjectsClientContract" ], - "path": "src/core/server/saved_objects/service/lib/utils.ts", + "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", "deprecated": false, "isRequired": true } ], - "returnComment": [ - "The ID of the saved object after it is converted." - ] + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry", - "type": "Class", + "id": "def-server.SavedObjectsResolveImportErrorsOptions", + "type": "Interface", "tags": [], - "label": "SavedObjectTypeRegistry", + "label": "SavedObjectsResolveImportErrorsOptions", "description": [ - "\nRegistry holding information about all the registered {@link SavedObjectsType | saved object types}.\n" + "\nOptions to control the \"resolve import\" operation." ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "path": "src/core/server/saved_objects/import/types.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.registerType", - "type": "Function", + "id": "def-server.SavedObjectsResolveImportErrorsOptions.readStream", + "type": "Object", "tags": [], - "label": "registerType", + "label": "readStream", "description": [ - "\nRegister a {@link SavedObjectsType | type} inside the registry.\nA type can only be registered once. subsequent calls with the same type name will throw an error." + "The stream of {@link SavedObject | saved objects} to resolve errors from" ], "signature": [ - "(type: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - ") => void" - ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.registerType.$1", - "type": "Object", - "tags": [], - "label": "type", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "" - ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "deprecated": false, - "isRequired": true - } + "Readable" ], - "returnComment": [] + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getType", - "type": "Function", + "id": "def-server.SavedObjectsResolveImportErrorsOptions.retries", + "type": "Array", "tags": [], - "label": "getType", + "label": "retries", "description": [ - "\nReturn the {@link SavedObjectsType | type} definition for given type name." + "saved object import references to retry" ], "signature": [ - "(type: string) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - " | undefined" + "SavedObjectsImportRetry", + "[]" ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getType.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getVisibleTypes", - "type": "Function", + "id": "def-server.SavedObjectsResolveImportErrorsOptions.namespace", + "type": "string", "tags": [], - "label": "getVisibleTypes", + "label": "namespace", "description": [ - "\nReturns all visible {@link SavedObjectsType | types}.\n\nA visible type is a type that doesn't explicitly define `hidden=true` during registration." + "if specified, will import in given namespace" ], "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]" + "string | undefined" ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getAllTypes", - "type": "Function", + "id": "def-server.SavedObjectsResolveImportErrorsOptions.createNewCopies", + "type": "boolean", "tags": [], - "label": "getAllTypes", + "label": "createNewCopies", "description": [ - "\nReturn all {@link SavedObjectsType | types} currently registered, including the hidden ones.\n\nTo only get the visible types (which is the most common use case), use `getVisibleTypes` instead." - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]" + "If true, will create new copies of import objects, each with a random `id` and undefined `originId`." ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, + "path": "src/core/server/saved_objects/import/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsServiceSetup", + "type": "Interface", + "tags": [], + "label": "SavedObjectsServiceSetup", + "description": [ + "\nSaved Objects is Kibana's data persistence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods\nfor registering Saved Object types, creating and registering Saved Object client wrappers and factories.\n" + ], + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "deprecated": false, + "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getImportableAndExportableTypes", + "id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider", "type": "Function", "tags": [], - "label": "getImportableAndExportableTypes", + "label": "setClientFactoryProvider", "description": [ - "\nReturn all {@link SavedObjectsType | types} currently registered that are importable/exportable." + "\nSet the default {@link SavedObjectsClientFactoryProvider | factory provider} for creating Saved Objects clients.\nOnly one provider can be set, subsequent calls to this method will fail." ], "signature": [ - "() => ", + "(clientFactoryProvider: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "section": "def-server.SavedObjectsClientFactoryProvider", + "text": "SavedObjectsClientFactoryProvider" }, - "[]" - ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic", - "type": "Function", - "tags": [], - "label": "isNamespaceAgnostic", - "description": [ - "\nReturns whether the type is namespace-agnostic (global);\nresolves to `false` if the type is not registered" - ], - "signature": [ - "(type: string) => boolean" + ") => void" ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isNamespaceAgnostic.$1", - "type": "string", + "id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider.$1", + "type": "Function", "tags": [], - "label": "type", + "label": "clientFactoryProvider", "description": [], "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientFactoryProvider", + "text": "SavedObjectsClientFactoryProvider" + } ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "isRequired": true } @@ -7202,94 +5641,72 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace", + "id": "def-server.SavedObjectsServiceSetup.addClientWrapper", "type": "Function", "tags": [], - "label": "isSingleNamespace", + "label": "addClientWrapper", "description": [ - "\nReturns whether the type is single-namespace (isolated);\nresolves to `true` if the type is not registered" + "\nAdd a {@link SavedObjectsClientWrapperFactory | client wrapper factory} with the given priority." ], "signature": [ - "(type: string) => boolean" + "(priority: number, id: string, factory: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientWrapperFactory", + "text": "SavedObjectsClientWrapperFactory" + }, + ") => void" ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isSingleNamespace.$1", - "type": "string", + "id": "def-server.SavedObjectsServiceSetup.addClientWrapper.$1", + "type": "number", "tags": [], - "label": "type", + "label": "priority", "description": [], "signature": [ - "string" + "number" ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace", - "type": "Function", - "tags": [], - "label": "isMultiNamespace", - "description": [ - "\nReturns whether the type is multi-namespace (shareable *or* isolated);\nresolves to `false` if the type is not registered" - ], - "signature": [ - "(type: string) => boolean" - ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isMultiNamespace.$1", + "id": "def-server.SavedObjectsServiceSetup.addClientWrapper.$2", "type": "string", "tags": [], - "label": "type", + "label": "id", "description": [], "signature": [ "string" ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isShareable", - "type": "Function", - "tags": [], - "label": "isShareable", - "description": [ - "\nReturns whether the type is multi-namespace (shareable);\nresolves to `false` if the type is not registered" - ], - "signature": [ - "(type: string) => boolean" - ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isShareable.$1", - "type": "string", + "id": "def-server.SavedObjectsServiceSetup.addClientWrapper.$3", + "type": "Function", "tags": [], - "label": "type", + "label": "factory", "description": [], "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsClientWrapperFactory", + "text": "SavedObjectsClientWrapperFactory" + } ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "isRequired": true } @@ -7298,30 +5715,47 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isHidden", + "id": "def-server.SavedObjectsServiceSetup.registerType", "type": "Function", "tags": [], - "label": "isHidden", + "label": "registerType", "description": [ - "\nReturns the `hidden` property for given type, or `false` if\nthe type is not registered." + "\nRegister a {@link SavedObjectsType | savedObjects type} definition.\n\nSee the {@link SavedObjectsTypeMappingDefinition | mappings format} and\n{@link SavedObjectMigrationMap | migration format} for more details about these.\n" ], "signature": [ - "(type: string) => boolean" + "(type: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + ") => void" ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isHidden.$1", - "type": "string", + "id": "def-server.SavedObjectsServiceSetup.registerType.$1", + "type": "Object", "tags": [], "label": "type", "description": [], "signature": [ - "string" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" + }, + "" ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "isRequired": true } @@ -7330,199 +5764,80 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getIndex", - "type": "Function", - "tags": [], - "label": "getIndex", - "description": [ - "\nReturns the `indexPattern` property for given type, or `undefined` if\nthe type is not registered." - ], - "signature": [ - "(type: string) => string | undefined" - ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.getIndex.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable", + "id": "def-server.SavedObjectsServiceSetup.getKibanaIndex", "type": "Function", "tags": [], - "label": "isImportableAndExportable", + "label": "getKibanaIndex", "description": [ - "\nReturns the `management.importableAndExportable` property for given type, or\n`false` if the type is not registered or does not define a management section." + "\nReturns the default index used for saved objects." ], "signature": [ - "(type: string) => boolean" + "() => string" ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectTypeRegistry.isImportableAndExportable.$1", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "deprecated": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] } ], "initialIsOpen": false - } - ], - "functions": [ - { - "parentPluginId": "core", - "id": "def-server.mergeSavedObjectMigrationMaps", - "type": "Function", - "tags": [], - "label": "mergeSavedObjectMigrationMaps", - "description": [ - "\nMerges two saved object migration maps.\n\nIf there is a migration for a given version on only one of the maps,\nthat migration function will be used:\n\nmergeSavedObjectMigrationMaps({ '1.2.3': f }, { '4.5.6': g }) -> { '1.2.3': f, '4.5.6': g }\n\nIf there is a migration for a given version on both maps, the migrations will be composed:\n\nmergeSavedObjectMigrationMaps({ '1.2.3': f }, { '1.2.3': g }) -> { '1.2.3': (doc, context) => f(g(doc, context), context) }\n" - ], - "signature": [ - "(map1: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" - }, - ", map2: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" - } - ], - "path": "src/core/server/saved_objects/migrations/utils.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.mergeSavedObjectMigrationMaps.$1", - "type": "Object", - "tags": [], - "label": "map1", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" - } - ], - "path": "src/core/server/saved_objects/migrations/utils.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.mergeSavedObjectMigrationMaps.$2", - "type": "Object", - "tags": [], - "label": "map2", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" - } - ], - "path": "src/core/server/saved_objects/migrations/utils.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ + }, { "parentPluginId": "core", - "id": "def-server.ISavedObjectsExporter", + "id": "def-server.SavedObjectsServiceStart", "type": "Interface", "tags": [], - "label": "ISavedObjectsExporter", + "label": "SavedObjectsServiceStart", "description": [ - "\nUtility class used to export savedObjects.\n" + "\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The\nSavedObjectsServiceStart API provides a scoped Saved Objects client for\ninteracting with Saved Objects.\n" ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ISavedObjectsExporter.exportByTypes", + "id": "def-server.SavedObjectsServiceStart.getScopedClient", "type": "Function", - "tags": [ - "throws" - ], - "label": "exportByTypes", + "tags": [], + "label": "getScopedClient", "description": [ - "\nGenerates an export stream for given types.\n\nSee the {@link SavedObjectsExportByTypeOptions | options} for more detailed information.\n" + "\nCreates a {@link SavedObjectsClientContract | Saved Objects client} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch. If other plugins have registered Saved Objects client\nwrappers, these will be applied to extend the functionality of the client.\n\nA client that is already scoped to the incoming request is also exposed\nfrom the route handler context see {@link RequestHandlerContext}." ], "signature": [ - "(options: ", + "(req: ", + "KibanaRequest", + ", options?: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByTypeOptions", - "text": "SavedObjectsExportByTypeOptions" + "section": "def-server.SavedObjectsClientProviderOptions", + "text": "SavedObjectsClientProviderOptions" }, - ") => Promise<", - "Readable", - ">" + " | undefined) => ", + "SavedObjectsClientContract" ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ISavedObjectsExporter.exportByTypes.$1", + "id": "def-server.SavedObjectsServiceStart.getScopedClient.$1", + "type": "Object", + "tags": [], + "label": "req", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsServiceStart.getScopedClient.$2", "type": "Object", "tags": [], "label": "options", @@ -7532,7381 +5847,762 @@ "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByTypeOptions", - "text": "SavedObjectsExportByTypeOptions" - } + "section": "def-server.SavedObjectsClientProviderOptions", + "text": "SavedObjectsClientProviderOptions" + }, + " | undefined" ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.ISavedObjectsExporter.exportByObjects", + "id": "def-server.SavedObjectsServiceStart.createScopedRepository", "type": "Function", - "tags": [ - "throws" - ], - "label": "exportByObjects", + "tags": [], + "label": "createScopedRepository", "description": [ - "\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n" + "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n" ], "signature": [ - "(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByObjectOptions", - "text": "SavedObjectsExportByObjectOptions" - }, - ") => Promise<", - "Readable", - ">" + "(req: ", + "KibanaRequest", + ", includedHiddenTypes?: string[] | undefined) => ", + "ISavedObjectsRepository" ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ISavedObjectsExporter.exportByObjects.$1", + "id": "def-server.SavedObjectsServiceStart.createScopedRepository.$1", "type": "Object", "tags": [], - "label": "options", - "description": [], + "label": "req", + "description": [ + "- The request to create the scoped repository from." + ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByObjectOptions", - "text": "SavedObjectsExportByObjectOptions" - } + "KibanaRequest", + "" ], - "path": "src/core/server/saved_objects/export/saved_objects_exporter.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ISavedObjectsImporter", - "type": "Interface", - "tags": [], - "label": "ISavedObjectsImporter", - "description": [ - "\nUtility class used to import savedObjects.\n" - ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", - "deprecated": false, - "children": [ + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsServiceStart.createScopedRepository.$2", + "type": "Array", + "tags": [], + "label": "includedHiddenTypes", + "description": [ + "- A list of additional hidden types the repository should have access to." + ], + "signature": [ + "string[] | undefined" + ], + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, { "parentPluginId": "core", - "id": "def-server.ISavedObjectsImporter.import", + "id": "def-server.SavedObjectsServiceStart.createInternalRepository", "type": "Function", - "tags": [ - "throws" - ], - "label": "import", + "tags": [], + "label": "createInternalRepository", "description": [ - "\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n" + "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" ], "signature": [ - "(options: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportOptions", - "text": "SavedObjectsImportOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" - }, - ">" + "(includedHiddenTypes?: string[] | undefined) => ", + "ISavedObjectsRepository" ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ISavedObjectsImporter.import.$1", - "type": "Object", + "id": "def-server.SavedObjectsServiceStart.createInternalRepository.$1", + "type": "Array", "tags": [], - "label": "options", - "description": [], + "label": "includedHiddenTypes", + "description": [ + "- A list of additional hidden types the repository should have access to." + ], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportOptions", - "text": "SavedObjectsImportOptions" - } + "string[] | undefined" ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "isRequired": true + "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.ISavedObjectsImporter.resolveImportErrors", + "id": "def-server.SavedObjectsServiceStart.createSerializer", "type": "Function", - "tags": [ - "throws" - ], - "label": "resolveImportErrors", + "tags": [], + "label": "createSerializer", "description": [ - "\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed information.\n" + "\nCreates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types." ], "signature": [ - "(options: ", + "() => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveImportErrorsOptions", - "text": "SavedObjectsResolveImportErrorsOptions" - }, - ") => Promise<", + "section": "def-server.SavedObjectsSerializer", + "text": "SavedObjectsSerializer" + } + ], + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsServiceStart.createExporter", + "type": "Function", + "tags": [], + "label": "createExporter", + "description": [ + "\nCreates an {@link ISavedObjectsExporter | exporter} bound to given client." + ], + "signature": [ + "(client: ", + "SavedObjectsClientContract", + ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" - }, - ">" + "section": "def-server.ISavedObjectsExporter", + "text": "ISavedObjectsExporter" + } ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "children": [ { "parentPluginId": "core", - "id": "def-server.ISavedObjectsImporter.resolveImportErrors.$1", + "id": "def-server.SavedObjectsServiceStart.createExporter.$1", "type": "Object", "tags": [], - "label": "options", + "label": "client", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveImportErrorsOptions", - "text": "SavedObjectsResolveImportErrorsOptions" - } + "SavedObjectsClientContract" ], - "path": "src/core/server/saved_objects/import/saved_objects_importer.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, "isRequired": true } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.ISavedObjectsPointInTimeFinder", - "type": "Interface", - "tags": [], - "label": "ISavedObjectsPointInTimeFinder", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" }, - "" - ], - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "deprecated": false, - "children": [ { "parentPluginId": "core", - "id": "def-server.ISavedObjectsPointInTimeFinder.find", + "id": "def-server.SavedObjectsServiceStart.createImporter", "type": "Function", "tags": [], - "label": "find", + "label": "createImporter", "description": [ - "\nAn async generator which wraps calls to `savedObjectsClient.find` and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a set\nof results is received that's smaller than the designated `perPage` size." + "\nCreates an {@link ISavedObjectsImporter | importer} bound to given client." ], "signature": [ - "() => AsyncGenerator<", + "(client: ", + "SavedObjectsClientContract", + ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - ", any, unknown>" + "section": "def-server.ISavedObjectsImporter", + "text": "ISavedObjectsImporter" + } ], - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsServiceStart.createImporter.$1", + "type": "Object", + "tags": [], + "label": "client", + "description": [], + "signature": [ + "SavedObjectsClientContract" + ], + "path": "src/core/server/saved_objects/saved_objects_service.ts", + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { "parentPluginId": "core", - "id": "def-server.ISavedObjectsPointInTimeFinder.close", + "id": "def-server.SavedObjectsServiceStart.getTypeRegistry", "type": "Function", "tags": [], - "label": "close", + "label": "getTypeRegistry", "description": [ - "\nCloses the Point-In-Time associated with this finder instance.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason." + "\nReturns the {@link ISavedObjectTypeRegistry | registry} containing all registered\n{@link SavedObjectsType | saved object types}" ], "signature": [ - "() => Promise" + "() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.ISavedObjectTypeRegistry", + "text": "ISavedObjectTypeRegistry" + } ], - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", + "path": "src/core/server/saved_objects/saved_objects_service.ts", "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectExportBaseOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectExportBaseOptions", - "description": [], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectExportBaseOptions.request", - "type": "Object", - "tags": [], - "label": "request", - "description": [ - "The http request initiating the export." - ], - "signature": [ - "KibanaRequest", - "" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectExportBaseOptions.includeReferencesDeep", - "type": "CompoundType", - "tags": [], - "label": "includeReferencesDeep", - "description": [ - "flag to also include all related saved objects in the export stream." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectExportBaseOptions.includeNamespaces", - "type": "CompoundType", - "tags": [], - "label": "includeNamespaces", - "description": [ - "\nFlag to also include namespace information in the export stream. By default, namespace information is not included in exported objects.\nThis is only intended to be used internally during copy-to-space operations, and it is not exposed as an option for the external HTTP\nroute for exports." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectExportBaseOptions.excludeExportDetails", - "type": "CompoundType", - "tags": [], - "label": "excludeExportDetails", - "description": [ - "flag to not append {@link SavedObjectsExportResultDetails | export details} to the end of the export stream." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectExportBaseOptions.namespace", - "type": "string", - "tags": [], - "label": "namespace", - "description": [ - "optional namespace to override the namespace used by the savedObjectsClient." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationContext", - "type": "Interface", - "tags": [], - "label": "SavedObjectMigrationContext", - "description": [ - "\nMigration context provided when invoking a {@link SavedObjectMigrationFn | migration handler}\n" - ], - "path": "src/core/server/saved_objects/migrations/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationContext.log", - "type": "Object", - "tags": [], - "label": "log", - "description": [ - "\nlogger instance to be used by the migration handler" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsMigrationLogger", - "text": "SavedObjectsMigrationLogger" - } - ], - "path": "src/core/server/saved_objects/migrations/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationContext.migrationVersion", - "type": "string", - "tags": [], - "label": "migrationVersion", - "description": [ - "\nThe migration version that this migration function is defined for" - ], - "path": "src/core/server/saved_objects/migrations/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion", - "type": "string", - "tags": [], - "label": "convertToMultiNamespaceTypeVersion", - "description": [ - "\nThe version in which this object type is being converted to a multi-namespace type" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/migrations/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationContext.isSingleNamespaceType", - "type": "boolean", - "tags": [], - "label": "isSingleNamespaceType", - "description": [ - "\nWhether this is a single-namespace type or not" - ], - "path": "src/core/server/saved_objects/migrations/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationMap", - "type": "Interface", - "tags": [], - "label": "SavedObjectMigrationMap", - "description": [ - "\nA map of {@link SavedObjectMigrationFn | migration functions} to be used for a given type.\nThe map's keys must be valid semver versions, and they cannot exceed the current Kibana version.\n\nFor a given document, only migrations with a higher version number than that of the document will be applied.\nMigrations are executed in order, starting from the lowest version and ending with the highest one.\n" - ], - "path": "src/core/server/saved_objects/migrations/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationMap.Unnamed", - "type": "IndexSignature", - "tags": [], - "label": "[version: string]: SavedObjectMigrationFn", - "description": [], - "signature": [ - "[version: string]: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationFn", - "text": "SavedObjectMigrationFn" - }, - "" - ], - "path": "src/core/server/saved_objects/migrations/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext", - "type": "Interface", - "tags": [], - "label": "SavedObjectReferenceWithContext", - "description": [ - "\nA returned input object or one of its references, with additional context.\n" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "The type of the referenced object" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "The ID of the referenced object" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.originId", - "type": "string", - "tags": [], - "label": "originId", - "description": [ - "The origin ID of the referenced object (if it has one)" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.spaces", - "type": "Array", - "tags": [], - "label": "spaces", - "description": [ - "The space(s) that the referenced object exists in" - ], - "signature": [ - "string[]" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.inboundReferences", - "type": "Array", - "tags": [], - "label": "inboundReferences", - "description": [ - "\nReferences to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains\ninbound references for the scope of this operation" - ], - "signature": [ - "{ type: string; id: string; name: string; }[]" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.isMissing", - "type": "CompoundType", - "tags": [], - "label": "isMissing", - "description": [ - "Whether or not this object or reference is missing" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.spacesWithMatchingAliases", - "type": "Array", - "tags": [], - "label": "spacesWithMatchingAliases", - "description": [ - "The space(s) that legacy URL aliases matching this type/id exist in" - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectReferenceWithContext.spacesWithMatchingOrigins", - "type": "Array", - "tags": [], - "label": "spacesWithMatchingOrigins", - "description": [ - "The space(s) that objects matching this origin exist in (including this one)" - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBaseOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBaseOptions", - "description": [ - "\n" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBaseOptions.namespace", - "type": "string", - "tags": [], - "label": "namespace", - "description": [ - "Specify the namespace for this operation" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkCreateObject", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.attributes", - "type": "Uncategorized", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "T" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [], - "signature": [ - "SavedObjectReference", - "[] | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.migrationVersion", - "type": "Object", - "tags": [], - "label": "migrationVersion", - "description": [ - "{@inheritDoc SavedObjectsMigrationVersion}" - ], - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.coreMigrationVersion", - "type": "string", - "tags": [], - "label": "coreMigrationVersion", - "description": [ - "\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.originId", - "type": "string", - "tags": [], - "label": "originId", - "description": [ - "Optional ID of the original saved object, if this object's `id` was regenerated" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkCreateObject.initialNamespaces", - "type": "Array", - "tags": [], - "label": "initialNamespaces", - "description": [ - "\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkGetObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkGetObject", - "description": [ - "\n" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkGetObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkGetObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkGetObject.fields", - "type": "Array", - "tags": [], - "label": "fields", - "description": [ - "SavedObject fields to include in the response" - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkGetObject.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [ - "\nOptional namespace(s) for the object to be retrieved in. If this is defined, it will supersede the namespace ID that is in the\ntop-level options.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkResolveObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkResolveObject", - "description": [ - "\n" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkResolveObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkResolveObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkResolveResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkResolveResponse", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - "" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkResolveResponse.resolved_objects", - "type": "Array", - "tags": [], - "label": "resolved_objects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkResponse", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - "" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkResponse.saved_objects", - "type": "Array", - "tags": [], - "label": "saved_objects", - "description": [], - "signature": [ - "SavedObject", - "[]" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkResponse", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - "" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkResponse.saved_objects", - "type": "Array", - "tags": [], - "label": "saved_objects", - "description": [], - "signature": [ - "SavedObject", - "[]" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkUpdateObject", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - " extends Pick<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ", \"version\" | \"references\">" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - " The type of this Saved Object. Each plugin can define it's own custom Saved Object types." - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateObject.attributes", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [ - "{@inheritdoc SavedObjectAttributes}" - ], - "signature": [ - "{ [P in keyof T]?: T[P] | undefined; }" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateObject.namespace", - "type": "string", - "tags": [], - "label": "namespace", - "description": [ - "\nOptional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsBulkUpdateOptions}.\n\nNote: the default namespace's string representation is `'default'`, and its ID representation is `undefined`." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkUpdateOptions", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateOptions.refresh", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [ - "The Elasticsearch Refresh setting for this operation" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.MutatingOperationRefreshSetting", - "text": "MutatingOperationRefreshSetting" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsBulkUpdateResponse", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - "" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsBulkUpdateResponse.saved_objects", - "type": "Array", - "tags": [], - "label": "saved_objects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCheckConflictsObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCheckConflictsObject", - "description": [ - "\n" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCheckConflictsObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCheckConflictsObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCheckConflictsResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCheckConflictsResponse", - "description": [ - "\n" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCheckConflictsResponse.errors", - "type": "Array", - "tags": [], - "label": "errors", - "description": [], - "signature": [ - "{ id: string; type: string; error: ", - "SavedObjectError", - "; }[]" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientProviderOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsClientProviderOptions", - "description": [ - "\nOptions to control the creation of the Saved Objects Client." - ], - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientProviderOptions.excludedWrappers", - "type": "Array", - "tags": [], - "label": "excludedWrappers", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientProviderOptions.includedHiddenTypes", - "type": "Array", - "tags": [], - "label": "includedHiddenTypes", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientWrapperOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsClientWrapperOptions", - "description": [ - "\nOptions passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance." - ], - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientWrapperOptions.client", - "type": "Object", - "tags": [], - "label": "client", - "description": [], - "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" - ], - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientWrapperOptions.typeRegistry", - "type": "Object", - "tags": [], - "label": "typeRegistry", - "description": [], - "signature": [ - "{ isHidden: (type: string) => boolean; getType: (type: string) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - " | undefined; getVisibleTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; getAllTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; getImportableAndExportableTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" - ], - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientWrapperOptions.request", - "type": "Object", - "tags": [], - "label": "request", - "description": [], - "signature": [ - "KibanaRequest", - "" - ], - "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClosePointInTimeResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsClosePointInTimeResponse", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClosePointInTimeResponse.succeeded", - "type": "boolean", - "tags": [], - "label": "succeeded", - "description": [ - "\nIf true, all search contexts associated with the PIT id are\nsuccessfully closed." - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClosePointInTimeResponse.num_freed", - "type": "number", - "tags": [], - "label": "num_freed", - "description": [ - "\nThe number of search contexts that have been successfully closed." - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCollectMultiNamespaceReferencesObject", - "description": [ - "\nAn object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the\n`namespaceType: 'multiple'` or `namespaceType: 'multiple-isolated'` option).\n\nNote: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with\nthe `namespaceType: 'multiple'`).\n" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCollectMultiNamespaceReferencesOptions", - "description": [ - "\nOptions for collecting references.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", - "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions.purpose", - "type": "CompoundType", - "tags": [], - "label": "purpose", - "description": [ - "Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences'" - ], - "signature": [ - "\"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCollectMultiNamespaceReferencesResponse", - "description": [ - "\nThe response when object references are collected.\n" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse.objects", - "type": "Array", - "tags": [], - "label": "objects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectReferenceWithContext", - "text": "SavedObjectReferenceWithContext" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCreateOptions", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "(not recommended) Specify an id for the document" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.overwrite", - "type": "CompoundType", - "tags": [], - "label": "overwrite", - "description": [ - "Overwrite existing documents (defaults to false)" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "\nAn opaque version number which changes on each successful write operation.\nCan be used in conjunction with `overwrite` for implementing optimistic concurrency control." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.migrationVersion", - "type": "Object", - "tags": [], - "label": "migrationVersion", - "description": [ - "{@inheritDoc SavedObjectsMigrationVersion}" - ], - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.coreMigrationVersion", - "type": "string", - "tags": [], - "label": "coreMigrationVersion", - "description": [ - "\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [], - "signature": [ - "SavedObjectReference", - "[] | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.refresh", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [ - "The Elasticsearch Refresh setting for this operation" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.MutatingOperationRefreshSetting", - "text": "MutatingOperationRefreshSetting" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.originId", - "type": "string", - "tags": [], - "label": "originId", - "description": [ - "Optional ID of the original saved object, if this object's `id` was regenerated" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreateOptions.initialNamespaces", - "type": "Array", - "tags": [], - "label": "initialNamespaces", - "description": [ - "\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "type": "Interface", - "tags": [], - "label": "SavedObjectsCreatePointInTimeFinderDependencies", - "description": [], - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies.client", - "type": "Object", - "tags": [], - "label": "client", - "description": [], - "signature": [ - "{ find: (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" - }, - ">; 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" - }, - ">; }" - ], - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsDeleteByNamespaceOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsDeleteByNamespaceOptions", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteByNamespaceOptions", - "text": "SavedObjectsDeleteByNamespaceOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsDeleteByNamespaceOptions.refresh", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [ - "The Elasticsearch supports only boolean flag for this operation" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsDeleteOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsDeleteOptions", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteOptions", - "text": "SavedObjectsDeleteOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsDeleteOptions.refresh", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [ - "The Elasticsearch Refresh setting for this operation" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.MutatingOperationRefreshSetting", - "text": "MutatingOperationRefreshSetting" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsDeleteOptions.force", - "type": "CompoundType", - "tags": [], - "label": "force", - "description": [ - "Force deletion of an object that exists in multiple namespaces" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportByObjectOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsExportByObjectOptions", - "description": [ - "\nOptions for the {@link ISavedObjectsExporter.exportByObjects | export by objects API}\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByObjectOptions", - "text": "SavedObjectsExportByObjectOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectExportBaseOptions", - "text": "SavedObjectExportBaseOptions" - } - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportByObjectOptions.objects", - "type": "Array", - "tags": [], - "label": "objects", - "description": [ - "optional array of objects to export." - ], - "signature": [ - "{ id: string; type: string; }[]" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportByTypeOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsExportByTypeOptions", - "description": [ - "\nOptions for the {@link ISavedObjectsExporter.exportByTypes | export by type API}\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportByTypeOptions", - "text": "SavedObjectsExportByTypeOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectExportBaseOptions", - "text": "SavedObjectExportBaseOptions" - } - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportByTypeOptions.types", - "type": "Array", - "tags": [], - "label": "types", - "description": [ - "array of saved object types." - ], - "signature": [ - "string[]" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportByTypeOptions.hasReference", - "type": "Array", - "tags": [], - "label": "hasReference", - "description": [ - "optional array of references to search object for." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, - "[] | undefined" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportByTypeOptions.search", - "type": "string", - "tags": [], - "label": "search", - "description": [ - "optional query string to filter exported objects." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportExcludedObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsExportExcludedObject", - "description": [], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportExcludedObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "id of the excluded object" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportExcludedObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "type of the excluded object" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportExcludedObject.reason", - "type": "string", - "tags": [], - "label": "reason", - "description": [ - "optional cause of the exclusion" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportResultDetails", - "type": "Interface", - "tags": [], - "label": "SavedObjectsExportResultDetails", - "description": [ - "\nStructure of the export result details entry" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportResultDetails.exportedCount", - "type": "number", - "tags": [], - "label": "exportedCount", - "description": [ - "number of successfully exported objects" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportResultDetails.missingRefCount", - "type": "number", - "tags": [], - "label": "missingRefCount", - "description": [ - "number of missing references" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportResultDetails.missingReferences", - "type": "Array", - "tags": [], - "label": "missingReferences", - "description": [ - "missing references details" - ], - "signature": [ - "{ id: string; type: string; }[]" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportResultDetails.excludedObjectsCount", - "type": "number", - "tags": [], - "label": "excludedObjectsCount", - "description": [ - "number of objects that were excluded from the export" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportResultDetails.excludedObjects", - "type": "Array", - "tags": [], - "label": "excludedObjects", - "description": [ - "excluded objects details" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportExcludedObject", - "text": "SavedObjectsExportExcludedObject" - }, - "[]" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportTransformContext", - "type": "Interface", - "tags": [], - "label": "SavedObjectsExportTransformContext", - "description": [ - "\nContext passed down to a {@link SavedObjectsExportTransform | export transform function}\n" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsExportTransformContext.request", - "type": "Object", - "tags": [], - "label": "request", - "description": [ - "\nThe request that initiated the export request. Can be used to create scoped\nservices or client inside the {@link SavedObjectsExportTransform | transformation}" - ], - "signature": [ - "KibanaRequest", - "" - ], - "path": "src/core/server/saved_objects/export/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsFindOptions", - "description": [ - "\n" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | string[]" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.page", - "type": "number", - "tags": [], - "label": "page", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.perPage", - "type": "number", - "tags": [], - "label": "perPage", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.sortField", - "type": "string", - "tags": [], - "label": "sortField", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.sortOrder", - "type": "CompoundType", - "tags": [], - "label": "sortOrder", - "description": [], - "signature": [ - "SortOrder", - " | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.fields", - "type": "Array", - "tags": [], - "label": "fields", - "description": [ - "\nAn array of fields to include in the results" - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.search", - "type": "string", - "tags": [], - "label": "search", - "description": [ - "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.searchFields", - "type": "Array", - "tags": [], - "label": "searchFields", - "description": [ - "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.searchAfter", - "type": "Array", - "tags": [], - "label": "searchAfter", - "description": [ - "\nUse the sort values from the previous page to retrieve the next page of results." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.rootSearchFields", - "type": "Array", - "tags": [], - "label": "rootSearchFields", - "description": [ - "\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.hasReference", - "type": "CompoundType", - "tags": [], - "label": "hasReference", - "description": [ - "\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, - "[] | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.hasReferenceOperator", - "type": "CompoundType", - "tags": [], - "label": "hasReferenceOperator", - "description": [ - "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" - ], - "signature": [ - "\"AND\" | \"OR\" | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.defaultSearchOperator", - "type": "CompoundType", - "tags": [], - "label": "defaultSearchOperator", - "description": [ - "\nThe search operator to use with the provided filter. Defaults to `OR`" - ], - "signature": [ - "\"AND\" | \"OR\" | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.filter", - "type": "Any", - "tags": [], - "label": "filter", - "description": [], - "signature": [ - "any" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.aggs", - "type": "Object", - "tags": [ - "alpha" - ], - "label": "aggs", - "description": [ - "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" - ], - "signature": [ - "Record | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.typeToNamespacesMap", - "type": "Object", - "tags": [], - "label": "typeToNamespacesMap", - "description": [ - "\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace." - ], - "signature": [ - "Map | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.preference", - "type": "string", - "tags": [], - "label": "preference", - "description": [ - "An optional ES preference value to be used for the query" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptions.pit", - "type": "Object", - "tags": [], - "label": "pit", - "description": [ - "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsPitParams", - "text": "SavedObjectsPitParams" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptionsReference", - "type": "Interface", - "tags": [], - "label": "SavedObjectsFindOptionsReference", - "description": [], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptionsReference.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindOptionsReference.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsFindResponse", - "description": [ - "\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResponse", - "text": "SavedObjectsFindResponse" - }, - "" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse.aggregations", - "type": "Uncategorized", - "tags": [], - "label": "aggregations", - "description": [], - "signature": [ - "A | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse.saved_objects", - "type": "Array", - "tags": [], - "label": "saved_objects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResult", - "text": "SavedObjectsFindResult" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse.total", - "type": "number", - "tags": [], - "label": "total", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse.per_page", - "type": "number", - "tags": [], - "label": "per_page", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse.page", - "type": "number", - "tags": [], - "label": "page", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResponse.pit_id", - "type": "string", - "tags": [], - "label": "pit_id", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResult", - "type": "Interface", - "tags": [], - "label": "SavedObjectsFindResult", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindResult", - "text": "SavedObjectsFindResult" - }, - " extends ", - "SavedObject", - "" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResult.score", - "type": "number", - "tags": [], - "label": "score", - "description": [ - "\nThe Elasticsearch `_score` of this result." - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsFindResult.sort", - "type": "Array", - "tags": [], - "label": "sort", - "description": [ - "\nThe Elasticsearch `sort` value of this result.\n" - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportActionRequiredWarning", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportActionRequiredWarning", - "description": [ - "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportActionRequiredWarning.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"action_required\"" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportActionRequiredWarning.message", - "type": "string", - "tags": [], - "label": "message", - "description": [ - "The translated message to display to the user." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportActionRequiredWarning.actionPath", - "type": "string", - "tags": [], - "label": "actionPath", - "description": [ - "The path (without the basePath) that the user should be redirect to address this warning." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportActionRequiredWarning.buttonLabel", - "type": "string", - "tags": [], - "label": "buttonLabel", - "description": [ - "An optional label to use for the link button. If unspecified, a default label will be used." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportAmbiguousConflictError", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportAmbiguousConflictError", - "description": [ - "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportAmbiguousConflictError.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"ambiguous_conflict\"" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportAmbiguousConflictError.destinations", - "type": "Array", - "tags": [], - "label": "destinations", - "description": [], - "signature": [ - "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportConflictError", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportConflictError", - "description": [ - "\nRepresents a failure to import due to a conflict." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportConflictError.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"conflict\"" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportConflictError.destinationId", - "type": "string", - "tags": [], - "label": "destinationId", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportFailure", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportFailure", - "description": [ - "\nRepresents a failure to import." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportFailure.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportFailure.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportFailure.meta", - "type": "Object", - "tags": [], - "label": "meta", - "description": [], - "signature": [ - "{ title?: string | undefined; icon?: string | undefined; }" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportFailure.overwrite", - "type": "CompoundType", - "tags": [], - "label": "overwrite", - "description": [ - "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportFailure.error", - "type": "CompoundType", - "tags": [], - "label": "error", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportConflictError", - "text": "SavedObjectsImportConflictError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportAmbiguousConflictError", - "text": "SavedObjectsImportAmbiguousConflictError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportUnsupportedTypeError", - "text": "SavedObjectsImportUnsupportedTypeError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportMissingReferencesError", - "text": "SavedObjectsImportMissingReferencesError" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportUnknownError", - "text": "SavedObjectsImportUnknownError" - } - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportHookResult", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportHookResult", - "description": [ - "\nResult from a {@link SavedObjectsImportHook | import hook}\n" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportHookResult.warnings", - "type": "Array", - "tags": [], - "label": "warnings", - "description": [ - "\nAn optional list of warnings to display in the UI when the import succeeds." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportWarning", - "text": "SavedObjectsImportWarning" - }, - "[] | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportMissingReferencesError", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportMissingReferencesError", - "description": [ - "\nRepresents a failure to import due to missing references." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportMissingReferencesError.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"missing_references\"" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportMissingReferencesError.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [], - "signature": [ - "{ type: string; id: string; }[]" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportOptions", - "description": [ - "\nOptions to control the import operation." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportOptions.readStream", - "type": "Object", - "tags": [], - "label": "readStream", - "description": [ - "The stream of {@link SavedObject | saved objects} to import" - ], - "signature": [ - "Readable" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportOptions.overwrite", - "type": "boolean", - "tags": [], - "label": "overwrite", - "description": [ - "If true, will override existing object if present. Note: this has no effect when used with the `createNewCopies` option." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportOptions.namespace", - "type": "string", - "tags": [], - "label": "namespace", - "description": [ - "if specified, will import in given namespace, else will import as global object" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportOptions.createNewCopies", - "type": "boolean", - "tags": [], - "label": "createNewCopies", - "description": [ - "If true, will create new copies of import objects, each with a random `id` and undefined `originId`." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportOptions.refresh", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [ - "Refresh setting, defaults to `wait_for`" - ], - "signature": [ - "boolean | \"wait_for\" | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportResponse", - "description": [ - "\nThe response describing the result of an import." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportResponse.success", - "type": "boolean", - "tags": [], - "label": "success", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportResponse.successCount", - "type": "number", - "tags": [], - "label": "successCount", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportResponse.successResults", - "type": "Array", - "tags": [], - "label": "successResults", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportSuccess", - "text": "SavedObjectsImportSuccess" - }, - "[] | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportResponse.warnings", - "type": "Array", - "tags": [], - "label": "warnings", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportWarning", - "text": "SavedObjectsImportWarning" - }, - "[]" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportResponse.errors", - "type": "Array", - "tags": [], - "label": "errors", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportFailure", - "text": "SavedObjectsImportFailure" - }, - "[] | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportRetry", - "description": [ - "\nDescribes a retry operation for importing a saved object." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.overwrite", - "type": "boolean", - "tags": [], - "label": "overwrite", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.destinationId", - "type": "string", - "tags": [], - "label": "destinationId", - "description": [ - "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.replaceReferences", - "type": "Array", - "tags": [], - "label": "replaceReferences", - "description": [], - "signature": [ - "{ type: string; from: string; to: string; }[]" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.createNewCopy", - "type": "CompoundType", - "tags": [], - "label": "createNewCopy", - "description": [ - "\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportRetry.ignoreMissingReferences", - "type": "CompoundType", - "tags": [], - "label": "ignoreMissingReferences", - "description": [ - "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSimpleWarning", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportSimpleWarning", - "description": [ - "\nA simple informative warning that will be displayed to the user.\n" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSimpleWarning.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"simple\"" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSimpleWarning.message", - "type": "string", - "tags": [], - "label": "message", - "description": [ - "The translated message to display to the user" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportSuccess", - "description": [ - "\nRepresents a successful import." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess.destinationId", - "type": "string", - "tags": [], - "label": "destinationId", - "description": [ - "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess.createNewCopy", - "type": "CompoundType", - "tags": [ - "deprecated" - ], - "label": "createNewCopy", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": true, - "references": [ - { - "plugin": "spaces", - "path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/components/copy_to_space_flyout_internal.tsx" - }, - { - "plugin": "savedObjectsManagement", - "path": "src/plugins/saved_objects_management/public/lib/resolve_import_errors.ts" - } - ] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess.meta", - "type": "Object", - "tags": [], - "label": "meta", - "description": [], - "signature": [ - "{ title?: string | undefined; icon?: string | undefined; }" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportSuccess.overwrite", - "type": "CompoundType", - "tags": [], - "label": "overwrite", - "description": [ - "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportUnknownError", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportUnknownError", - "description": [ - "\nRepresents a failure to import due to an unknown reason." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportUnknownError.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"unknown\"" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportUnknownError.message", - "type": "string", - "tags": [], - "label": "message", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportUnknownError.statusCode", - "type": "number", - "tags": [], - "label": "statusCode", - "description": [], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportUnsupportedTypeError", - "type": "Interface", - "tags": [], - "label": "SavedObjectsImportUnsupportedTypeError", - "description": [ - "\nRepresents a failure to import due to having an unsupported saved object type." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportUnsupportedTypeError.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"unsupported_type\"" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterField", - "type": "Interface", - "tags": [], - "label": "SavedObjectsIncrementCounterField", - "description": [], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterField.fieldName", - "type": "string", - "tags": [], - "label": "fieldName", - "description": [ - "The field name to increment the counter by." - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterField.incrementBy", - "type": "number", - "tags": [], - "label": "incrementBy", - "description": [ - "The number to increment the field by (defaults to 1)." - ], - "signature": [ - "number | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsIncrementCounterOptions", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterOptions", - "text": "SavedObjectsIncrementCounterOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterOptions.initialize", - "type": "CompoundType", - "tags": [], - "label": "initialize", - "description": [ - "\n(default=false) If true, sets all the counter fields to 0 if they don't\nalready exist. Existing fields will be left as-is and won't be incremented." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion", - "type": "Object", - "tags": [], - "label": "migrationVersion", - "description": [ - "{@link SavedObjectsMigrationVersion}" - ], - "signature": [ - "SavedObjectsMigrationVersion", - " | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterOptions.refresh", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [ - "\n(default='wait_for') The Elasticsearch refresh setting for this\noperation. See {@link MutatingOperationRefreshSetting}" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.MutatingOperationRefreshSetting", - "text": "MutatingOperationRefreshSetting" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsIncrementCounterOptions.upsertAttributes", - "type": "Uncategorized", - "tags": [], - "label": "upsertAttributes", - "description": [ - "\nAttributes to use when upserting the document if it doesn't exist." - ], - "signature": [ - "Attributes | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMappingProperties", - "type": "Interface", - "tags": [], - "label": "SavedObjectsMappingProperties", - "description": [ - "\nDescribe the fields of a {@link SavedObjectsTypeMappingDefinition | saved object type}.\n" - ], - "path": "src/core/server/saved_objects/mappings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMappingProperties.Unnamed", - "type": "IndexSignature", - "tags": [], - "label": "[field: string]: SavedObjectsFieldMapping", - "description": [], - "signature": [ - "[field: string]: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFieldMapping", - "text": "SavedObjectsFieldMapping" - } - ], - "path": "src/core/server/saved_objects/mappings/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger", - "type": "Interface", - "tags": [], - "label": "SavedObjectsMigrationLogger", - "description": [], - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.debug", - "type": "Function", - "tags": [], - "label": "debug", - "description": [], - "signature": [ - "(msg: string) => void" - ], - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.debug.$1", - "type": "string", - "tags": [], - "label": "msg", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.info", - "type": "Function", - "tags": [], - "label": "info", - "description": [], - "signature": [ - "(msg: string) => void" - ], - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.info.$1", - "type": "string", - "tags": [], - "label": "msg", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.warning", - "type": "Function", - "tags": [ - "deprecated" - ], - "label": "warning", - "description": [], - "signature": [ - "(msg: string) => void" - ], - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": true, - "removeBy": "8.8.0", - "references": [ - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts" - }, - { - "plugin": "dashboard", - "path": "src/plugins/dashboard/server/saved_objects/migrations_730.ts" - }, - { - "plugin": "maps", - "path": "x-pack/plugins/maps/server/saved_objects/saved_object_migrations.ts" - } - ], - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.warning.$1", - "type": "string", - "tags": [], - "label": "msg", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.warn", - "type": "Function", - "tags": [], - "label": "warn", - "description": [], - "signature": [ - "(msg: string) => void" - ], - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.warn.$1", - "type": "string", - "tags": [], - "label": "msg", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.error", - "type": "Function", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "(msg: string, meta: Meta) => void" - ], - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.error.$1", - "type": "string", - "tags": [], - "label": "msg", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsMigrationLogger.error.$2", - "type": "Uncategorized", - "tags": [], - "label": "meta", - "description": [], - "signature": [ - "Meta" - ], - "path": "src/core/server/saved_objects/migrations/core/migration_logger.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsOpenPointInTimeOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsOpenPointInTimeOptions", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsOpenPointInTimeOptions.keepAlive", - "type": "string", - "tags": [], - "label": "keepAlive", - "description": [ - "\nOptionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsOpenPointInTimeOptions.preference", - "type": "string", - "tags": [], - "label": "preference", - "description": [ - "\nAn optional ES preference value to be used for the query." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsOpenPointInTimeOptions.namespaces", - "type": "Array", - "tags": [], - "label": "namespaces", - "description": [ - "\nAn optional list of namespaces to be used when opening the PIT.\n\nWhen the spaces plugin is enabled:\n - this will default to the user's current space (as determined by the URL)\n - if specified, the user's current space will be ignored\n - `['*']` will search across all available spaces" - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsOpenPointInTimeResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsOpenPointInTimeResponse", - "description": [], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsOpenPointInTimeResponse.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "\nPIT ID returned from ES." - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsPitParams", - "type": "Interface", - "tags": [], - "label": "SavedObjectsPitParams", - "description": [], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsPitParams.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsPitParams.keepAlive", - "type": "string", - "tags": [], - "label": "keepAlive", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDoc", - "type": "Interface", - "tags": [], - "label": "SavedObjectsRawDoc", - "description": [ - "\nA raw document as represented directly in the saved object index.\n" - ], - "path": "src/core/server/saved_objects/serialization/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDoc._id", - "type": "string", - "tags": [], - "label": "_id", - "description": [], - "path": "src/core/server/saved_objects/serialization/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDoc._source", - "type": "Object", - "tags": [], - "label": "_source", - "description": [], - "signature": [ - "SavedObjectsRawDocSource" - ], - "path": "src/core/server/saved_objects/serialization/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDoc._seq_no", - "type": "number", - "tags": [], - "label": "_seq_no", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/core/server/saved_objects/serialization/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDoc._primary_term", - "type": "number", - "tags": [], - "label": "_primary_term", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "src/core/server/saved_objects/serialization/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDocParseOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsRawDocParseOptions", - "description": [ - "\nOptions that can be specified when using the saved objects serializer to parse a raw document.\n" - ], - "path": "src/core/server/saved_objects/serialization/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRawDocParseOptions.namespaceTreatment", - "type": "CompoundType", - "tags": [], - "label": "namespaceTreatment", - "description": [ - "\nOptional setting to allow for lax handling of the raw document ID and namespace field. This is needed when a previously\nsingle-namespace object type is converted to a multi-namespace object type, and it is only intended to be used during upgrade\nmigrations.\n\nIf not specified, the default treatment is `strict`." - ], - "signature": [ - "\"strict\" | \"lax\" | undefined" - ], - "path": "src/core/server/saved_objects/serialization/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRemoveReferencesToOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsRemoveReferencesToOptions", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [ - "The Elasticsearch Refresh setting for this operation. Defaults to `true`" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRemoveReferencesToResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsRemoveReferencesToResponse", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRemoveReferencesToResponse.updated", - "type": "number", - "tags": [], - "label": "updated", - "description": [ - "The number of objects that have been updated by this operation" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepositoryFactory", - "type": "Interface", - "tags": [], - "label": "SavedObjectsRepositoryFactory", - "description": [ - "\nFactory provided when invoking a {@link SavedObjectsClientFactoryProvider | client factory provider}\nSee {@link SavedObjectsServiceSetup.setClientFactoryProvider}\n" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository", - "type": "Function", - "tags": [], - "label": "createScopedRepository", - "description": [ - "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n" - ], - "signature": [ - "(req: ", - "KibanaRequest", - ", includedHiddenTypes?: string[] | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsRepository", - "text": "ISavedObjectsRepository" - } - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository.$1", - "type": "Object", - "tags": [], - "label": "req", - "description": [], - "signature": [ - "KibanaRequest", - "" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepositoryFactory.createScopedRepository.$2", - "type": "Array", - "tags": [], - "label": "includedHiddenTypes", - "description": [ - "- A list of additional hidden types the repository should have access to." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository", - "type": "Function", - "tags": [], - "label": "createInternalRepository", - "description": [ - "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" - ], - "signature": [ - "(includedHiddenTypes?: string[] | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsRepository", - "text": "ISavedObjectsRepository" - } - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRepositoryFactory.createInternalRepository.$1", - "type": "Array", - "tags": [], - "label": "includedHiddenTypes", - "description": [ - "- A list of additional hidden types the repository should have access to." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRequestHandlerContext", - "type": "Interface", - "tags": [], - "label": "SavedObjectsRequestHandlerContext", - "description": [ - "\nCore's `savedObjects` request handler context." - ], - "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRequestHandlerContext.client", - "type": "Object", - "tags": [], - "label": "client", - "description": [], - "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" - ], - "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRequestHandlerContext.typeRegistry", - "type": "Object", - "tags": [], - "label": "typeRegistry", - "description": [], - "signature": [ - "{ isHidden: (type: string) => boolean; getType: (type: string) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - " | undefined; getVisibleTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; getAllTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; getImportableAndExportableTypes: () => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" - ], - "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRequestHandlerContext.getClient", - "type": "Function", - "tags": [], - "label": "getClient", - "description": [], - "signature": [ - "(options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientProviderOptions", - "text": "SavedObjectsClientProviderOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } - ], - "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRequestHandlerContext.getClient.$1", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientProviderOptions", - "text": "SavedObjectsClientProviderOptions" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRequestHandlerContext.getExporter", - "type": "Function", - "tags": [], - "label": "getExporter", - "description": [], - "signature": [ - "(client: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsExporter", - "text": "ISavedObjectsExporter" - } - ], - "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRequestHandlerContext.getExporter.$1", - "type": "Object", - "tags": [], - "label": "client", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } - ], - "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRequestHandlerContext.getImporter", - "type": "Function", - "tags": [], - "label": "getImporter", - "description": [], - "signature": [ - "(client: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsImporter", - "text": "ISavedObjectsImporter" - } - ], - "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsRequestHandlerContext.getImporter.$1", - "type": "Object", - "tags": [], - "label": "client", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } - ], - "path": "src/core/server/saved_objects/saved_objects_route_handler_context.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveImportErrorsOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsResolveImportErrorsOptions", - "description": [ - "\nOptions to control the \"resolve import\" operation." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveImportErrorsOptions.readStream", - "type": "Object", - "tags": [], - "label": "readStream", - "description": [ - "The stream of {@link SavedObject | saved objects} to resolve errors from" - ], - "signature": [ - "Readable" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveImportErrorsOptions.retries", - "type": "Array", - "tags": [], - "label": "retries", - "description": [ - "saved object import references to retry" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportRetry", - "text": "SavedObjectsImportRetry" - }, - "[]" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveImportErrorsOptions.namespace", - "type": "string", - "tags": [], - "label": "namespace", - "description": [ - "if specified, will import in given namespace" - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveImportErrorsOptions.createNewCopies", - "type": "boolean", - "tags": [], - "label": "createNewCopies", - "description": [ - "If true, will create new copies of import objects, each with a random `id` and undefined `originId`." - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsResolveResponse", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsResolveResponse", - "text": "SavedObjectsResolveResponse" - }, - "" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveResponse.saved_object", - "type": "Object", - "tags": [], - "label": "saved_object", - "description": [ - "\nThe saved object that was found." - ], - "signature": [ - "SavedObject", - "" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveResponse.outcome", - "type": "CompoundType", - "tags": [], - "label": "outcome", - "description": [ - "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." - ], - "signature": [ - "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveResponse.alias_target_id", - "type": "string", - "tags": [], - "label": "alias_target_id", - "description": [ - "\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsResolveResponse.alias_purpose", - "type": "CompoundType", - "tags": [], - "label": "alias_purpose", - "description": [ - "\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." - ], - "signature": [ - "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup", - "type": "Interface", - "tags": [], - "label": "SavedObjectsServiceSetup", - "description": [ - "\nSaved Objects is Kibana's data persistence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods\nfor registering Saved Object types, creating and registering Saved Object client wrappers and factories.\n" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider", - "type": "Function", - "tags": [], - "label": "setClientFactoryProvider", - "description": [ - "\nSet the default {@link SavedObjectsClientFactoryProvider | factory provider} for creating Saved Objects clients.\nOnly one provider can be set, subsequent calls to this method will fail." - ], - "signature": [ - "(clientFactoryProvider: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientFactoryProvider", - "text": "SavedObjectsClientFactoryProvider" - }, - ") => void" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup.setClientFactoryProvider.$1", - "type": "Function", - "tags": [], - "label": "clientFactoryProvider", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientFactoryProvider", - "text": "SavedObjectsClientFactoryProvider" - } - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup.addClientWrapper", - "type": "Function", - "tags": [], - "label": "addClientWrapper", - "description": [ - "\nAdd a {@link SavedObjectsClientWrapperFactory | client wrapper factory} with the given priority." - ], - "signature": [ - "(priority: number, id: string, factory: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientWrapperFactory", - "text": "SavedObjectsClientWrapperFactory" - }, - ") => void" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup.addClientWrapper.$1", - "type": "number", - "tags": [], - "label": "priority", - "description": [], - "signature": [ - "number" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup.addClientWrapper.$2", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup.addClientWrapper.$3", - "type": "Function", - "tags": [], - "label": "factory", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientWrapperFactory", - "text": "SavedObjectsClientWrapperFactory" - } - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup.registerType", - "type": "Function", - "tags": [], - "label": "registerType", - "description": [ - "\nRegister a {@link SavedObjectsType | savedObjects type} definition.\n\nSee the {@link SavedObjectsTypeMappingDefinition | mappings format} and\n{@link SavedObjectMigrationMap | migration format} for more details about these.\n" - ], - "signature": [ - "(type: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - ") => void" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup.registerType.$1", - "type": "Object", - "tags": [], - "label": "type", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceSetup.getKibanaIndex", - "type": "Function", - "tags": [], - "label": "getKibanaIndex", - "description": [ - "\nReturns the default index used for saved objects." - ], - "signature": [ - "() => string" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart", - "type": "Interface", - "tags": [], - "label": "SavedObjectsServiceStart", - "description": [ - "\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The\nSavedObjectsServiceStart API provides a scoped Saved Objects client for\ninteracting with Saved Objects.\n" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.getScopedClient", - "type": "Function", - "tags": [], - "label": "getScopedClient", - "description": [ - "\nCreates a {@link SavedObjectsClientContract | Saved Objects client} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch. If other plugins have registered Saved Objects client\nwrappers, these will be applied to extend the functionality of the client.\n\nA client that is already scoped to the incoming request is also exposed\nfrom the route handler context see {@link RequestHandlerContext}." - ], - "signature": [ - "(req: ", - "KibanaRequest", - ", options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientProviderOptions", - "text": "SavedObjectsClientProviderOptions" - }, - " | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.getScopedClient.$1", - "type": "Object", - "tags": [], - "label": "req", - "description": [], - "signature": [ - "KibanaRequest", - "" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.getScopedClient.$2", - "type": "Object", - "tags": [], - "label": "options", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientProviderOptions", - "text": "SavedObjectsClientProviderOptions" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createScopedRepository", - "type": "Function", - "tags": [], - "label": "createScopedRepository", - "description": [ - "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n" - ], - "signature": [ - "(req: ", - "KibanaRequest", - ", includedHiddenTypes?: string[] | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsRepository", - "text": "ISavedObjectsRepository" - } - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createScopedRepository.$1", - "type": "Object", - "tags": [], - "label": "req", - "description": [ - "- The request to create the scoped repository from." - ], - "signature": [ - "KibanaRequest", - "" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createScopedRepository.$2", - "type": "Array", - "tags": [], - "label": "includedHiddenTypes", - "description": [ - "- A list of additional hidden types the repository should have access to." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createInternalRepository", - "type": "Function", - "tags": [], - "label": "createInternalRepository", - "description": [ - "\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n" - ], - "signature": [ - "(includedHiddenTypes?: string[] | undefined) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsRepository", - "text": "ISavedObjectsRepository" - } - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createInternalRepository.$1", - "type": "Array", - "tags": [], - "label": "includedHiddenTypes", - "description": [ - "- A list of additional hidden types the repository should have access to." - ], - "signature": [ - "string[] | undefined" - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createSerializer", - "type": "Function", - "tags": [], - "label": "createSerializer", - "description": [ - "\nCreates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types." - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsSerializer", - "text": "SavedObjectsSerializer" - } - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createExporter", - "type": "Function", - "tags": [], - "label": "createExporter", - "description": [ - "\nCreates an {@link ISavedObjectsExporter | exporter} bound to given client." - ], - "signature": [ - "(client: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsExporter", - "text": "ISavedObjectsExporter" - } - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createExporter.$1", - "type": "Object", - "tags": [], - "label": "client", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createImporter", - "type": "Function", - "tags": [], - "label": "createImporter", - "description": [ - "\nCreates an {@link ISavedObjectsImporter | importer} bound to given client." - ], - "signature": [ - "(client: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsImporter", - "text": "ISavedObjectsImporter" - } - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.createImporter.$1", - "type": "Object", - "tags": [], - "label": "client", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsServiceStart.getTypeRegistry", - "type": "Function", - "tags": [], - "label": "getTypeRegistry", - "description": [ - "\nReturns the {@link ISavedObjectTypeRegistry | registry} containing all registered\n{@link SavedObjectsType | saved object types}" - ], - "signature": [ - "() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectTypeRegistry", - "text": "ISavedObjectTypeRegistry" - } - ], - "path": "src/core/server/saved_objects/saved_objects_service.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectStatusMeta", - "type": "Interface", - "tags": [], - "label": "SavedObjectStatusMeta", - "description": [ - "\nMeta information about the SavedObjectService's status. Available to plugins via {@link CoreSetup.status}.\n" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectStatusMeta.migratedIndices", - "type": "Object", - "tags": [], - "label": "migratedIndices", - "description": [], - "signature": [ - "{ [status: string]: number; skipped: number; migrated: number; }" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsType", - "type": "Interface", - "tags": [], - "label": "SavedObjectsType", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" - }, - "" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsType.name", - "type": "string", - "tags": [], - "label": "name", - "description": [ - "\nThe name of the type, which is also used as the internal id." - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsType.hidden", - "type": "boolean", - "tags": [], - "label": "hidden", - "description": [ - "\nIs the type hidden by default. If true, repositories will not have access to this type unless explicitly\ndeclared as an `extraType` when creating the repository.\n\nSee {@link SavedObjectsServiceStart.createInternalRepository | createInternalRepository}." - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsType.namespaceType", - "type": "CompoundType", - "tags": [], - "label": "namespaceType", - "description": [ - "\nThe {@link SavedObjectsNamespaceType | namespace type} for the type." - ], - "signature": [ - "\"single\" | \"multiple\" | \"multiple-isolated\" | \"agnostic\"" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsType.indexPattern", - "type": "string", - "tags": [], - "label": "indexPattern", - "description": [ - "\nIf defined, the type instances will be stored in the given index instead of the default one." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsType.convertToAliasScript", - "type": "string", - "tags": [], - "label": "convertToAliasScript", - "description": [ - "\nIf defined, will be used to convert the type to an alias." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsType.excludeOnUpgrade", - "type": "Function", - "tags": [], - "label": "excludeOnUpgrade", - "description": [ - "\nIf defined, allows a type to exclude unneeded documents from the migration process and effectively be deleted.\nSee {@link SavedObjectTypeExcludeFromUpgradeFilterHook} for more details." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectTypeExcludeFromUpgradeFilterHook", - "text": "SavedObjectTypeExcludeFromUpgradeFilterHook" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsType.mappings", - "type": "Object", - "tags": [], - "label": "mappings", - "description": [ - "\nThe {@link SavedObjectsTypeMappingDefinition | mapping definition} for the type." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsTypeMappingDefinition", - "text": "SavedObjectsTypeMappingDefinition" - } - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsType.migrations", - "type": "CompoundType", - "tags": [], - "label": "migrations", - "description": [ - "\nAn optional map of {@link SavedObjectMigrationFn | migrations} or a function returning a map of {@link SavedObjectMigrationFn | migrations} to be used to migrate the type." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" - }, - " | (() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationMap", - "text": "SavedObjectMigrationMap" - }, - ") | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsType.schemas", - "type": "CompoundType", - "tags": [], - "label": "schemas", - "description": [ - "\nAn optional schema that can be used to validate the attributes of the type.\n\nWhen provided, calls to {@link SavedObjectsClient.create | create} will be validated against this schema.\n\nSee {@link SavedObjectsValidationMap} for more details." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsValidationMap", - "text": "SavedObjectsValidationMap" - }, - " | (() => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsValidationMap", - "text": "SavedObjectsValidationMap" - }, - ") | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsType.convertToMultiNamespaceTypeVersion", - "type": "string", - "tags": [], - "label": "convertToMultiNamespaceTypeVersion", - "description": [ - "\nIf defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this\nversion.\n\nRequirements:\n\n 1. This string value must be a valid semver version\n 2. This type must have previously specified {@link SavedObjectsNamespaceType | `namespaceType: 'single'`}\n 3. This type must also specify {@link SavedObjectsNamespaceType | `namespaceType: 'multiple'`} *or*\n {@link SavedObjectsNamespaceType | `namespaceType: 'multiple-isolated'`}\n\nExample of a single-namespace type in 7.12:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'single',\n mappings: {...}\n}\n```\n\nExample after converting to a multi-namespace (isolated) type in 8.0:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple-isolated',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nExample after converting to a multi-namespace (shareable) type in 8.1:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nNote: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsType.management", - "type": "Object", - "tags": [], - "label": "management", - "description": [ - "\nAn optional {@link SavedObjectsTypeManagementDefinition | saved objects management section} definition for the type." - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsTypeManagementDefinition", - "text": "SavedObjectsTypeManagementDefinition" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition", - "type": "Interface", - "tags": [], - "label": "SavedObjectsTypeManagementDefinition", - "description": [ - "\nConfiguration options for the {@link SavedObjectsType | type}'s management section.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsTypeManagementDefinition", - "text": "SavedObjectsTypeManagementDefinition" - }, - "" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.importableAndExportable", - "type": "CompoundType", - "tags": [], - "label": "importableAndExportable", - "description": [ - "\nIs the type importable or exportable. Defaults to `false`." - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.displayName", - "type": "string", - "tags": [], - "label": "displayName", - "description": [ - "\nWhen specified, will be used instead of the type's name in SO management section's labels." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.visibleInManagement", - "type": "CompoundType", - "tags": [], - "label": "visibleInManagement", - "description": [ - "\nWhen set to false, the type will not be listed or searchable in the SO management section.\nMain usage of setting this property to false for a type is when objects from the type should\nbe included in the export via references or export hooks, but should not directly appear in the SOM.\nDefaults to `true`.\n" - ], - "signature": [ - "boolean | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.defaultSearchField", - "type": "string", - "tags": [], - "label": "defaultSearchField", - "description": [ - "\nThe default search field to use for this type. Defaults to `id`." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.icon", - "type": "string", - "tags": [], - "label": "icon", - "description": [ - "\nThe eui icon name to display in the management table.\nIf not defined, the default icon will be used." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.getTitle", - "type": "Function", - "tags": [], - "label": "getTitle", - "description": [ - "\nFunction returning the title to display in the management table.\nIf not defined, will use the object's type and id to generate a label." - ], - "signature": [ - "((savedObject: ", - "SavedObject", - ") => string) | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.getTitle.$1", - "type": "Object", - "tags": [], - "label": "savedObject", - "description": [], - "signature": [ - "SavedObject", - "" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl", - "type": "Function", - "tags": [], - "label": "getEditUrl", - "description": [ - "\nFunction returning the url to use to redirect to the editing page of this object.\nIf not defined, editing will not be allowed." - ], - "signature": [ - "((savedObject: ", - "SavedObject", - ") => string) | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl.$1", - "type": "Object", - "tags": [], - "label": "savedObject", - "description": [], - "signature": [ - "SavedObject", - "" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl", - "type": "Function", - "tags": [], - "label": "getInAppUrl", - "description": [ - "\nFunction returning the url to use to redirect to this object from the management section.\nIf not defined, redirecting to the object will not be allowed.\n" - ], - "signature": [ - "((savedObject: ", - "SavedObject", - ") => { path: string; uiCapabilitiesPath: string; }) | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl.$1", - "type": "Object", - "tags": [], - "label": "savedObject", - "description": [], - "signature": [ - "SavedObject", - "" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [ - "an object containing a `path` and `uiCapabilitiesPath` properties. the `path` is the path to\nthe object page, relative to the base path. `uiCapabilitiesPath` is the path to check in the\n{@link Capabilities | uiCapabilities} to check if the user has permission to access the object." - ] - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.onExport", - "type": "Function", - "tags": [], - "label": "onExport", - "description": [ - "\nAn optional export transform function that can be used transform the objects of the registered type during\nthe export process.\n\nIt can be used to either mutate the exported objects, or add additional objects (of any type) to the export list.\n\nSee {@link SavedObjectsExportTransform | the transform type documentation} for more info and examples.\n\nWhen implementing both `isExportable` and `onExport`, it is mandatory that\n`isExportable` returns the same value for an object before and after going\nthough the export transform.\nE.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)`\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsExportTransform", - "text": "SavedObjectsExportTransform" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.onImport", - "type": "Function", - "tags": [], - "label": "onImport", - "description": [ - "\nAn optional {@link SavedObjectsImportHook | import hook} to use when importing given type.\n\nImport hooks are executed during the savedObjects import process and allow to interact\nwith the imported objects. See the {@link SavedObjectsImportHook | hook documentation}\nfor more info.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportHook", - "text": "SavedObjectsImportHook" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeManagementDefinition.isExportable", - "type": "Function", - "tags": [], - "label": "isExportable", - "description": [ - "\nOptional hook to specify whether an object should be exportable.\n\nIf specified, `isExportable` will be called during export for each\nof this type's objects in the export, and the ones not matching the\npredicate will be excluded from the export.\n\nWhen implementing both `isExportable` and `onExport`, it is mandatory that\n`isExportable` returns the same value for an object before and after going\nthough the export transform.\nE.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)`\n" - ], - "signature": [ - "SavedObjectsExportablePredicate", - " | undefined" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeMappingDefinition", - "type": "Interface", - "tags": [], - "label": "SavedObjectsTypeMappingDefinition", - "description": [ - "\nDescribe a saved object type mapping.\n" - ], - "path": "src/core/server/saved_objects/mappings/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeMappingDefinition.dynamic", - "type": "CompoundType", - "tags": [], - "label": "dynamic", - "description": [ - "The dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings." - ], - "signature": [ - "false | \"strict\" | undefined" - ], - "path": "src/core/server/saved_objects/mappings/types.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsTypeMappingDefinition.properties", - "type": "Object", - "tags": [], - "label": "properties", - "description": [ - "The underlying properties of the type mapping" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsMappingProperties", - "text": "SavedObjectsMappingProperties" - } - ], - "path": "src/core/server/saved_objects/mappings/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsUpdateObjectsSpacesObject", - "description": [ - "\nAn object that should have its spaces updated.\n" - ], - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "The type of the object to update" - ], - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "The ID of the object to update" - ], - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsUpdateObjectsSpacesOptions", - "description": [ - "\nOptions for the update operation.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", - "text": "SavedObjectsUpdateObjectsSpacesOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesOptions.refresh", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [ - "The Elasticsearch Refresh setting for this operation" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.MutatingOperationRefreshSetting", - "text": "MutatingOperationRefreshSetting" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsUpdateObjectsSpacesResponse", - "description": [ - "\nThe response when objects' spaces are updated.\n" - ], - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponse.objects", - "type": "Array", - "tags": [], - "label": "objects", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject", - "text": "SavedObjectsUpdateObjectsSpacesResponseObject" - }, - "[]" - ], - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject", - "type": "Interface", - "tags": [], - "label": "SavedObjectsUpdateObjectsSpacesResponseObject", - "description": [ - "\nDetails about a specific object's update result.\n" - ], - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "The type of the referenced object" - ], - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.id", - "type": "string", - "tags": [], - "label": "id", - "description": [ - "The ID of the referenced object" - ], - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.spaces", - "type": "Array", - "tags": [], - "label": "spaces", - "description": [ - "The space(s) that the referenced object exists in" - ], - "signature": [ - "string[]" - ], - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.error", - "type": "Object", - "tags": [], - "label": "error", - "description": [ - "Included if there was an error updating this object's spaces" - ], - "signature": [ - "SavedObjectError", - " | undefined" - ], - "path": "src/core/server/saved_objects/service/lib/update_objects_spaces.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions", - "type": "Interface", - "tags": [], - "label": "SavedObjectsUpdateOptions", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - " extends ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "\nAn opaque version number which changes on each successful write operation.\nCan be used for implementing optimistic concurrency control." - ], - "signature": [ - "string | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [ - "{@inheritdoc SavedObjectReference}" - ], - "signature": [ - "SavedObjectReference", - "[] | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions.refresh", - "type": "CompoundType", - "tags": [], - "label": "refresh", - "description": [ - "The Elasticsearch Refresh setting for this operation" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.MutatingOperationRefreshSetting", - "text": "MutatingOperationRefreshSetting" - }, - " | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions.upsert", - "type": "Uncategorized", - "tags": [], - "label": "upsert", - "description": [ - "If specified, will be used to perform an upsert if the document doesn't exist" - ], - "signature": [ - "Attributes | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateOptions.retryOnConflict", - "type": "number", - "tags": [], - "label": "retryOnConflict", - "description": [ - "\nThe Elasticsearch `retry_on_conflict` setting for this operation.\nDefaults to `0` when `version` is provided, `3` otherwise." - ], - "signature": [ - "number | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateResponse", - "type": "Interface", - "tags": [], - "label": "SavedObjectsUpdateResponse", - "description": [ - "\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - " extends Omit<", - "SavedObject", - ", \"attributes\" | \"references\">" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateResponse.attributes", - "type": "Object", - "tags": [], - "label": "attributes", - "description": [], - "signature": [ - "{ [P in keyof T]?: T[P] | undefined; }" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsUpdateResponse.references", - "type": "Array", - "tags": [], - "label": "references", - "description": [], - "signature": [ - "SavedObjectReference", - "[] | undefined" - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsValidationMap", - "type": "Interface", - "tags": [], - "label": "SavedObjectsValidationMap", - "description": [ - "\nA map of {@link SavedObjectsValidationSpec | validation specs} to be used for a given type.\nThe map's keys must be valid semver versions.\n\nAny time you change the schema of a {@link SavedObjectsType}, you should add a new entry\nto this map for the Kibana version the change was introduced in.\n" - ], - "path": "src/core/server/saved_objects/validation/types.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsValidationMap.Unnamed", - "type": "IndexSignature", - "tags": [], - "label": "[version: string]: SavedObjectsValidationSpec", - "description": [], - "signature": [ - "[version: string]: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsValidationSpec", - "text": "SavedObjectsValidationSpec" - } - ], - "path": "src/core/server/saved_objects/validation/types.ts", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], - "enums": [], - "misc": [ - { - "parentPluginId": "core", - "id": "def-server.ISavedObjectsRepository", - "type": "Type", - "tags": [], - "label": "ISavedObjectsRepository", - "description": [ - "\nSee {@link SavedObjectsRepository}\n" - ], - "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - ") => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResponse", - "text": "SavedObjectsBulkResponse" - }, - ">; 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<{}>; deleteByNamespace: (namespace: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsDeleteByNamespaceOptions", - "text": "SavedObjectsDeleteByNamespaceOptions" - }, - ") => Promise; find: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkResolveResponse", - "text": "SavedObjectsBulkResolveResponse" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectStatusMeta", + "type": "Interface", + "tags": [], + "label": "SavedObjectStatusMeta", + "description": [ + "\nMeta information about the SavedObjectService's status. Available to plugins via {@link CoreSetup.status}.\n" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" - }, - ") => Promise<", + "parentPluginId": "core", + "id": "def-server.SavedObjectStatusMeta.migratedIndices", + "type": "Object", + "tags": [], + "label": "migratedIndices", + "description": [], + "signature": [ + "{ [status: string]: number; skipped: number; migrated: number; }" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsType", + "type": "Interface", + "tags": [], + "label": "SavedObjectsType", + "description": [], + "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ">; removeReferencesTo: (type: string, id: string, options?: ", + "" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.name", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "\nThe name of the type, which is also used as the internal id." + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - ") => Promise<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.hidden", + "type": "boolean", + "tags": [], + "label": "hidden", + "description": [ + "\nIs the type hidden by default. If true, repositories will not have access to this type unless explicitly\ndeclared as an `extraType` when creating the repository.\n\nSee {@link SavedObjectsServiceStart.createInternalRepository | createInternalRepository}." + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - ">; incrementCounter: (type: string, id: string, counterFields: (string | ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterField", - "text": "SavedObjectsIncrementCounterField" + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.namespaceType", + "type": "CompoundType", + "tags": [], + "label": "namespaceType", + "description": [ + "\nThe {@link SavedObjectsNamespaceType | namespace type} for the type." + ], + "signature": [ + "\"single\" | \"multiple\" | \"multiple-isolated\" | \"agnostic\"" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - ")[], options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsIncrementCounterOptions", - "text": "SavedObjectsIncrementCounterOptions" + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.indexPattern", + "type": "string", + "tags": [], + "label": "indexPattern", + "description": [ + "\nIf defined, the type instances will be stored in the given index instead of the default one." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - " | undefined) => Promise<", - "SavedObject", - ">; openPointInTimeForType: (type: string | string[], { keepAlive, preference }?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.convertToAliasScript", + "type": "string", + "tags": [], + "label": "convertToAliasScript", + "description": [ + "\nIf defined, will be used to convert the type to an alias." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - ") => Promise<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.excludeOnUpgrade", + "type": "Function", + "tags": [], + "label": "excludeOnUpgrade", + "description": [ + "\nIf defined, allows a type to exclude unneeded documents from the migration process and effectively be deleted.\nSee {@link SavedObjectTypeExcludeFromUpgradeFilterHook} for more details." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectTypeExcludeFromUpgradeFilterHook", + "text": "SavedObjectTypeExcludeFromUpgradeFilterHook" + }, + " | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - ">; closePointInTime: (id: string, options?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.mappings", + "type": "Object", + "tags": [], + "label": "mappings", + "description": [ + "\nThe {@link SavedObjectsTypeMappingDefinition | mapping definition} for the type." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsTypeMappingDefinition", + "text": "SavedObjectsTypeMappingDefinition" + } + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - " | undefined) => Promise<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.migrations", + "type": "CompoundType", + "tags": [], + "label": "migrations", + "description": [ + "\nAn optional map of {@link SavedObjectMigrationFn | migrations} or a function returning a map of {@link SavedObjectMigrationFn | migrations} to be used to migrate the type." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + }, + " | (() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationMap", + "text": "SavedObjectMigrationMap" + }, + ") | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - ">; createPointInTimeFinder: (findOptions: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "text": "SavedObjectsCreatePointInTimeFinderOptions" + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.schemas", + "type": "CompoundType", + "tags": [], + "label": "schemas", + "description": [ + "\nAn optional schema that can be used to validate the attributes of the type.\n\nWhen provided, calls to {@link SavedObjectsClient.create | create} will be validated against this schema.\n\nSee {@link SavedObjectsValidationMap} for more details." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsValidationMap", + "text": "SavedObjectsValidationMap" + }, + " | (() => ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsValidationMap", + "text": "SavedObjectsValidationMap" + }, + ") | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - ", dependencies?: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.convertToMultiNamespaceTypeVersion", + "type": "string", + "tags": [], + "label": "convertToMultiNamespaceTypeVersion", + "description": [ + "\nIf defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this\nversion.\n\nRequirements:\n\n 1. This string value must be a valid semver version\n 2. This type must have previously specified {@link SavedObjectsNamespaceType | `namespaceType: 'single'`}\n 3. This type must also specify {@link SavedObjectsNamespaceType | `namespaceType: 'multiple'`} *or*\n {@link SavedObjectsNamespaceType | `namespaceType: 'multiple-isolated'`}\n\nExample of a single-namespace type in 7.12:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'single',\n mappings: {...}\n}\n```\n\nExample after converting to a multi-namespace (isolated) type in 8.0:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple-isolated',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nExample after converting to a multi-namespace (shareable) type in 8.1:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nNote: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - " | undefined) => ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" - }, - "; }" + "parentPluginId": "core", + "id": "def-server.SavedObjectsType.management", + "type": "Object", + "tags": [], + "label": "management", + "description": [ + "\nAn optional {@link SavedObjectsTypeManagementDefinition | saved objects management section} definition for the type." + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsTypeManagementDefinition", + "text": "SavedObjectsTypeManagementDefinition" + }, + " | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + } ], - "path": "src/core/server/saved_objects/service/lib/repository.ts", - "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "core", - "id": "def-server.ISavedObjectTypeRegistry", - "type": "Type", + "id": "def-server.SavedObjectsTypeManagementDefinition", + "type": "Interface", "tags": [], - "label": "ISavedObjectTypeRegistry", + "label": "SavedObjectsTypeManagementDefinition", "description": [ - "\nSee {@link SavedObjectTypeRegistry} for documentation.\n" + "\nConfiguration options for the {@link SavedObjectsType | type}'s management section.\n" ], "signature": [ - "{ isHidden: (type: string) => boolean; getType: (type: string) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "section": "def-server.SavedObjectsTypeManagementDefinition", + "text": "SavedObjectsTypeManagementDefinition" }, - " | undefined; getVisibleTypes: () => ", + "" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.importableAndExportable", + "type": "CompoundType", + "tags": [], + "label": "importableAndExportable", + "description": [ + "\nIs the type importable or exportable. Defaults to `false`." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - "[]; getAllTypes: () => ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.displayName", + "type": "string", + "tags": [], + "label": "displayName", + "description": [ + "\nWhen specified, will be used instead of the type's name in SO management section's labels." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - "[]; getImportableAndExportableTypes: () => ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsType", - "text": "SavedObjectsType" + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.visibleInManagement", + "type": "CompoundType", + "tags": [], + "label": "visibleInManagement", + "description": [ + "\nWhen set to false, the type will not be listed or searchable in the SO management section.\nMain usage of setting this property to false for a type is when objects from the type should\nbe included in the export via references or export hooks, but should not directly appear in the SOM.\nDefaults to `true`.\n" + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" - ], - "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.MutatingOperationRefreshSetting", - "type": "Type", - "tags": [], - "label": "MutatingOperationRefreshSetting", - "description": [ - "\nElasticsearch Refresh setting for mutating operation" - ], - "signature": [ - "boolean | \"wait_for\"" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationFn", - "type": "Type", - "tags": [], - "label": "SavedObjectMigrationFn", - "description": [ - "\nA migration function for a {@link SavedObjectsType | saved object type}\nused to migrate it to a given version\n" - ], - "signature": [ - "(doc: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectUnsanitizedDoc", - "text": "SavedObjectUnsanitizedDoc" + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.defaultSearchField", + "type": "string", + "tags": [], + "label": "defaultSearchField", + "description": [ + "\nThe default search field to use for this type. Defaults to `id`." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - ", context: ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationContext", - "text": "SavedObjectMigrationContext" + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.icon", + "type": "string", + "tags": [], + "label": "icon", + "description": [ + "\nThe eui icon name to display in the management table.\nIf not defined, the default icon will be used." + ], + "signature": [ + "string | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false }, - ") => ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectUnsanitizedDoc", - "text": "SavedObjectUnsanitizedDoc" + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.getTitle", + "type": "Function", + "tags": [], + "label": "getTitle", + "description": [ + "\nFunction returning the title to display in the management table.\nIf not defined, will use the object's type and id to generate a label." + ], + "signature": [ + "((savedObject: ", + "SavedObject", + ") => string) | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.getTitle.$1", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + "SavedObject", + "" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl", + "type": "Function", + "tags": [], + "label": "getEditUrl", + "description": [ + "\nFunction returning the url to use to redirect to the editing page of this object.\nIf not defined, editing will not be allowed." + ], + "signature": [ + "((savedObject: ", + "SavedObject", + ") => string) | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.getEditUrl.$1", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + "SavedObject", + "" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl", + "type": "Function", + "tags": [], + "label": "getInAppUrl", + "description": [ + "\nFunction returning the url to use to redirect to this object from the management section.\nIf not defined, redirecting to the object will not be allowed.\n" + ], + "signature": [ + "((savedObject: ", + "SavedObject", + ") => { path: string; uiCapabilitiesPath: string; }) | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.getInAppUrl.$1", + "type": "Object", + "tags": [], + "label": "savedObject", + "description": [], + "signature": [ + "SavedObject", + "" + ], + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "an object containing a `path` and `uiCapabilitiesPath` properties. the `path` is the path to\nthe object page, relative to the base path. `uiCapabilitiesPath` is the path to check in the\n{@link Capabilities | uiCapabilities} to check if the user has permission to access the object." + ] }, - "" - ], - "path": "src/core/server/saved_objects/migrations/types.ts", - "deprecated": false, - "returnComment": [], - "children": [ { "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationFn.$1", - "type": "CompoundType", + "id": "def-server.SavedObjectsTypeManagementDefinition.onExport", + "type": "Function", "tags": [], - "label": "doc", - "description": [], + "label": "onExport", + "description": [ + "\nAn optional export transform function that can be used transform the objects of the registered type during\nthe export process.\n\nIt can be used to either mutate the exported objects, or add additional objects (of any type) to the export list.\n\nSee {@link SavedObjectsExportTransform | the transform type documentation} for more info and examples.\n\nWhen implementing both `isExportable` and `onExport`, it is mandatory that\n`isExportable` returns the same value for an object before and after going\nthough the export transform.\nE.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)`\n" + ], "signature": [ - "SavedObjectDoc & Partial" + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsExportTransform", + "text": "SavedObjectsExportTransform" + }, + " | undefined" ], - "path": "src/core/server/saved_objects/migrations/types.ts", + "path": "src/core/server/saved_objects/types.ts", "deprecated": false }, { "parentPluginId": "core", - "id": "def-server.SavedObjectMigrationFn.$2", - "type": "Object", + "id": "def-server.SavedObjectsTypeManagementDefinition.onImport", + "type": "Function", "tags": [], - "label": "context", - "description": [], + "label": "onImport", + "description": [ + "\nAn optional {@link SavedObjectsImportHook | import hook} to use when importing given type.\n\nImport hooks are executed during the savedObjects import process and allow to interact\nwith the imported objects. See the {@link SavedObjectsImportHook | hook documentation}\nfor more info.\n" + ], "signature": [ { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectMigrationContext", - "text": "SavedObjectMigrationContext" - } + "section": "def-server.SavedObjectsImportHook", + "text": "SavedObjectsImportHook" + }, + " | undefined" ], - "path": "src/core/server/saved_objects/migrations/types.ts", + "path": "src/core/server/saved_objects/types.ts", + "deprecated": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeManagementDefinition.isExportable", + "type": "Function", + "tags": [], + "label": "isExportable", + "description": [ + "\nOptional hook to specify whether an object should be exportable.\n\nIf specified, `isExportable` will be called during export for each\nof this type's objects in the export, and the ones not matching the\npredicate will be excluded from the export.\n\nWhen implementing both `isExportable` and `onExport`, it is mandatory that\n`isExportable` returns the same value for an object before and after going\nthough the export transform.\nE.g `isExportable(objectBeforeTransform) === isExportable(objectAfterTransform)`\n" + ], + "signature": [ + "SavedObjectsExportablePredicate", + " | undefined" + ], + "path": "src/core/server/saved_objects/types.ts", "deprecated": false } ], @@ -14914,357 +6610,229 @@ }, { "parentPluginId": "core", - "id": "def-server.SavedObjectSanitizedDoc", - "type": "Type", + "id": "def-server.SavedObjectsTypeMappingDefinition", + "type": "Interface", "tags": [], - "label": "SavedObjectSanitizedDoc", + "label": "SavedObjectsTypeMappingDefinition", "description": [ - "\nDescribes Saved Object documents that have passed through the migration\nframework and are guaranteed to have a `references` root property.\n" - ], - "signature": [ - "SavedObjectDoc & Referencable" + "\nDescribe a saved object type mapping.\n" ], - "path": "src/core/server/saved_objects/serialization/types.ts", + "path": "src/core/server/saved_objects/mappings/types.ts", "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClientContract", - "type": "Type", - "tags": [], - "label": "SavedObjectsClientContract", - "description": [ - "\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state.\n\n## SavedObjectsClient errors\n\nSince the SavedObjectsClient has its hands in everything we\nare a little paranoid about the way we present errors back to\nto application code. Ideally, all errors will be either:\n\n 1. Caused by bad implementation (ie. undefined is not a function) and\n as such unpredictable\n 2. An error that has been classified and decorated appropriately\n by the decorators in {@link SavedObjectsErrorHelpers}\n\nType 1 errors are inevitable, but since all expected/handle-able errors\nshould be Type 2 the `isXYZError()` helpers exposed at\n`SavedObjectsErrorHelpers` should be used to understand and manage error\nresponses from the `SavedObjectsClient`.\n\nType 2 errors are decorated versions of the source error, so if\nthe elasticsearch client threw an error it will be decorated based\non its type. That means that rather than looking for `error.body.error.type` or\ndoing substring checks on `error.body.error.reason`, just use the helpers to\nunderstand the meaning of the error:\n\n ```js\n if (SavedObjectsErrorHelpers.isNotFoundError(error)) {\n // handle 404\n }\n\n if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) {\n // 401 handling should be automatic, but in case you wanted to know\n }\n\n // always rethrow the error unless you handle it\n throw error;\n ```\n\n### 404s from missing index\n\nFrom the perspective of application code and APIs the SavedObjectsClient is\na black box that persists objects. One of the internal details that users have\nno control over is that we use an elasticsearch index for persistence and that\nindex might be missing.\n\nAt the time of writing we are in the process of transitioning away from the\noperating assumption that the SavedObjects index is always available. Part of\nthis transition is handling errors resulting from an index missing. These used\nto trigger a 500 error in most cases, and in others cause 404s with different\nerror messages.\n\nFrom my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The\nobject the request/call was targeting could not be found. This is why #14141\ntakes special care to ensure that 404 errors are generic and don't distinguish\nbetween index missing or document missing.\n\nSee {@link SavedObjectsClient}\nSee {@link SavedObjectsErrorHelpers}\n" - ], - "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], options?: ", + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateOptions", - "text": "SavedObjectsBulkUpdateOptions" + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeMappingDefinition.dynamic", + "type": "CompoundType", + "tags": [], + "label": "dynamic", + "description": [ + "The dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings." + ], + "signature": [ + "false | \"strict\" | undefined" + ], + "path": "src/core/server/saved_objects/mappings/types.ts", + "deprecated": false }, - " | undefined) => Promise<", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateResponse", - "text": "SavedObjectsBulkUpdateResponse" - }, - ">; removeReferencesTo: (type: string, id: string, options?: ", + "parentPluginId": "core", + "id": "def-server.SavedObjectsTypeMappingDefinition.properties", + "type": "Object", + "tags": [], + "label": "properties", + "description": [ + "The underlying properties of the type mapping" + ], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsMappingProperties", + "text": "SavedObjectsMappingProperties" + } + ], + "path": "src/core/server/saved_objects/mappings/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectsValidationMap", + "type": "Interface", + "tags": [], + "label": "SavedObjectsValidationMap", + "description": [ + "\nA map of {@link SavedObjectsValidationSpec | validation specs} to be used for a given type.\nThe map's keys must be valid semver versions.\n\nAny time you change the schema of a {@link SavedObjectsType}, you should add a new entry\nto this map for the Kibana version the change was introduced in.\n" + ], + "path": "src/core/server/saved_objects/validation/types.ts", + "deprecated": false, + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToOptions", - "text": "SavedObjectsRemoveReferencesToOptions" - }, - " | undefined) => Promise<", + "parentPluginId": "core", + "id": "def-server.SavedObjectsValidationMap.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[version: string]: SavedObjectsValidationSpec", + "description": [], + "signature": [ + "[version: string]: ", + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectsValidationSpec", + "text": "SavedObjectsValidationSpec" + } + ], + "path": "src/core/server/saved_objects/validation/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "core", + "id": "def-server.ISavedObjectTypeRegistry", + "type": "Type", + "tags": [], + "label": "ISavedObjectTypeRegistry", + "description": [ + "\nSee {@link SavedObjectTypeRegistry} for documentation.\n" + ], + "signature": [ + "{ isHidden: (type: string) => boolean; getType: (type: string) => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsRemoveReferencesToResponse", - "text": "SavedObjectsRemoveReferencesToResponse" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ">; openPointInTimeForType: (type: string | string[], options?: ", + " | undefined; getVisibleTypes: () => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeOptions", - "text": "SavedObjectsOpenPointInTimeOptions" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ") => Promise<", + "[]; getAllTypes: () => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - ">; closePointInTime: (id: string, options?: ", + "[]; getImportableAndExportableTypes: () => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" + "section": "def-server.SavedObjectsType", + "text": "SavedObjectsType" }, - " | undefined) => Promise<", + "[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }" + ], + "path": "src/core/server/saved_objects/saved_objects_type_registry.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectMigrationFn", + "type": "Type", + "tags": [], + "label": "SavedObjectMigrationFn", + "description": [ + "\nA migration function for a {@link SavedObjectsType | saved object type}\nused to migrate it to a given version\n" + ], + "signature": [ + "(doc: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" + "section": "def-server.SavedObjectUnsanitizedDoc", + "text": "SavedObjectUnsanitizedDoc" }, - ">; createPointInTimeFinder: (findOptions: ", + ", context: ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "text": "SavedObjectsCreatePointInTimeFinderOptions" + "section": "def-server.SavedObjectMigrationContext", + "text": "SavedObjectMigrationContext" }, - ", dependencies?: ", + ") => ", { "pluginId": "core", "scope": "server", "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", - "text": "SavedObjectsCreatePointInTimeFinderDependencies" + "section": "def-server.SavedObjectUnsanitizedDoc", + "text": "SavedObjectUnsanitizedDoc" }, - " | undefined) => ", + "" + ], + "path": "src/core/server/saved_objects/migrations/types.ts", + "deprecated": false, + "returnComment": [], + "children": [ { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" + "parentPluginId": "core", + "id": "def-server.SavedObjectMigrationFn.$1", + "type": "CompoundType", + "tags": [], + "label": "doc", + "description": [], + "signature": [ + "SavedObjectDoc & Partial" + ], + "path": "src/core/server/saved_objects/migrations/types.ts", + "deprecated": false }, - "; errors: typeof ", { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "parentPluginId": "core", + "id": "def-server.SavedObjectMigrationFn.$2", + "type": "Object", + "tags": [], + "label": "context", + "description": [], + "signature": [ + { + "pluginId": "core", + "scope": "server", + "docId": "kibCoreSavedObjectsPluginApi", + "section": "def-server.SavedObjectMigrationContext", + "text": "SavedObjectMigrationContext" + } + ], + "path": "src/core/server/saved_objects/migrations/types.ts", + "deprecated": false + } ], - "path": "src/core/server/saved_objects/types.ts", + "initialIsOpen": false + }, + { + "parentPluginId": "core", + "id": "def-server.SavedObjectSanitizedDoc", + "type": "Type", + "tags": [], + "label": "SavedObjectSanitizedDoc", + "description": [ + "\nDescribes Saved Object documents that have passed through the migration\nframework and are guaranteed to have a `references` root property.\n" + ], + "signature": [ + "SavedObjectDoc & Referencable" + ], + "path": "src/core/server/saved_objects/serialization/types.ts", "deprecated": false, "initialIsOpen": false }, @@ -15281,13 +6849,7 @@ "({ request, includedHiddenTypes, }: { request: ", "KibanaRequest", "; includedHiddenTypes?: string[] | undefined; }) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", "deprecated": false, @@ -15383,13 +6945,7 @@ "text": "SavedObjectsClientWrapperOptions" }, ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "src/core/server/saved_objects/service/lib/scoped_client_provider.ts", "deprecated": false, @@ -15417,60 +6973,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsClosePointInTimeOptions", - "type": "Type", - "tags": [], - "label": "SavedObjectsClosePointInTimeOptions", - "description": [], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - } - ], - "path": "src/core/server/saved_objects/service/saved_objects_client.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsCreatePointInTimeFinderOptions", - "type": "Type", - "tags": [], - "label": "SavedObjectsCreatePointInTimeFinderOptions", - "description": [], - "signature": [ - "{ type: string | string[]; filter?: any; search?: string | undefined; aggs?: Record | undefined; fields?: 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" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, - "[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map | undefined; preference?: string | undefined; }" - ], - "path": "src/core/server/saved_objects/service/lib/point_in_time_finder.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "core", "id": "def-server.SavedObjectsExportTransform", @@ -15607,52 +7109,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsImportWarning", - "type": "Type", - "tags": [], - "label": "SavedObjectsImportWarning", - "description": [ - "\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n" - ], - "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportSimpleWarning", - "text": "SavedObjectsImportSimpleWarning" - }, - " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportActionRequiredWarning", - "text": "SavedObjectsImportActionRequiredWarning" - } - ], - "path": "src/core/server/saved_objects/import/types.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "core", - "id": "def-server.SavedObjectsNamespaceType", - "type": "Type", - "tags": [], - "label": "SavedObjectsNamespaceType", - "description": [ - "\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n" - ], - "signature": [ - "\"single\" | \"multiple\" | \"multiple-isolated\" | \"agnostic\"" - ], - "path": "src/core/server/saved_objects/types.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "core", "id": "def-server.SavedObjectsValidationSpec", diff --git a/api_docs/core_saved_objects.mdx b/api_docs/core_saved_objects.mdx index bb5997e1aabc1..e7607f8c0d15a 100644 --- a/api_docs/core_saved_objects.mdx +++ b/api_docs/core_saved_objects.mdx @@ -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-25 +date: 2022-07-28 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 | |-------------------|-----------|------------------------|-----------------| -| 2470 | 5 | 664 | 17 | +| 2498 | 2 | 413 | 8 | ## Client -### Classes - - ### Interfaces diff --git a/api_docs/custom_integrations.mdx b/api_docs/custom_integrations.mdx index 0325ba11ebea6..60d656a3b784c 100644 --- a/api_docs/custom_integrations.mdx +++ b/api_docs/custom_integrations.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/dashboard.devdocs.json b/api_docs/dashboard.devdocs.json index 47b9a84b92b02..62266835082e7 100644 --- a/api_docs/dashboard.devdocs.json +++ b/api_docs/dashboard.devdocs.json @@ -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", diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx index 30d452fec9127..e663e3202746a 100644 --- a/api_docs/dashboard.mdx +++ b/api_docs/dashboard.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx index 5a900660f8d1a..b4af78d01eb6e 100644 --- a/api_docs/dashboard_enhanced.mdx +++ b/api_docs/dashboard_enhanced.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/data.devdocs.json b/api_docs/data.devdocs.json index b194298050a08..40e21806e1bee 100644 --- a/api_docs/data.devdocs.json +++ b/api_docs/data.devdocs.json @@ -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", "" ], - "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: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; 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: { (this: That, params: ", "GetRequest", " | ", @@ -15386,32 +15039,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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", "" ], - "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; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", + ">; delete: (indexPatternId: string) => Promise<{}>; getCanSave: () => Promise; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", diff --git a/api_docs/data.mdx b/api_docs/data.mdx index d2f327f704b20..04fc4ab6136fa 100644 --- a/api_docs/data.mdx +++ b/api_docs/data.mdx @@ -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-25 +date: 2022-07-28 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 diff --git a/api_docs/data_query.devdocs.json b/api_docs/data_query.devdocs.json index bd9bfa16a841d..a3fbc49ce5c30 100644 --- a/api_docs/data_query.devdocs.json +++ b/api_docs/data_query.devdocs.json @@ -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", diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx index cd8f81684c820..3a2fc59091b9d 100644 --- a/api_docs/data_query.mdx +++ b/api_docs/data_query.mdx @@ -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-25 +date: 2022-07-28 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 diff --git a/api_docs/data_search.devdocs.json b/api_docs/data_search.devdocs.json index 70e0543078f6a..e2f77668bb4fb 100644 --- a/api_docs/data_search.devdocs.json +++ b/api_docs/data_search.devdocs.json @@ -323,32 +323,14 @@ "signature": [ "{ create: ({ name, appId, locatorId, initialState, restoreState, sessionId, }: { name: string; appId: string; locatorId: string; initialState: Record; restoreState: Record; sessionId: string; }) => Promise<", "SearchSessionSavedObject", - ">; delete: (sessionId: string) => Promise; 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", ">; 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", ">>; 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; }" ], "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; restoreState: Record; sessionId: string; }) => Promise<", "SearchSessionSavedObject", - ">; delete: (sessionId: string) => Promise; 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", ">; 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", ">>; 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; }" ], "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; restoreState: Record; sessionId: string; }) => Promise<", "SearchSessionSavedObject", - ">; delete: (sessionId: string) => Promise; 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", ">; 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", ">>; 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; }" ], "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 | 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: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; 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", diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx index 38648661fae66..0f9867e3f797d 100644 --- a/api_docs/data_search.mdx +++ b/api_docs/data_search.mdx @@ -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-25 +date: 2022-07-28 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 diff --git a/api_docs/data_view_editor.mdx b/api_docs/data_view_editor.mdx index 61558ccc4caec..cf984e19dd4c0 100644 --- a/api_docs/data_view_editor.mdx +++ b/api_docs/data_view_editor.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/data_view_field_editor.mdx b/api_docs/data_view_field_editor.mdx index bc6a7a489e400..f79c6fe262b2d 100644 --- a/api_docs/data_view_field_editor.mdx +++ b/api_docs/data_view_field_editor.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/data_view_management.mdx b/api_docs/data_view_management.mdx index 91f66526cbe57..db93ab0238a5d 100644 --- a/api_docs/data_view_management.mdx +++ b/api_docs/data_view_management.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/data_views.devdocs.json b/api_docs/data_views.devdocs.json index cf34d189d2a61..cd67eb33822a1 100644 --- a/api_docs/data_views.devdocs.json +++ b/api_docs/data_views.devdocs.json @@ -4134,13 +4134,7 @@ "text": "DataViewAttributes" }, ", options: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, + "SavedObjectsUpdateOptions", ") => Promise<", "SavedObject", ">" @@ -4204,13 +4198,7 @@ "label": "options", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, + "SavedObjectsUpdateOptions", "" ], "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", ">" @@ -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", ") => Promise<", "SavedObject", ">" @@ -5794,13 +5764,7 @@ "- client options" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, + "SavedObjectsUpdateOptions", "" ], "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", ">" @@ -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", ") => Promise<", "SavedObject", ">" @@ -10292,13 +10214,7 @@ "- client options" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, + "SavedObjectsUpdateOptions", "" ], "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", ">" @@ -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: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; 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: { (this: That, params: ", "GetRequest", " | ", @@ -11298,32 +10846,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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", "" ], - "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", ") => Promise<", "SavedObject", ">" @@ -19377,13 +18945,7 @@ "- client options" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, + "SavedObjectsUpdateOptions", "" ], "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", ">" @@ -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; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", + ">; delete: (indexPatternId: string) => Promise<{}>; getCanSave: () => Promise; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<", { "pluginId": "dataViews", "scope": "common", diff --git a/api_docs/data_views.mdx b/api_docs/data_views.mdx index 0c3622e2e8bbf..10cfdf5814b2d 100644 --- a/api_docs/data_views.mdx +++ b/api_docs/data_views.mdx @@ -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-25 +date: 2022-07-28 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 diff --git a/api_docs/data_visualizer.mdx b/api_docs/data_visualizer.mdx index 13c671cdf32a0..4520f85db8c2f 100644 --- a/api_docs/data_visualizer.mdx +++ b/api_docs/data_visualizer.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/deprecations_by_api.mdx b/api_docs/deprecations_by_api.mdx index b7c34a1340efd..d71abd532453f 100644 --- a/api_docs/deprecations_by_api.mdx +++ b/api_docs/deprecations_by_api.mdx @@ -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-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -23,10 +23,12 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | data, discover, embeddable | - | | | advancedSettings, discover | - | | | advancedSettings, discover | - | +| | stackAlerts, alerting, securitySolution, inputControlVis | - | +| | stackAlerts, alerting, securitySolution, inputControlVis | - | | | actions, alerting | - | | | encryptedSavedObjects, actions, data, cloud, ml, logstash, securitySolution | - | | | dashboard, lens, stackAlerts, visTypeTable, visTypeTimeseries, visTypeXy, visTypeVislib, expressionPartitionVis | - | -| | esUiShared, home, data, spaces, fleet, visualizations, lens, observability, ml, apm, cloudSecurityPosture, indexLifecycleManagement, synthetics, upgradeAssistant, ux, savedObjectsManagement, kibanaOverview | - | +| | esUiShared, home, data, spaces, fleet, visualizations, lens, observability, ml, apm, indexLifecycleManagement, synthetics, upgradeAssistant, ux, savedObjectsManagement, kibanaOverview | - | | | dashboard | - | | | dataViews, maps | - | | | dataViews, maps | - | @@ -60,8 +62,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | spaces, savedObjectsManagement | - | | | spaces, savedObjectsManagement | - | | | console, @kbn/core-elasticsearch-server-internal | - | -| | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 | -| | stackAlerts, alerting, securitySolution, inputControlVis | 8.1 | | | embeddable, discover, presentationUtil, dashboard, graph | 8.8.0 | | | spaces, security, alerting | 8.8.0 | | | spaces, security, actions, alerting, ml, remoteClusters, graph, indexLifecycleManagement, mapsEms, painlessLab, rollup, searchprofiler, snapshotRestore, transform, upgradeAssistant | 8.8.0 | @@ -71,8 +71,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | securitySolution | 8.8.0 | | | savedObjectsTaggingOss, visualizations, dashboard, lens | 8.8.0 | | | dashboard | 8.8.0 | -| | dashboard, maps | 8.8.0 | -| | monitoring, kibanaUsageCollection | 8.8.0 | +| | maps, dashboard | 8.8.0 | +| | monitoring, kibanaUsageCollection, @kbn/core-metrics-server-internal | 8.8.0 | | | cloud, apm | 8.8.0 | | | security, licenseManagement, ml, apm, crossClusterReplication, logstash, painlessLab, searchprofiler, watcher | 8.8.0 | | | management, fleet, security, kibanaOverview | 8.8.0 | @@ -139,4 +139,6 @@ Safe to remove. | | @kbn/core-http-browser | | | @kbn/core-injected-metadata-browser | | | @kbn/core-injected-metadata-browser | +| | @kbn/core-metrics-server | +| | @kbn/core-saved-objects-common | | | @kbn/core-ui-settings-common | \ No newline at end of file diff --git a/api_docs/deprecations_by_plugin.mdx b/api_docs/deprecations_by_plugin.mdx index ed5dd2e368bba..3b320c68dac63 100644 --- a/api_docs/deprecations_by_plugin.mdx +++ b/api_docs/deprecations_by_plugin.mdx @@ -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-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana'] warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. --- @@ -32,6 +32,14 @@ so TS and code-reference navigation might not highlight them. | +## @kbn/core-metrics-server-internal + +| Deprecated API | Reference location(s) | Remove By | +| ---------------|-----------|-----------| +| | [ops_metrics_collector.ts](https://github.com/elastic/kibana/tree/master/packages/core/metrics/core-metrics-server-internal/src/ops_metrics_collector.ts#:~:text=process), [get_ops_metrics_log.ts](https://github.com/elastic/kibana/tree/master/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.ts#:~:text=process), [get_ops_metrics_log.test.ts](https://github.com/elastic/kibana/tree/master/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.test.ts#:~:text=process) | 8.8.0 | + + + ## actions | Deprecated API | Reference location(s) | Remove By | @@ -57,9 +65,9 @@ so TS and code-reference navigation might not highlight them. | | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [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) | - | -| | [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 | +| | [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) | - | | | [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) | - | -| | [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 | +| | [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) | - | | | [plugin.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/plugin.test.ts#:~:text=getKibanaFeatures) | 8.8.0 | | | [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 | | | [task.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/usage/task.ts#:~:text=index) | - | @@ -86,7 +94,7 @@ so TS and code-reference navigation might not highlight them. | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getFunction) | - | | | [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.test.ts#:~:text=getFunctions) | - | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getTypes), [application.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/application.tsx#:~:text=getTypes), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getTypes) | - | -| | [state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/state.ts#:~:text=Render), [state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/state.ts#:~:text=Render), [markdown.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts#:~:text=Render), [markdown.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts#:~:text=Render), [timefilterControl.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts#:~:text=Render), [timefilterControl.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts#:~:text=Render), [pie.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/pie.ts#:~:text=Render), [pie.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/pie.ts#:~:text=Render), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/plot/index.ts#:~:text=Render), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/plot/index.ts#:~:text=Render)+ 2 more | - | +| | [markdown.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts#:~:text=Render), [markdown.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts#:~:text=Render), [state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/state.ts#:~:text=Render), [state.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/types/state.ts#:~:text=Render), [timefilterControl.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts#:~:text=Render), [timefilterControl.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/timefilterControl.ts#:~:text=Render), [pie.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/pie.ts#:~:text=Render), [pie.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/pie.ts#:~:text=Render), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/plot/index.ts#:~:text=Render), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/functions/plot/index.ts#:~:text=Render)+ 2 more | - | | | [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/demodata/index.ts#:~:text=context), [embeddable.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/external/embeddable.ts#:~:text=context), [esdocs.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/esdocs.ts#:~:text=context), [escount.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/browser/escount.ts#:~:text=context), [filters.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/common/functions/filters.ts#:~:text=context), [neq.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/common/neq.ts#:~:text=context), [index.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/canvas_plugin_src/functions/server/pointseries/index.ts#:~:text=context) | - | | | [setup_expressions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/public/setup_expressions.ts#:~:text=getFunction) | - | | | [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.ts#:~:text=getFunctions), [functions.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/canvas/server/routes/functions/functions.test.ts#:~:text=getFunctions) | - | @@ -105,14 +113,6 @@ so TS and code-reference navigation might not highlight them. | -## cloudSecurityPosture - -| Deprecated API | Reference location(s) | Remove By | -| ---------------|-----------|-----------| -| | [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/application/app.tsx#:~:text=RedirectAppLinks), [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/application/app.tsx#:~:text=RedirectAppLinks), [app.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cloud_security_posture/public/application/app.tsx#:~:text=RedirectAppLinks) | - | - - - ## console | Deprecated API | Reference location(s) | Remove By | @@ -299,9 +299,9 @@ so TS and code-reference navigation might not highlight them. | | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [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 | +| | [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) | - | | | [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) | - | -| | [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 | +| | [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) | - | @@ -534,10 +534,10 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| | | [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) | - | -| | [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 | +| | [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) | - | | | [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) | - | | | [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) | - | -| | [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 | +| | [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) | - | | | [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 | | | [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 | | | [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) | - | @@ -571,10 +571,10 @@ migrates to using the Kibana Privilege model: https://github.com/elastic/kibana/ | Deprecated API | Reference location(s) | Remove By | | ---------------|-----------|-----------| -| | [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 | +| | [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) | - | | | [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) | - | | | [expression.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/stack_alerts/public/alert_types/threshold/expression.tsx#:~:text=fieldFormats) | - | -| | [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 | +| | [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) | - | diff --git a/api_docs/deprecations_by_team.mdx b/api_docs/deprecations_by_team.mdx index a2f6ac121a73f..efa1411125c10 100644 --- a/api_docs/deprecations_by_team.mdx +++ b/api_docs/deprecations_by_team.mdx @@ -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-25 +date: 2022-07-28 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 | | [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 | | [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 | | [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 | | [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 | | [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 | | [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 | | [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 | | [plugin.test.ts](https://github.com/elastic/kibana/tree/master/x-pack/plugins/alerting/server/plugin.test.ts#:~:text=getKibanaFeatures) | 8.8.0 | | alerting | | [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 | | [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 | | [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 | | [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 | | [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 | | [index.tsx](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/app/index.tsx#:~:text=onAppLeave) | 8.8.0 | @@ -201,4 +195,5 @@ so TS and code-reference navigation might not highlight them. | | @kbn/core-http-browser-internal | | [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res), [http_fetch_error.ts](https://github.com/elastic/kibana/tree/master/packages/core/http/core-http-browser-internal/src/http_fetch_error.ts#:~:text=res) | 8.8.0 Note to maintainers: when looking at usages, mind that typical use could be inside a `catch` block, -so TS and code-reference navigation might not highlight them. | \ No newline at end of file +so TS and code-reference navigation might not highlight them. | +| @kbn/core-metrics-server-internal | | [ops_metrics_collector.ts](https://github.com/elastic/kibana/tree/master/packages/core/metrics/core-metrics-server-internal/src/ops_metrics_collector.ts#:~:text=process), [get_ops_metrics_log.ts](https://github.com/elastic/kibana/tree/master/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.ts#:~:text=process), [get_ops_metrics_log.test.ts](https://github.com/elastic/kibana/tree/master/packages/core/metrics/core-metrics-server-internal/src/logging/get_ops_metrics_log.test.ts#:~:text=process) | 8.8.0 | \ No newline at end of file diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx index 4d4d3c8a66789..ff289623ce6aa 100644 --- a/api_docs/dev_tools.mdx +++ b/api_docs/dev_tools.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/discover.devdocs.json b/api_docs/discover.devdocs.json index 558ae3d9d0452..905a9ba0db21d 100644 --- a/api_docs/discover.devdocs.json +++ b/api_docs/discover.devdocs.json @@ -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", diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx index cbd1a280af510..2e162d55edc5f 100644 --- a/api_docs/discover.mdx +++ b/api_docs/discover.mdx @@ -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-25 +date: 2022-07-28 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 diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx index facd0dd2b2486..5952ff8311ff2 100644 --- a/api_docs/discover_enhanced.mdx +++ b/api_docs/discover_enhanced.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/elastic_apm_synthtrace.mdx b/api_docs/elastic_apm_synthtrace.mdx index 5ba7415409db2..3ed898389108f 100644 --- a/api_docs/elastic_apm_synthtrace.mdx +++ b/api_docs/elastic_apm_synthtrace.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/embeddable.devdocs.json b/api_docs/embeddable.devdocs.json index a7343bfe9f6c9..836f7d92bb5cd 100644 --- a/api_docs/embeddable.devdocs.json +++ b/api_docs/embeddable.devdocs.json @@ -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", diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx index decc6fe39b002..077f1fb889d17 100644 --- a/api_docs/embeddable.mdx +++ b/api_docs/embeddable.mdx @@ -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-25 +date: 2022-07-28 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 diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx index 0eb8a45fb7501..bb287231f4f97 100644 --- a/api_docs/embeddable_enhanced.mdx +++ b/api_docs/embeddable_enhanced.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/encrypted_saved_objects.devdocs.json b/api_docs/encrypted_saved_objects.devdocs.json index 9423813bd2bd9..f68665e4ae65a 100644 --- a/api_docs/encrypted_saved_objects.devdocs.json +++ b/api_docs/encrypted_saved_objects.devdocs.json @@ -402,13 +402,7 @@ "description": [], "signature": [ "(type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, + "SavedObjectsBaseOptions", " | undefined) => Promise<", "SavedObject", ">" @@ -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": [ "(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", ">" ], "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", diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx index 4850b00506010..f984af2467f57 100644 --- a/api_docs/encrypted_saved_objects.mdx +++ b/api_docs/encrypted_saved_objects.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/enterprise_search.devdocs.json b/api_docs/enterprise_search.devdocs.json index 18f9b884e77d7..4518c1110b7b1 100644 --- a/api_docs/enterprise_search.devdocs.json +++ b/api_docs/enterprise_search.devdocs.json @@ -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", - "; accessCheckTimeout: ", + "<{ accessCheckTimeout: ", "Type", "; accessCheckTimeoutWarning: ", "Type", - "; ssl: ", + "; customHeaders: ", + "Type", + " | undefined>; host: ", + "Type", + "; ssl: ", "ObjectType", "<{ certificateAuthorities: ", "Type", "; verificationMode: ", "Type", - "<\"none\" | \"full\" | \"certificate\">; }>; customHeaders: ", - "Type", - " | undefined>; }>" + "<\"none\" | \"full\" | \"certificate\">; }>; }>" ], "path": "x-pack/plugins/enterprise_search/server/index.ts", "deprecated": false, diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx index a3b8f1389f601..74ff752797682 100644 --- a/api_docs/enterprise_search.mdx +++ b/api_docs/enterprise_search.mdx @@ -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-25 +date: 2022-07-28 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 diff --git a/api_docs/es_ui_shared.devdocs.json b/api_docs/es_ui_shared.devdocs.json index 4202f9a4377f9..18fe88540dc40 100644 --- a/api_docs/es_ui_shared.devdocs.json +++ b/api_docs/es_ui_shared.devdocs.json @@ -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 diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx index 198e13afcb211..9b4c88d3f3835 100644 --- a/api_docs/es_ui_shared.mdx +++ b/api_docs/es_ui_shared.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/event_annotation.mdx b/api_docs/event_annotation.mdx index ba67617f018e3..a9e7dde66b1cc 100644 --- a/api_docs/event_annotation.mdx +++ b/api_docs/event_annotation.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx index 062d5f2e698ef..22407f8a41bda 100644 --- a/api_docs/event_log.mdx +++ b/api_docs/event_log.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/expression_error.mdx b/api_docs/expression_error.mdx index 9571784b2d30a..ef29544d9d5fe 100644 --- a/api_docs/expression_error.mdx +++ b/api_docs/expression_error.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/expression_gauge.mdx b/api_docs/expression_gauge.mdx index 7df785946005c..e929965d8b206 100644 --- a/api_docs/expression_gauge.mdx +++ b/api_docs/expression_gauge.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/expression_heatmap.mdx b/api_docs/expression_heatmap.mdx index 35ab1eeec5ff2..46da1156da752 100644 --- a/api_docs/expression_heatmap.mdx +++ b/api_docs/expression_heatmap.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/expression_image.mdx b/api_docs/expression_image.mdx index d0e3a2f9e4710..21227d4d2127a 100644 --- a/api_docs/expression_image.mdx +++ b/api_docs/expression_image.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/expression_legacy_metric_vis.mdx b/api_docs/expression_legacy_metric_vis.mdx index 8dc562688ec7d..5549581d1ae5c 100644 --- a/api_docs/expression_legacy_metric_vis.mdx +++ b/api_docs/expression_legacy_metric_vis.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/expression_metric.mdx b/api_docs/expression_metric.mdx index 70e487f7c8816..ac970695e3f27 100644 --- a/api_docs/expression_metric.mdx +++ b/api_docs/expression_metric.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/expression_metric_vis.devdocs.json b/api_docs/expression_metric_vis.devdocs.json index 65485ff919e65..33d81d3ba1c61 100644 --- a/api_docs/expression_metric_vis.devdocs.json +++ b/api_docs/expression_metric_vis.devdocs.json @@ -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" @@ -240,34 +370,26 @@ }, { "parentPluginId": "expressionMetricVis", - "id": "def-common.MetricArguments.progressMax", + "id": "def-common.MetricArguments.progressDirection", "type": "CompoundType", "tags": [], - "label": "progressMax", + "label": "progressDirection", "description": [], "signature": [ - "string | ", - { - "pluginId": "visualizations", - "scope": "common", - "docId": "kibVisualizationsPluginApi", - "section": "def-common.ExpressionValueVisDimension", - "text": "ExpressionValueVisDimension" - }, - " | undefined" + "\"horizontal\" | \"vertical\"" ], "path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts", "deprecated": false }, { "parentPluginId": "expressionMetricVis", - "id": "def-common.MetricArguments.progressDirection", - "type": "CompoundType", + "id": "def-common.MetricArguments.color", + "type": "string", "tags": [], - "label": "progressDirection", + "label": "color", "description": [], "signature": [ - "\"horizontal\" | \"vertical\"" + "string | undefined" ], "path": "src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts", "deprecated": false @@ -434,10 +556,23 @@ }, { "parentPluginId": "expressionMetricVis", - "id": "def-common.MetricVisParam.extraText", + "id": "def-common.MetricVisParam.secondaryPrefix", + "type": "string", + "tags": [], + "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": "extraText", + "label": "color", "description": [], "signature": [ "string | undefined" diff --git a/api_docs/expression_metric_vis.mdx b/api_docs/expression_metric_vis.mdx index 12d537a8b96d1..5b93f343c6c35 100644 --- a/api_docs/expression_metric_vis.mdx +++ b/api_docs/expression_metric_vis.mdx @@ -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-25 +date: 2022-07-28 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 + ## Common diff --git a/api_docs/expression_partition_vis.mdx b/api_docs/expression_partition_vis.mdx index 2e884a38ff280..a8cd7fc730c7e 100644 --- a/api_docs/expression_partition_vis.mdx +++ b/api_docs/expression_partition_vis.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/expression_repeat_image.mdx b/api_docs/expression_repeat_image.mdx index 85fc81011e933..10d7702c536cb 100644 --- a/api_docs/expression_repeat_image.mdx +++ b/api_docs/expression_repeat_image.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/expression_reveal_image.mdx b/api_docs/expression_reveal_image.mdx index 1efde7185a94f..326484c20b0fb 100644 --- a/api_docs/expression_reveal_image.mdx +++ b/api_docs/expression_reveal_image.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/expression_shape.mdx b/api_docs/expression_shape.mdx index cd22557118dfd..a09923e5e42ff 100644 --- a/api_docs/expression_shape.mdx +++ b/api_docs/expression_shape.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/expression_tagcloud.mdx b/api_docs/expression_tagcloud.mdx index 083ed5e42d5a5..690d8d1217426 100644 --- a/api_docs/expression_tagcloud.mdx +++ b/api_docs/expression_tagcloud.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/expression_x_y.mdx b/api_docs/expression_x_y.mdx index ebeb5a6a6c320..f77448d5c97b9 100644 --- a/api_docs/expression_x_y.mdx +++ b/api_docs/expression_x_y.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/expressions.devdocs.json b/api_docs/expressions.devdocs.json index 5a5acc6595d1b..aeff5f00d09e2 100644 --- a/api_docs/expressions.devdocs.json +++ b/api_docs/expressions.devdocs.json @@ -3532,7 +3532,7 @@ "id": "def-public.ExpressionRenderHandler.Unnamed.$2", "type": "Object", "tags": [], - "label": "{\n onRenderError,\n renderMode,\n syncColors,\n syncTooltips,\n interactive,\n hasCompatibleActions = async () => false,\n }", + "label": "{\n onRenderError,\n renderMode,\n syncColors,\n syncTooltips,\n interactive,\n hasCompatibleActions = async () => false,\n executionContext,\n }", "description": [], "signature": [ "ExpressionRenderHandlerParams" @@ -10465,6 +10465,23 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-public.IInterpreterRenderHandlers.getExecutionContext", + "type": "Function", + "tags": [], + "label": "getExecutionContext", + "description": [], + "signature": [ + "() => ", + "KibanaExecutionContext", + " | undefined" + ], + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -19677,6 +19694,23 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-server.IInterpreterRenderHandlers.getExecutionContext", + "type": "Function", + "tags": [], + "label": "getExecutionContext", + "description": [], + "signature": [ + "() => ", + "KibanaExecutionContext", + " | undefined" + ], + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -32798,6 +32832,23 @@ ], "path": "src/plugins/expressions/common/expression_renderers/types.ts", "deprecated": false + }, + { + "parentPluginId": "expressions", + "id": "def-common.IInterpreterRenderHandlers.getExecutionContext", + "type": "Function", + "tags": [], + "label": "getExecutionContext", + "description": [], + "signature": [ + "() => ", + "KibanaExecutionContext", + " | undefined" + ], + "path": "src/plugins/expressions/common/expression_renderers/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -34819,19 +34870,19 @@ "references": [ { "plugin": "canvas", - "path": "x-pack/plugins/canvas/types/state.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/types/state.ts" + "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts" + "path": "x-pack/plugins/canvas/types/state.ts" }, { "plugin": "canvas", - "path": "x-pack/plugins/canvas/canvas_plugin_src/functions/browser/markdown.ts" + "path": "x-pack/plugins/canvas/types/state.ts" }, { "plugin": "canvas", diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx index e16ab9f61112c..9a4044df83397 100644 --- a/api_docs/expressions.mdx +++ b/api_docs/expressions.mdx @@ -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-25 +date: 2022-07-28 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. --- @@ -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 | |-------------------|-----------|------------------------|-----------------| -| 2180 | 17 | 1726 | 5 | +| 2183 | 17 | 1729 | 5 | ## Client diff --git a/api_docs/features.devdocs.json b/api_docs/features.devdocs.json index 64be256167cf0..c8393bb27b15e 100644 --- a/api_docs/features.devdocs.json +++ b/api_docs/features.devdocs.json @@ -61,7 +61,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -1126,7 +1126,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -2721,7 +2721,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; requireAllSpaces?: boolean | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>" ], "path": "x-pack/plugins/features/common/kibana_feature.ts", "deprecated": false, @@ -2954,7 +2954,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>" ], "path": "x-pack/plugins/features/common/sub_feature.ts", "deprecated": false, @@ -2989,7 +2989,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]" ], "path": "x-pack/plugins/features/common/sub_feature.ts", "deprecated": false @@ -3010,7 +3010,7 @@ "section": "def-common.SubFeaturePrivilegeGroupType", "text": "SubFeaturePrivilegeGroupType" }, - "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }" + "; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"none\" | \"all\" | \"read\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; disabled?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: Readonly<{ rule?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; alert?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; }> | undefined; cases?: Readonly<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; }> | undefined; ui: readonly string[]; app?: readonly string[] | undefined; requireAllSpaces?: boolean | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }" ], "path": "x-pack/plugins/features/common/sub_feature.ts", "deprecated": false, diff --git a/api_docs/features.mdx b/api_docs/features.mdx index c08f02b79acce..927bc15d3dcb3 100644 --- a/api_docs/features.mdx +++ b/api_docs/features.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/field_formats.mdx b/api_docs/field_formats.mdx index 39b4434d80a71..18c19df767702 100644 --- a/api_docs/field_formats.mdx +++ b/api_docs/field_formats.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx index aaf2ff28bf05e..12f1e41612cc3 100644 --- a/api_docs/file_upload.mdx +++ b/api_docs/file_upload.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/fleet.devdocs.json b/api_docs/fleet.devdocs.json index 710982e7065b1..af00375337477 100644 --- a/api_docs/fleet.devdocs.json +++ b/api_docs/fleet.devdocs.json @@ -458,6 +458,32 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "fleet", + "id": "def-public.DynamicPagePathValues", + "type": "Interface", + "tags": [], + "label": "DynamicPagePathValues", + "description": [], + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-public.DynamicPagePathValues.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: string | boolean", + "description": [], + "signature": [ + "[key: string]: string | boolean" + ], + "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "fleet", "id": "def-public.IntegrationsAppBrowseRouteState", @@ -1803,10 +1829,10 @@ "id": "def-public.UIExtensionsStorage.Unnamed", "type": "IndexSignature", "tags": [], - "label": "[key: string]: Partial>", + "label": "[key: string]: Partial>", "description": [], "signature": [ - "[key: string]: Partial [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2445,7 +2477,13 @@ "label": "{ pkgkey, integration }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2463,7 +2501,13 @@ "description": [], "signature": [ "({ pkgkey, integration, addAgentToPolicyId }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2477,7 +2521,13 @@ "label": "{ pkgkey, integration, addAgentToPolicyId }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2495,7 +2545,13 @@ "description": [], "signature": [ "({ pkgkey, integration }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2509,7 +2565,13 @@ "label": "{ pkgkey, integration }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2527,7 +2589,13 @@ "description": [], "signature": [ "({ pkgkey, integration }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2541,7 +2609,13 @@ "label": "{ pkgkey, integration }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2559,7 +2633,13 @@ "description": [], "signature": [ "({ pkgkey, integration }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2573,7 +2653,13 @@ "label": "{ pkgkey, integration }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2591,7 +2677,13 @@ "description": [], "signature": [ "({ packagePolicyId }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2605,7 +2697,13 @@ "label": "{ packagePolicyId }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2625,7 +2723,13 @@ ], "signature": [ "({ packagePolicyId }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2639,7 +2743,13 @@ "label": "{ packagePolicyId }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2687,7 +2797,13 @@ "description": [], "signature": [ "({ policyId, tabId }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2701,7 +2817,13 @@ "label": "{ policyId, tabId }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2719,7 +2841,13 @@ "description": [], "signature": [ "({ pkgkey, integration, agentPolicyId, useMultiPageLayout }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2733,7 +2861,13 @@ "label": "{ pkgkey, integration, agentPolicyId, useMultiPageLayout }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2751,7 +2885,13 @@ "description": [], "signature": [ "({ policyId, packagePolicyId }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2765,7 +2905,13 @@ "label": "{ policyId, packagePolicyId }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2783,7 +2929,13 @@ "description": [], "signature": [ "({ policyId, packagePolicyId }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2797,7 +2949,13 @@ "label": "{ policyId, packagePolicyId }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2815,7 +2973,13 @@ "description": [], "signature": [ "({ kuery }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2829,7 +2993,13 @@ "label": "{ kuery }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2847,7 +3017,13 @@ "description": [], "signature": [ "({ agentId, tabId, logQuery }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2861,7 +3037,13 @@ "label": "{ agentId, tabId, logQuery }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2879,7 +3061,13 @@ "description": [], "signature": [ "({ agentId }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2893,7 +3081,13 @@ "label": "{ agentId }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -2971,7 +3165,13 @@ "description": [], "signature": [ "({ outputId }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -2985,7 +3185,13 @@ "label": "{ outputId }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -3003,7 +3209,13 @@ "description": [], "signature": [ "({ downloadSourceId }: ", - "DynamicPagePathValues", + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + }, ") => [string, string]" ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", @@ -3017,7 +3229,13 @@ "label": "{ downloadSourceId }", "description": [], "signature": [ - "DynamicPagePathValues" + { + "pluginId": "fleet", + "scope": "public", + "docId": "kibFleetPluginApi", + "section": "def-public.DynamicPagePathValues", + "text": "DynamicPagePathValues" + } ], "path": "x-pack/plugins/fleet/public/constants/page_paths.ts", "deprecated": false, @@ -3541,13 +3759,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", id: string, withPackagePolicies?: boolean) => Promise<", { "pluginId": "fleet", @@ -3570,331 +3782,7 @@ "label": "soClient", "description": [], "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/agent_policy.ts", "deprecated": false @@ -3930,13 +3818,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", options: Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { withPackagePolicies?: boolean | undefined; }) => Promise<{ items: ", { "pluginId": "fleet", @@ -3959,331 +3841,7 @@ "label": "soClient", "description": [], "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/agent_policy.ts", "deprecated": false @@ -4312,13 +3870,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", id: string, options?: { standalone: boolean; } | undefined) => Promise<", { "pluginId": "fleet", @@ -4341,331 +3893,7 @@ "label": "soClient", "description": [], "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/agent_policy.ts", "deprecated": false @@ -4704,13 +3932,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", ids: string[], options?: { fields?: string[] | undefined; }) => Promise<", { "pluginId": "fleet", @@ -4733,331 +3955,7 @@ "label": "soClient", "description": [], "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/agent_policy.ts", "deprecated": false @@ -5482,13 +4380,7 @@ "description": [], "signature": [ "(savedObjectsClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", pkgName: string, datasetPath: string) => Promise" ], "path": "x-pack/plugins/fleet/server/services/index.ts", @@ -5502,13 +4394,7 @@ "label": "savedObjectsClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/index.ts", "deprecated": false, @@ -6004,13 +4890,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", esClient: ", "ElasticsearchClient", ", packagePolicy: ", @@ -6050,13 +4930,7 @@ "label": "soClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, @@ -6231,13 +5105,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", esClient: ", "ElasticsearchClient", ", packagePolicies: ", @@ -6277,13 +5145,7 @@ "label": "soClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, @@ -6395,13 +5257,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", id: string) => Promise<", { "pluginId": "fleet", @@ -6423,13 +5279,7 @@ "label": "soClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, @@ -6461,13 +5311,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", ids: string[]) => Promise<", { "pluginId": "fleet", @@ -6489,13 +5333,7 @@ "label": "soClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, @@ -6527,13 +5365,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", options: ", { "pluginId": "fleet", @@ -6571,13 +5403,7 @@ "label": "soClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, @@ -6615,13 +5441,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", options: ", { "pluginId": "fleet", @@ -6651,13 +5471,7 @@ "label": "soClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, @@ -6695,13 +5509,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", esClient: ", "ElasticsearchClient", ", id: string, packagePolicyUpdate: ", @@ -6741,13 +5549,7 @@ "label": "soClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, @@ -6872,13 +5674,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", esClient: ", "ElasticsearchClient", ", ids: string[], options?: { user?: ", @@ -6910,13 +5706,7 @@ "label": "soClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, @@ -7020,13 +5810,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", esClient: ", "ElasticsearchClient", ", ids: string[], options?: { user?: ", @@ -7066,13 +5850,7 @@ "label": "soClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, @@ -7185,13 +5963,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", id: string, packagePolicy?: ", { "pluginId": "fleet", @@ -7221,13 +5993,7 @@ "label": "soClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, @@ -7294,13 +6060,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", newPolicy: ", { "pluginId": "fleet", @@ -7330,13 +6090,7 @@ "label": "soClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, @@ -7374,14 +6128,10 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, - ", pkgName: string) => Promise<", + "SavedObjectsClientContract", + ", pkgName: string, logger?: ", + "Logger", + " | undefined) => Promise<", { "pluginId": "fleet", "scope": "common", @@ -7402,13 +6152,7 @@ "label": "soClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, @@ -7427,6 +6171,21 @@ "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, "isRequired": true + }, + { + "parentPluginId": "fleet", + "id": "def-server.PackagePolicyServiceInterface.buildPackagePolicyFromPackage.$3", + "type": "Object", + "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger", + " | undefined" + ], + "path": "x-pack/plugins/fleet/server/services/package_policy.ts", + "deprecated": false, + "isRequired": false } ], "returnComment": [] @@ -7636,13 +6395,7 @@ "description": [], "signature": [ "(soClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", id: string) => Promise<{ packagePolicy: ", { "pluginId": "fleet", @@ -7672,13 +6425,7 @@ "label": "soClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "x-pack/plugins/fleet/server/services/package_policy.ts", "deprecated": false, @@ -8414,350 +7161,236 @@ } }, "common": { - "classes": [ + "classes": [], + "functions": [ { "parentPluginId": "fleet", - "id": "def-common.LicenseService", - "type": "Class", + "id": "def-common.createFleetAuthzMock", + "type": "Function", "tags": [], - "label": "LicenseService", + "label": "createFleetAuthzMock", + "description": [ + "\nCreates mock `authz` object" + ], + "signature": [ + "() => ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FleetAuthz", + "text": "FleetAuthz" + } + ], + "path": "x-pack/plugins/fleet/common/mocks.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.decodeCloudId", + "type": "Function", + "tags": [], + "label": "decodeCloudId", "description": [], - "path": "x-pack/plugins/fleet/common/services/license.ts", + "signature": [ + "(cid: string) => { host: string; defaultPort: string; elasticsearchUrl: string; kibanaUrl: string; } | undefined" + ], + "path": "x-pack/plugins/fleet/common/services/decode_cloud_id.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.LicenseService.start", - "type": "Function", - "tags": [], - "label": "start", - "description": [], - "signature": [ - "(license$: ", - "Observable", - "<", - "ILicense", - ">) => void" - ], - "path": "x-pack/plugins/fleet/common/services/license.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.LicenseService.start.$1", - "type": "Object", - "tags": [], - "label": "license$", - "description": [], - "signature": [ - "Observable", - "<", - "ILicense", - ">" - ], - "path": "x-pack/plugins/fleet/common/services/license.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.LicenseService.stop", - "type": "Function", + "id": "def-common.decodeCloudId.$1", + "type": "string", "tags": [], - "label": "stop", + "label": "cid", "description": [], "signature": [ - "() => void" + "string" ], - "path": "x-pack/plugins/fleet/common/services/license.ts", + "path": "x-pack/plugins/fleet/common/services/decode_cloud_id.ts", "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.LicenseService.getLicenseInformation", - "type": "Function", - "tags": [], - "label": "getLicenseInformation", - "description": [], - "signature": [ - "() => ", - "ILicense", - " | null" - ], - "path": "x-pack/plugins/fleet/common/services/license.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.LicenseService.getLicenseInformation$", - "type": "Function", - "tags": [], - "label": "getLicenseInformation$", - "description": [], - "signature": [ - "() => ", - "Observable", - "<", - "ILicense", - "> | null" - ], - "path": "x-pack/plugins/fleet/common/services/license.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.LicenseService.isGoldPlus", - "type": "Function", - "tags": [], - "label": "isGoldPlus", - "description": [], - "signature": [ - "() => boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/services/license.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.LicenseService.isEnterprise", - "type": "Function", - "tags": [], - "label": "isEnterprise", - "description": [], - "signature": [ - "() => boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/services/license.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.LicenseService.hasAtLeast", - "type": "Function", - "tags": [], - "label": "hasAtLeast", - "description": [], - "signature": [ - "(licenseType: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/services/license.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.LicenseService.hasAtLeast.$1", - "type": "CompoundType", - "tags": [], - "label": "licenseType", - "description": [], - "signature": [ - "\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\"" - ], - "path": "x-pack/plugins/fleet/common/services/license.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] + "isRequired": true } ], + "returnComment": [], "initialIsOpen": false - } - ], - "functions": [ + }, { "parentPluginId": "fleet", - "id": "def-common.calculateAuthz", + "id": "def-common.isValidNamespace", "type": "Function", "tags": [], - "label": "calculateAuthz", + "label": "isValidNamespace", "description": [], "signature": [ - "({ fleet, integrations, isSuperuser, }: CalculateParams) => ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.FleetAuthz", - "text": "FleetAuthz" - } + "(namespace: string) => { valid: boolean; error?: string | undefined; }" ], - "path": "x-pack/plugins/fleet/common/authz.ts", + "path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.calculateAuthz.$1", - "type": "Object", + "id": "def-common.isValidNamespace.$1", + "type": "string", "tags": [], - "label": "{\n fleet,\n integrations,\n isSuperuser,\n}", + "label": "namespace", "description": [], "signature": [ - "CalculateParams" + "string" ], - "path": "x-pack/plugins/fleet/common/authz.ts", + "path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts", "deprecated": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false - }, + } + ], + "interfaces": [ { "parentPluginId": "fleet", - "id": "def-common.countValidationErrors", - "type": "Function", + "id": "def-common.Agent", + "type": "Interface", "tags": [], - "label": "countValidationErrors", + "label": "Agent", "description": [], "signature": [ - "(validationResults: ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigValidationResults", - "text": "PackagePolicyConfigValidationResults" + "section": "def-common.Agent", + "text": "Agent" }, - " | ", + " extends AgentBase" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false, + "children": [ { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyValidationResults", - "text": "PackagePolicyValidationResults" + "parentPluginId": "fleet", + "id": "def-common.Agent.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false }, - " | ", { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyInputValidationResults", - "text": "PackagePolicyInputValidationResults" + "parentPluginId": "fleet", + "id": "def-common.Agent.access_api_key", + "type": "string", + "tags": [], + "label": "access_api_key", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.Agent.default_api_key_history", + "type": "Array", + "tags": [], + "label": "default_api_key_history", + "description": [], + "signature": [ + "{ id: string; retired_at: string; }[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false }, - ") => number" - ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "children": [ { "parentPluginId": "fleet", - "id": "def-common.countValidationErrors.$1", + "id": "def-common.Agent.status", "type": "CompoundType", "tags": [], - "label": "validationResults", + "label": "status", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigValidationResults", - "text": "PackagePolicyConfigValidationResults" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyValidationResults", - "text": "PackagePolicyValidationResults" + "section": "def-common.AgentStatus", + "text": "AgentStatus" }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyInputValidationResults", - "text": "PackagePolicyInputValidationResults" - } + " | undefined" ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.createFleetAuthzMock", - "type": "Function", - "tags": [], - "label": "createFleetAuthzMock", - "description": [ - "\nCreates mock `authz` object" - ], - "signature": [ - "() => ", + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.FleetAuthz", - "text": "FleetAuthz" + "parentPluginId": "fleet", + "id": "def-common.Agent.packages", + "type": "Array", + "tags": [], + "label": "packages", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.Agent.sort", + "type": "Array", + "tags": [], + "label": "sort", + "description": [], + "signature": [ + "(string | number | null)[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false } ], - "path": "x-pack/plugins/fleet/common/mocks.ts", - "deprecated": false, - "children": [], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.decodeCloudId", - "type": "Function", + "id": "def-common.AgentMetadata", + "type": "Interface", "tags": [], - "label": "decodeCloudId", + "label": "AgentMetadata", "description": [], - "signature": [ - "(cid: string) => { host: string; defaultPort: string; elasticsearchUrl: string; kibanaUrl: string; } | undefined" - ], - "path": "x-pack/plugins/fleet/common/services/decode_cloud_id.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.decodeCloudId.$1", - "type": "string", + "id": "def-common.AgentMetadata.Unnamed", + "type": "IndexSignature", "tags": [], - "label": "cid", + "label": "[x: string]: any", "description": [], "signature": [ - "string" + "[x: string]: any" ], - "path": "x-pack/plugins/fleet/common/services/decode_cloud_id.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.doesAgentPolicyAlreadyIncludePackage", - "type": "Function", + "id": "def-common.AgentPolicy", + "type": "Interface", "tags": [], - "label": "doesAgentPolicyAlreadyIncludePackage", + "label": "AgentPolicy", "description": [], "signature": [ - "(agentPolicy: ", { "pluginId": "fleet", "scope": "common", @@ -8765,1479 +7398,1149 @@ "section": "def-common.AgentPolicy", "text": "AgentPolicy" }, - ", packageName: string) => boolean" - ], - "path": "x-pack/plugins/fleet/common/services/limited_package.ts", - "deprecated": false, - "children": [ + " extends Omit<", { - "parentPluginId": "fleet", - "id": "def-common.doesAgentPolicyAlreadyIncludePackage.$1", - "type": "Object", - "tags": [], - "label": "agentPolicy", - "description": [], - "signature": [ + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewAgentPolicy", + "text": "NewAgentPolicy" + }, + ", \"id\">" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.AgentPolicy.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AgentPolicy.status", + "type": "CompoundType", + "tags": [], + "label": "status", + "description": [], + "signature": [ + "\"active\" | \"inactive\"" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AgentPolicy.package_policies", + "type": "CompoundType", + "tags": [], + "label": "package_policies", + "description": [], + "signature": [ + "string[] | ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.AgentPolicy", - "text": "AgentPolicy" - } + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + }, + "[]" ], - "path": "x-pack/plugins/fleet/common/services/limited_package.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AgentPolicy.is_managed", + "type": "boolean", + "tags": [], + "label": "is_managed", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.doesAgentPolicyAlreadyIncludePackage.$2", + "id": "def-common.AgentPolicy.updated_at", + "type": "string", + "tags": [], + "label": "updated_at", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AgentPolicy.updated_by", "type": "string", "tags": [], - "label": "packageName", + "label": "updated_by", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AgentPolicy.revision", + "type": "number", + "tags": [], + "label": "revision", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AgentPolicy.agents", + "type": "number", + "tags": [], + "label": "agents", "description": [], "signature": [ - "string" + "number | undefined" ], - "path": "x-pack/plugins/fleet/common/services/limited_package.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.doesPackageHaveIntegrations", - "type": "Function", + "id": "def-common.AssetParts", + "type": "Interface", "tags": [], - "label": "doesPackageHaveIntegrations", + "label": "AssetParts", "description": [], - "signature": [ - "(pkgInfo: ", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "children": [ { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" + "parentPluginId": "fleet", + "id": "def-common.AssetParts.pkgkey", + "type": "string", + "tags": [], + "label": "pkgkey", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false }, - " | ", { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageListItem", - "text": "PackageListItem" + "parentPluginId": "fleet", + "id": "def-common.AssetParts.dataset", + "type": "string", + "tags": [], + "label": "dataset", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AssetParts.service", + "type": "CompoundType", + "tags": [], + "label": "service", + "description": [], + "signature": [ + "\"kibana\" | \"elasticsearch\"" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false }, - ") => boolean" - ], - "path": "x-pack/plugins/fleet/common/services/packages_with_integrations.ts", - "deprecated": false, - "children": [ { "parentPluginId": "fleet", - "id": "def-common.doesPackageHaveIntegrations.$1", + "id": "def-common.AssetParts.type", "type": "CompoundType", "tags": [], - "label": "pkgInfo", + "label": "type", "description": [], "signature": [ + "\"input\" | ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" + "section": "def-common.ElasticsearchAssetType", + "text": "ElasticsearchAssetType" }, " | ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackageListItem", - "text": "PackageListItem" + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" + }, + " | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.DocAssetType", + "text": "DocAssetType" } ], - "path": "x-pack/plugins/fleet/common/services/packages_with_integrations.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AssetParts.file", + "type": "string", + "tags": [], + "label": "file", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.entries", - "type": "Function", + "id": "def-common.BulkInstallPackageInfo", + "type": "Interface", "tags": [], - "label": "entries", + "label": "BulkInstallPackageInfo", "description": [], - "signature": [ - "(o: T) => [keyof T, T[keyof T]][]" - ], - "path": "x-pack/plugins/fleet/common/types/index.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false, - "returnComment": [], "children": [ { "parentPluginId": "fleet", - "id": "def-common.entries.$1", - "type": "Uncategorized", + "id": "def-common.BulkInstallPackageInfo.name", + "type": "string", "tags": [], - "label": "o", + "label": "name", "description": [], - "signature": [ - "T" - ], - "path": "x-pack/plugins/fleet/common/types/index.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.fullAgentPolicyToYaml", - "type": "Function", - "tags": [], - "label": "fullAgentPolicyToYaml", - "description": [], - "signature": [ - "(policy: ", + }, { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicy", - "text": "FullAgentPolicy" + "parentPluginId": "fleet", + "id": "def-common.BulkInstallPackageInfo.version", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "deprecated": false }, - ", toYaml: (obj: any, opts?: jsyaml.DumpOptions | undefined) => string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts", - "deprecated": false, - "children": [ { "parentPluginId": "fleet", - "id": "def-common.fullAgentPolicyToYaml.$1", + "id": "def-common.BulkInstallPackageInfo.result", "type": "Object", "tags": [], - "label": "policy", + "label": "result", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicy", - "text": "FullAgentPolicy" + "section": "def-common.InstallResult", + "text": "InstallResult" } ], - "path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "fleet", - "id": "def-common.fullAgentPolicyToYaml.$2", - "type": "Function", - "tags": [], - "label": "toYaml", - "description": [], - "signature": [ - "typeof jsyaml.safeDump" - ], - "path": "x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.getComponentTemplateNameForDatastream", - "type": "Function", + "id": "def-common.BulkInstallPackagesResponse", + "type": "Interface", "tags": [], - "label": "getComponentTemplateNameForDatastream", - "description": [ - "\nReturn the name for a component template" - ], - "signature": [ - "(dataStream: { dataset: string; type: string; hidden?: boolean | undefined; }, suffix: \"@package\" | \"@custom\" | undefined) => string" - ], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", + "label": "BulkInstallPackagesResponse", + "description": [], + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.getComponentTemplateNameForDatastream.$1", - "type": "Object", + "id": "def-common.BulkInstallPackagesResponse.items", + "type": "Array", "tags": [], - "label": "dataStream", + "label": "items", "description": [], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false, - "children": [ + "signature": [ + "(", { - "parentPluginId": "fleet", - "id": "def-common.getComponentTemplateNameForDatastream.$1.dataset", - "type": "string", - "tags": [], - "label": "dataset", - "description": [], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.BulkInstallPackageInfo", + "text": "BulkInstallPackageInfo" }, + " | ", { - "parentPluginId": "fleet", - "id": "def-common.getComponentTemplateNameForDatastream.$1.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.IBulkInstallPackageHTTPError", + "text": "IBulkInstallPackageHTTPError" }, - { - "parentPluginId": "fleet", - "id": "def-common.getComponentTemplateNameForDatastream.$1.hidden", - "type": "CompoundType", - "tags": [], - "label": "hidden", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false - } - ] + ")[]" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.getComponentTemplateNameForDatastream.$2", - "type": "CompoundType", + "id": "def-common.BulkInstallPackagesResponse.response", + "type": "Array", "tags": [], - "label": "suffix", + "label": "response", "description": [], "signature": [ - "\"@package\" | \"@custom\" | undefined" + "(", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.BulkInstallPackageInfo", + "text": "BulkInstallPackageInfo" + }, + " | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.IBulkInstallPackageHTTPError", + "text": "IBulkInstallPackageHTTPError" + }, + ")[] | undefined" ], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false, - "isRequired": false + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.getCustomPipelineNameForDatastream", - "type": "Function", + "id": "def-common.BundledPackage", + "type": "Interface", "tags": [], - "label": "getCustomPipelineNameForDatastream", - "description": [ - "\nReturn the custom user ingest pipeline name for a datastream" - ], - "signature": [ - "(dataStream: { dataset: string; type: string; }) => string" - ], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", + "label": "BundledPackage", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.getCustomPipelineNameForDatastream.$1", - "type": "Object", + "id": "def-common.BundledPackage.name", + "type": "string", "tags": [], - "label": "dataStream", + "label": "name", "description": [], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.getCustomPipelineNameForDatastream.$1.dataset", - "type": "string", - "tags": [], - "label": "dataset", - "description": [], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.getCustomPipelineNameForDatastream.$1.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false - } - ] - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.getExperimentalAllowedValues", - "type": "Function", - "tags": [], - "label": "getExperimentalAllowedValues", - "description": [], - "signature": [ - "() => string[]" - ], - "path": "x-pack/plugins/fleet/common/experimental_features.ts", - "deprecated": false, - "children": [], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.getMaxPackageName", - "type": "Function", - "tags": [], - "label": "getMaxPackageName", - "description": [], - "signature": [ - "(packageName: string, packagePolicies: { name: string; }[] | undefined) => string" - ], - "path": "x-pack/plugins/fleet/common/services/max_package_name.ts", - "deprecated": false, - "children": [ + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, { "parentPluginId": "fleet", - "id": "def-common.getMaxPackageName.$1", + "id": "def-common.BundledPackage.version", "type": "string", "tags": [], - "label": "packageName", + "label": "version", "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/max_package_name.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.getMaxPackageName.$2", - "type": "Array", + "id": "def-common.BundledPackage.buffer", + "type": "Object", "tags": [], - "label": "packagePolicies", + "label": "buffer", "description": [], "signature": [ - "{ name: string; }[] | undefined" + "Buffer" ], - "path": "x-pack/plugins/fleet/common/services/max_package_name.ts", - "deprecated": false, - "isRequired": false + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.getMaxVersion", - "type": "Function", + "id": "def-common.CheckPermissionsResponse", + "type": "Interface", "tags": [], - "label": "getMaxVersion", + "label": "CheckPermissionsResponse", "description": [], - "signature": [ - "(versions: string[]) => string" - ], - "path": "x-pack/plugins/fleet/common/services/get_min_max_version.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.getMaxVersion.$1", - "type": "Array", + "id": "def-common.CheckPermissionsResponse.error", + "type": "CompoundType", "tags": [], - "label": "versions", + "label": "error", "description": [], "signature": [ - "string[]" + "\"MISSING_SECURITY\" | \"MISSING_PRIVILEGES\" | \"MISSING_FLEET_SERVER_SETUP_PRIVILEGES\" | undefined" ], - "path": "x-pack/plugins/fleet/common/services/get_min_max_version.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.CheckPermissionsResponse.success", + "type": "boolean", + "tags": [], + "label": "success", + "description": [], + "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.getMinVersion", - "type": "Function", + "id": "def-common.CopyAgentPolicyResponse", + "type": "Interface", "tags": [], - "label": "getMinVersion", + "label": "CopyAgentPolicyResponse", "description": [], - "signature": [ - "(versions: string[]) => string" - ], - "path": "x-pack/plugins/fleet/common/services/get_min_max_version.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.getMinVersion.$1", - "type": "Array", + "id": "def-common.CopyAgentPolicyResponse.item", + "type": "Object", "tags": [], - "label": "versions", + "label": "item", "description": [], "signature": [ - "string[]" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + } ], - "path": "x-pack/plugins/fleet/common/services/get_min_max_version.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.getPipelineNameForDatastream", - "type": "Function", + "id": "def-common.CreateAgentPolicyRequest", + "type": "Interface", "tags": [], - "label": "getPipelineNameForDatastream", - "description": [ - "\nReturn the ingest pipeline name for a datastream" - ], - "signature": [ - "({ dataStream, packageVersion, }: { dataStream: { dataset: string; type: string; }; packageVersion: string; }) => string" - ], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", + "label": "CreateAgentPolicyRequest", + "description": [], + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.getPipelineNameForDatastream.$1", + "id": "def-common.CreateAgentPolicyRequest.body", "type": "Object", "tags": [], - "label": "{\n dataStream,\n packageVersion,\n}", + "label": "body", "description": [], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.getPipelineNameForDatastream.$1.dataStream", - "type": "Object", - "tags": [], - "label": "dataStream", - "description": [], - "signature": [ - "{ dataset: string; type: string; }" - ], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false - }, + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.getPipelineNameForDatastream.$1.packageVersion", - "type": "string", - "tags": [], - "label": "packageVersion", - "description": [], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewAgentPolicy", + "text": "NewAgentPolicy" } - ] + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.getRegistryDataStreamAssetBaseName", - "type": "Function", + "id": "def-common.CreateAgentPolicyResponse", + "type": "Interface", "tags": [], - "label": "getRegistryDataStreamAssetBaseName", - "description": [ - "\nCreates the base name for Elasticsearch assets in the form of\n{type}-{dataset}" - ], - "signature": [ - "(dataStream: { dataset: string; type: string; hidden?: boolean | undefined; }) => string" - ], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", + "label": "CreateAgentPolicyResponse", + "description": [], + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.getRegistryDataStreamAssetBaseName.$1", + "id": "def-common.CreateAgentPolicyResponse.item", "type": "Object", "tags": [], - "label": "dataStream", + "label": "item", "description": [], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.getRegistryDataStreamAssetBaseName.$1.dataset", - "type": "string", - "tags": [], - "label": "dataset", - "description": [], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.getRegistryDataStreamAssetBaseName.$1.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false - }, + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.getRegistryDataStreamAssetBaseName.$1.hidden", - "type": "CompoundType", - "tags": [], - "label": "hidden", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/services/datastream_es_name.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" } - ] + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.getStreamsForInputType", - "type": "Function", + "id": "def-common.CreatePackagePolicyRequest", + "type": "Interface", "tags": [], - "label": "getStreamsForInputType", + "label": "CreatePackagePolicyRequest", "description": [], - "signature": [ - "(inputType: string, packageInfo: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - }, - ", dataStreamPaths?: string[]) => (", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryStream", - "text": "RegistryStream" - }, - " & { data_stream: { type: string; dataset: string; }; })[]" - ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.getStreamsForInputType.$1", - "type": "string", - "tags": [], - "label": "inputType", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "fleet", - "id": "def-common.getStreamsForInputType.$2", + "id": "def-common.CreatePackagePolicyRequest.body", "type": "CompoundType", "tags": [], - "label": "packageInfo", + "label": "body", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - } - ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "fleet", - "id": "def-common.getStreamsForInputType.$3", - "type": "Array", - "tags": [], - "label": "dataStreamPaths", - "description": [], - "signature": [ - "string[]" + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + }, + " & { force?: boolean | undefined; }" ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.isAgentUpgradeable", - "type": "Function", + "id": "def-common.CreatePackagePolicyResponse", + "type": "Interface", "tags": [], - "label": "isAgentUpgradeable", + "label": "CreatePackagePolicyResponse", "description": [], - "signature": [ - "(agent: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Agent", - "text": "Agent" - }, - ", kibanaVersion: string, versionToUpgrade: string | undefined) => boolean" - ], - "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.isAgentUpgradeable.$1", + "id": "def-common.CreatePackagePolicyResponse.item", "type": "Object", "tags": [], - "label": "agent", + "label": "item", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.Agent", - "text": "Agent" + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" } ], - "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", - "deprecated": false, - "isRequired": true - }, + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.DefaultPackagesInstallationError", + "type": "Interface", + "tags": [], + "label": "DefaultPackagesInstallationError", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "children": [ { "parentPluginId": "fleet", - "id": "def-common.isAgentUpgradeable.$2", - "type": "string", + "id": "def-common.DefaultPackagesInstallationError.installType", + "type": "CompoundType", "tags": [], - "label": "kibanaVersion", + "label": "installType", "description": [], "signature": [ - "string" + "\"unknown\" | \"update\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" ], - "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.isAgentUpgradeable.$3", - "type": "string", + "id": "def-common.DefaultPackagesInstallationError.error", + "type": "Object", "tags": [], - "label": "versionToUpgrade", + "label": "error", "description": [], "signature": [ - "string | undefined" + "Error" ], - "path": "x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts", - "deprecated": false, - "isRequired": false + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.isDiffPathProtocol", - "type": "Function", + "id": "def-common.DeleteAgentPolicyRequest", + "type": "Interface", "tags": [], - "label": "isDiffPathProtocol", + "label": "DeleteAgentPolicyRequest", "description": [], - "signature": [ - "(kibanaUrls: string[]) => boolean" - ], - "path": "x-pack/plugins/fleet/common/services/is_diff_path_protocol.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.isDiffPathProtocol.$1", - "type": "Array", + "id": "def-common.DeleteAgentPolicyRequest.body", + "type": "Object", "tags": [], - "label": "kibanaUrls", + "label": "body", "description": [], "signature": [ - "string[]" + "{ agentPolicyId: string; }" ], - "path": "x-pack/plugins/fleet/common/services/is_diff_path_protocol.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.isPackageLimited", - "type": "Function", + "id": "def-common.DeleteAgentPolicyResponse", + "type": "Interface", "tags": [], - "label": "isPackageLimited", + "label": "DeleteAgentPolicyResponse", "description": [], - "signature": [ - "(packageInfo: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - }, - ") => boolean" - ], - "path": "x-pack/plugins/fleet/common/services/limited_package.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.isPackageLimited.$1", - "type": "CompoundType", + "id": "def-common.DeleteAgentPolicyResponse.id", + "type": "string", "tags": [], - "label": "packageInfo", + "label": "id", "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - } - ], - "path": "x-pack/plugins/fleet/common/services/limited_package.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.isValidExperimentalValue", - "type": "Function", - "tags": [], - "label": "isValidExperimentalValue", - "description": [], - "signature": [ - "(value: string) => boolean" - ], - "path": "x-pack/plugins/fleet/common/experimental_features.ts", - "deprecated": false, - "children": [ + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "deprecated": false + }, { "parentPluginId": "fleet", - "id": "def-common.isValidExperimentalValue.$1", + "id": "def-common.DeleteAgentPolicyResponse.name", "type": "string", "tags": [], - "label": "value", + "label": "name", "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/experimental_features.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.isValidNamespace", - "type": "Function", + "id": "def-common.DeletePackagePoliciesRequest", + "type": "Interface", "tags": [], - "label": "isValidNamespace", + "label": "DeletePackagePoliciesRequest", "description": [], - "signature": [ - "(namespace: string) => { valid: boolean; error?: string | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.isValidNamespace.$1", - "type": "string", + "id": "def-common.DeletePackagePoliciesRequest.body", + "type": "Object", "tags": [], - "label": "namespace", + "label": "body", "description": [], "signature": [ - "string" + "{ packagePolicyIds: string[]; force?: boolean | undefined; }" ], - "path": "x-pack/plugins/fleet/common/services/is_valid_namespace.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.normalizeHostsForAgents", - "type": "Function", + "id": "def-common.EpmPackageAdditions", + "type": "Interface", "tags": [], - "label": "normalizeHostsForAgents", + "label": "EpmPackageAdditions", "description": [], - "signature": [ - "(host: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/hosts_utils.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.normalizeHostsForAgents.$1", + "id": "def-common.EpmPackageAdditions.title", "type": "string", "tags": [], - "label": "host", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/hosts_utils.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.packageToPackagePolicy", - "type": "Function", - "tags": [], - "label": "packageToPackagePolicy", - "description": [ - "\nBuilds a `NewPackagePolicy` structure based on a package\n" - ], - "signature": [ - "(packageInfo: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - }, - ", agentPolicyId: string, outputId: string, namespace?: string, packagePolicyName?: string | undefined, description?: string | undefined, integrationToEnable?: string | undefined) => ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" - } - ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.packageToPackagePolicy.$1", - "type": "CompoundType", - "tags": [], - "label": "packageInfo", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - } - ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "fleet", - "id": "def-common.packageToPackagePolicy.$2", - "type": "string", - "tags": [], - "label": "agentPolicyId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "fleet", - "id": "def-common.packageToPackagePolicy.$3", - "type": "string", - "tags": [], - "label": "outputId", + "label": "title", "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.packageToPackagePolicy.$4", + "id": "def-common.EpmPackageAdditions.latestVersion", "type": "string", "tags": [], - "label": "namespace", + "label": "latestVersion", "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.packageToPackagePolicy.$5", - "type": "string", + "id": "def-common.EpmPackageAdditions.assets", + "type": "CompoundType", "tags": [], - "label": "packagePolicyName", + "label": "assets", "description": [], "signature": [ - "string | undefined" + "Record<\"kibana\", ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetTypeToParts", + "text": "KibanaAssetTypeToParts" + }, + "> & Record<\"elasticsearch\", ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetTypeToParts", + "text": "ElasticsearchAssetTypeToParts" + }, + ">" ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "deprecated": false, - "isRequired": false + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.packageToPackagePolicy.$6", + "id": "def-common.EpmPackageAdditions.notice", "type": "string", "tags": [], - "label": "description", + "label": "notice", "description": [], "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "deprecated": false, - "isRequired": false + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.packageToPackagePolicy.$7", - "type": "string", + "id": "def-common.EpmPackageAdditions.keepPoliciesUpToDate", + "type": "CompoundType", "tags": [], - "label": "integrationToEnable", + "label": "keepPoliciesUpToDate", "description": [], "signature": [ - "string | undefined" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "deprecated": false, - "isRequired": false + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.packageToPackagePolicyInputs", - "type": "Function", + "id": "def-common.FleetAuthz", + "type": "Interface", "tags": [], - "label": "packageToPackagePolicyInputs", + "label": "FleetAuthz", "description": [], - "signature": [ - "(packageInfo: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - }, - ", integrationToEnable?: string | undefined) => ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicyInput", - "text": "NewPackagePolicyInput" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", + "path": "x-pack/plugins/fleet/common/authz.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.packageToPackagePolicyInputs.$1", - "type": "CompoundType", + "id": "def-common.FleetAuthz.fleet", + "type": "Object", "tags": [], - "label": "packageInfo", + "label": "fleet", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - } + "{ all: boolean; setup: boolean; readEnrollmentTokens: boolean; readAgentPolicies: boolean; }" ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/authz.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.packageToPackagePolicyInputs.$2", - "type": "string", + "id": "def-common.FleetAuthz.integrations", + "type": "Object", "tags": [], - "label": "integrationToEnable", + "label": "integrations", "description": [], "signature": [ - "string | undefined" + "{ readPackageInfo: boolean; readInstalledPackages: boolean; installPackages: boolean; upgradePackages: boolean; removePackages: boolean; uploadPackages: boolean; readPackageSettings: boolean; writePackageSettings: boolean; readIntegrationPolicies: boolean; writeIntegrationPolicies: boolean; }" ], - "path": "x-pack/plugins/fleet/common/services/package_to_package_policy.ts", - "deprecated": false, - "isRequired": false + "path": "x-pack/plugins/fleet/common/authz.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.parseExperimentalConfigValue", - "type": "Function", - "tags": [ - "throws" - ], - "label": "parseExperimentalConfigValue", - "description": [ - "\nParses the string value used in `xpack.fleet.enableExperimental` kibana configuration,\nwhich should be a string of values delimited by a comma (`,`)\n" - ], - "signature": [ - "(configValue: string[]) => Readonly<{ createPackagePolicyMultiPageLayout: boolean; packageVerification: boolean; }>" - ], - "path": "x-pack/plugins/fleet/common/experimental_features.ts", + "id": "def-common.FleetErrorResponse", + "type": "Interface", + "tags": [], + "label": "FleetErrorResponse", + "description": [], + "path": "x-pack/plugins/fleet/common/types/rest_spec/error.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.parseExperimentalConfigValue.$1", - "type": "Array", + "id": "def-common.FleetErrorResponse.message", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "path": "x-pack/plugins/fleet/common/types/rest_spec/error.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FleetErrorResponse.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "x-pack/plugins/fleet/common/types/rest_spec/error.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FleetErrorResponse.attributes", + "type": "Object", "tags": [], - "label": "configValue", + "label": "attributes", "description": [], "signature": [ - "string[]" + "{ type?: \"verification_failed\" | undefined; } | undefined" ], - "path": "x-pack/plugins/fleet/common/experimental_features.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/rest_spec/error.ts", + "deprecated": false } ], - "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.splitPkgKey", - "type": "Function", + "id": "def-common.FleetServerAgent", + "type": "Interface", "tags": [], - "label": "splitPkgKey", + "label": "FleetServerAgent", "description": [ - "\nExtract the package name and package version from a string.\n" - ], - "signature": [ - "(pkgkey: string) => { pkgName: string; pkgVersion: string; }" + "\nAn Elastic Agent that has enrolled into Fleet" ], - "path": "x-pack/plugins/fleet/common/services/split_pkg_key.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.splitPkgKey.$1", - "type": "string", + "id": "def-common.FleetServerAgent._version", + "type": "number", "tags": [], - "label": "pkgkey", + "label": "_version", "description": [ - "a string containing the package name delimited by the package version" + "\nThe version of the document in the index" ], "signature": [ - "string" + "number | undefined" ], - "path": "x-pack/plugins/fleet/common/services/split_pkg_key.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.validatePackagePolicy", - "type": "Function", - "tags": [], - "label": "validatePackagePolicy", - "description": [], - "signature": [ - "(packagePolicy: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false }, - ", packageInfo: ", { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" + "parentPluginId": "fleet", + "id": "def-common.FleetServerAgent.shared_id", + "type": "string", + "tags": [], + "label": "shared_id", + "description": [ + "\nShared ID" + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false }, - ", safeLoadYaml: (yaml: string) => any) => ", { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyValidationResults", - "text": "PackagePolicyValidationResults" - } - ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "children": [ + "parentPluginId": "fleet", + "id": "def-common.FleetServerAgent.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [ + "\nType" + ], + "signature": [ + "\"EPHEMERAL\" | \"PERMANENT\" | \"TEMPORARY\"" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, { "parentPluginId": "fleet", - "id": "def-common.validatePackagePolicy.$1", - "type": "Object", + "id": "def-common.FleetServerAgent.active", + "type": "boolean", "tags": [], - "label": "packagePolicy", - "description": [], + "label": "active", + "description": [ + "\nActive flag" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FleetServerAgent.enrolled_at", + "type": "string", + "tags": [], + "label": "enrolled_at", + "description": [ + "\nDate/time the Elastic Agent enrolled" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FleetServerAgent.unenrolled_at", + "type": "string", + "tags": [], + "label": "unenrolled_at", + "description": [ + "\nDate/time the Elastic Agent unenrolled" + ], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" - } + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.validatePackagePolicy.$2", - "type": "CompoundType", + "id": "def-common.FleetServerAgent.unenrollment_started_at", + "type": "string", "tags": [], - "label": "packageInfo", - "description": [], + "label": "unenrollment_started_at", + "description": [ + "\nDate/time the Elastic Agent unenrolled started" + ], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - } + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.validatePackagePolicy.$3", - "type": "Function", + "id": "def-common.FleetServerAgent.upgraded_at", + "type": "CompoundType", "tags": [], - "label": "safeLoadYaml", - "description": [], + "label": "upgraded_at", + "description": [ + "\nDate/time the Elastic Agent was last upgraded" + ], "signature": [ - "(yaml: string) => any" + "string | null | undefined" ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.validatePackagePolicyConfig", - "type": "Function", - "tags": [], - "label": "validatePackagePolicyConfig", - "description": [], - "signature": [ - "(configEntry: ", + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigRecordEntry", - "text": "PackagePolicyConfigRecordEntry" + "parentPluginId": "fleet", + "id": "def-common.FleetServerAgent.upgrade_started_at", + "type": "CompoundType", + "tags": [], + "label": "upgrade_started_at", + "description": [ + "\nDate/time the Elastic Agent started the current upgrade" + ], + "signature": [ + "string | null | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false }, - " | undefined, varDef: ", { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryVarsEntry", - "text": "RegistryVarsEntry" + "parentPluginId": "fleet", + "id": "def-common.FleetServerAgent.access_api_key_id", + "type": "string", + "tags": [], + "label": "access_api_key_id", + "description": [ + "\nID of the API key the Elastic Agent must used to contact Fleet Server" + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false }, - ", varName: string, safeLoadYaml: (yaml: string) => any) => string[] | null" - ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "children": [ { "parentPluginId": "fleet", - "id": "def-common.validatePackagePolicyConfig.$1", + "id": "def-common.FleetServerAgent.agent", "type": "Object", "tags": [], - "label": "configEntry", + "label": "agent", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigRecordEntry", - "text": "PackagePolicyConfigRecordEntry" + "section": "def-common.FleetServerAgentMetadata", + "text": "FleetServerAgentMetadata" }, " | undefined" ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "isRequired": false + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.validatePackagePolicyConfig.$2", + "id": "def-common.FleetServerAgent.user_provided_metadata", "type": "Object", "tags": [], - "label": "varDef", - "description": [], + "label": "user_provided_metadata", + "description": [ + "\nUser provided metadata information for the Elastic Agent" + ], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.RegistryVarsEntry", - "text": "RegistryVarsEntry" + "section": "def-common.AgentMetadata", + "text": "AgentMetadata" } ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.validatePackagePolicyConfig.$3", - "type": "string", + "id": "def-common.FleetServerAgent.local_metadata", + "type": "Object", "tags": [], - "label": "varName", - "description": [], + "label": "local_metadata", + "description": [ + "\nLocal metadata information for the Elastic Agent" + ], "signature": [ - "string" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentMetadata", + "text": "AgentMetadata" + } ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "isRequired": true + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.validatePackagePolicyConfig.$4", - "type": "Function", + "id": "def-common.FleetServerAgent.policy_id", + "type": "string", "tags": [], - "label": "safeLoadYaml", - "description": [], + "label": "policy_id", + "description": [ + "\nThe policy ID for the Elastic Agent" + ], "signature": [ - "(yaml: string) => any" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.validationHasErrors", - "type": "Function", - "tags": [], - "label": "validationHasErrors", - "description": [], - "signature": [ - "(validationResults: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigValidationResults", - "text": "PackagePolicyConfigValidationResults" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyValidationResults", - "text": "PackagePolicyValidationResults" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyInputValidationResults", - "text": "PackagePolicyInputValidationResults" + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false }, - ") => boolean" - ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "children": [ { "parentPluginId": "fleet", - "id": "def-common.validationHasErrors.$1", + "id": "def-common.FleetServerAgent.policy_revision_idx", "type": "CompoundType", "tags": [], - "label": "validationResults", - "description": [], + "label": "policy_revision_idx", + "description": [ + "\nThe current policy revision_idx for the Elastic Agent" + ], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigValidationResults", - "text": "PackagePolicyConfigValidationResults" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyValidationResults", - "text": "PackagePolicyValidationResults" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyInputValidationResults", - "text": "PackagePolicyInputValidationResults" - } + "number | null | undefined" ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "parentPluginId": "fleet", - "id": "def-common.Agent", - "type": "Interface", - "tags": [], - "label": "Agent", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Agent", - "text": "Agent" + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false }, - " extends AgentBase" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false, - "children": [ { "parentPluginId": "fleet", - "id": "def-common.Agent.id", - "type": "string", + "id": "def-common.FleetServerAgent.policy_coordinator_idx", + "type": "number", "tags": [], - "label": "id", - "description": [], + "label": "policy_coordinator_idx", + "description": [ + "\nThe current policy coordinator for the Elastic Agent" + ], + "signature": [ + "number | undefined" + ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.Agent.access_api_key", + "id": "def-common.FleetServerAgent.last_updated", "type": "string", "tags": [], - "label": "access_api_key", - "description": [], + "label": "last_updated", + "description": [ + "\nDate/time the Elastic Agent was last updated" + ], "signature": [ "string | undefined" ], @@ -10246,161 +8549,135 @@ }, { "parentPluginId": "fleet", - "id": "def-common.Agent.default_api_key_history", - "type": "Array", + "id": "def-common.FleetServerAgent.last_checkin", + "type": "string", "tags": [], - "label": "default_api_key_history", - "description": [], + "label": "last_checkin", + "description": [ + "\nDate/time the Elastic Agent checked in last time" + ], "signature": [ - "{ id: string; retired_at: string; }[] | undefined" + "string | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.Agent.status", + "id": "def-common.FleetServerAgent.last_checkin_status", "type": "CompoundType", "tags": [], - "label": "status", - "description": [], + "label": "last_checkin_status", + "description": [ + "\nLst checkin status" + ], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentStatus", - "text": "AgentStatus" - }, - " | undefined" + "\"error\" | \"online\" | \"updating\" | \"degraded\" | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.Agent.packages", - "type": "Array", + "id": "def-common.FleetServerAgent.default_api_key_id", + "type": "string", "tags": [], - "label": "packages", - "description": [], + "label": "default_api_key_id", + "description": [ + "\nID of the API key the Elastic Agent uses to authenticate with elasticsearch" + ], "signature": [ - "string[]" + "string | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.Agent.sort", - "type": "Array", + "id": "def-common.FleetServerAgent.default_api_key", + "type": "string", "tags": [], - "label": "sort", - "description": [], + "label": "default_api_key", + "description": [ + "\nAPI key the Elastic Agent uses to authenticate with elasticsearch" + ], "signature": [ - "(string | number | null)[] | undefined" + "string | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentAction", - "type": "Interface", - "tags": [], - "label": "AgentAction", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentAction", - "text": "AgentAction" }, - " extends ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewAgentAction", - "text": "NewAgentAction" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false, - "children": [ { "parentPluginId": "fleet", - "id": "def-common.AgentAction.type", - "type": "CompoundType", + "id": "def-common.FleetServerAgent.updated_at", + "type": "string", "tags": [], - "label": "type", - "description": [], + "label": "updated_at", + "description": [ + "\nDate/time the Elastic Agent was last updated" + ], "signature": [ - "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\" | \"CANCEL\"" + "string | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.AgentAction.data", - "type": "Any", + "id": "def-common.FleetServerAgent.packages", + "type": "Array", "tags": [], - "label": "data", - "description": [], + "label": "packages", + "description": [ + "\nPackages array" + ], "signature": [ - "any" + "string[] | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.AgentAction.sent_at", - "type": "string", + "id": "def-common.FleetServerAgent.action_seq_no", + "type": "number", "tags": [], - "label": "sent_at", - "description": [], + "label": "action_seq_no", + "description": [ + "\nThe last acknowledged action sequence number for the Elastic Agent" + ], "signature": [ - "string | undefined" + "number | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.AgentAction.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentAction.created_at", - "type": "string", + "id": "def-common.FleetServerAgent.tags", + "type": "Array", "tags": [], - "label": "created_at", - "description": [], + "label": "tags", + "description": [ + "\nA list of tags used for organizing/filtering agents" + ], + "signature": [ + "string[] | undefined" + ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.AgentAction.ack_data", - "type": "Any", + "id": "def-common.FleetServerAgent.default_api_key_history", + "type": "Array", "tags": [], - "label": "ack_data", - "description": [], + "label": "default_api_key_history", + "description": [ + "\nDefault API Key History" + ], "signature": [ - "any" + "{ id: string; retired_at: string; }[] | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false @@ -10410,23 +8687,49 @@ }, { "parentPluginId": "fleet", - "id": "def-common.AgentMetadata", + "id": "def-common.FleetServerAgentMetadata", "type": "Interface", "tags": [], - "label": "AgentMetadata", - "description": [], + "label": "FleetServerAgentMetadata", + "description": [ + "\nAn Elastic Agent metadata" + ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.AgentMetadata.Unnamed", + "id": "def-common.FleetServerAgentMetadata.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nThe unique identifier for the Elastic Agent" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FleetServerAgentMetadata.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nThe version of the Elastic Agent" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FleetServerAgentMetadata.Unnamed", "type": "IndexSignature", "tags": [], - "label": "[x: string]: any", + "label": "[k: string]: any", "description": [], "signature": [ - "[x: string]: any" + "[k: string]: any" ], "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false @@ -10436,35 +8739,17 @@ }, { "parentPluginId": "fleet", - "id": "def-common.AgentPolicy", + "id": "def-common.FullAgentPolicy", "type": "Interface", "tags": [], - "label": "AgentPolicy", + "label": "FullAgentPolicy", "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentPolicy", - "text": "AgentPolicy" - }, - " extends Omit<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewAgentPolicy", - "text": "NewAgentPolicy" - }, - ", \"id\">" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false, - "children": [ + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "deprecated": false, + "children": [ { "parentPluginId": "fleet", - "id": "def-common.AgentPolicy.id", + "id": "def-common.FullAgentPolicy.id", "type": "string", "tags": [], "label": "id", @@ -10474,87 +8759,109 @@ }, { "parentPluginId": "fleet", - "id": "def-common.AgentPolicy.status", - "type": "CompoundType", + "id": "def-common.FullAgentPolicy.outputs", + "type": "Object", "tags": [], - "label": "status", + "label": "outputs", "description": [], "signature": [ - "\"active\" | \"inactive\"" + "{ [key: string]: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicyOutput", + "text": "FullAgentPolicyOutput" + }, + "; }" ], "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.AgentPolicy.package_policies", - "type": "CompoundType", + "id": "def-common.FullAgentPolicy.output_permissions", + "type": "Object", "tags": [], - "label": "package_policies", + "label": "output_permissions", "description": [], "signature": [ - "string[] | ", + "{ [output: string]: ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicy", - "text": "PackagePolicy" + "section": "def-common.FullAgentPolicyOutputPermissions", + "text": "FullAgentPolicyOutputPermissions" }, - "[]" + "; } | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.AgentPolicy.is_managed", - "type": "boolean", - "tags": [], - "label": "is_managed", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentPolicy.updated_at", - "type": "string", + "id": "def-common.FullAgentPolicy.fleet", + "type": "CompoundType", "tags": [], - "label": "updated_at", + "label": "fleet", "description": [], + "signature": [ + "{ hosts: string[]; } | { kibana: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicyKibanaConfig", + "text": "FullAgentPolicyKibanaConfig" + }, + "; } | undefined" + ], "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.AgentPolicy.updated_by", - "type": "string", + "id": "def-common.FullAgentPolicy.inputs", + "type": "Array", "tags": [], - "label": "updated_by", + "label": "inputs", "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicyInput", + "text": "FullAgentPolicyInput" + }, + "[]" + ], "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.AgentPolicy.revision", + "id": "def-common.FullAgentPolicy.revision", "type": "number", "tags": [], "label": "revision", "description": [], + "signature": [ + "number | undefined" + ], "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.AgentPolicy.agents", - "type": "number", + "id": "def-common.FullAgentPolicy.agent", + "type": "Object", "tags": [], - "label": "agents", + "label": "agent", "description": [], "signature": [ - "number | undefined" + "{ monitoring: { namespace?: string | undefined; use_output?: string | undefined; enabled: boolean; metrics: boolean; logs: boolean; }; download: { source_uri: string; }; } | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false @@ -10564,130 +8871,129 @@ }, { "parentPluginId": "fleet", - "id": "def-common.AgentSOAttributes", + "id": "def-common.FullAgentPolicyInput", "type": "Interface", "tags": [], - "label": "AgentSOAttributes", + "label": "FullAgentPolicyInput", "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentSOAttributes", - "text": "AgentSOAttributes" - }, - " extends AgentBase" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.AgentSOAttributes.packages", - "type": "Array", + "id": "def-common.FullAgentPolicyInput.id", + "type": "string", "tags": [], - "label": "packages", + "label": "id", "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AssetParts", - "type": "Interface", - "tags": [], - "label": "AssetParts", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.AssetParts.pkgkey", + "id": "def-common.FullAgentPolicyInput.name", "type": "string", "tags": [], - "label": "pkgkey", + "label": "name", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.AssetParts.dataset", + "id": "def-common.FullAgentPolicyInput.revision", + "type": "number", + "tags": [], + "label": "revision", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FullAgentPolicyInput.type", "type": "string", "tags": [], - "label": "dataset", + "label": "type", "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.AssetParts.service", - "type": "CompoundType", + "id": "def-common.FullAgentPolicyInput.data_stream", + "type": "Object", "tags": [], - "label": "service", + "label": "data_stream", "description": [], "signature": [ - "\"kibana\" | \"elasticsearch\"" + "{ namespace: string; }" ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.AssetParts.type", - "type": "CompoundType", + "id": "def-common.FullAgentPolicyInput.use_output", + "type": "string", "tags": [], - "label": "type", + "label": "use_output", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FullAgentPolicyInput.meta", + "type": "Object", + "tags": [], + "label": "meta", "description": [], "signature": [ - "\"input\" | ", + "{ [key: string]: unknown; package?: Pick<", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.DocAssetType", - "text": "DocAssetType" + "section": "def-common.PackagePolicyPackage", + "text": "PackagePolicyPackage" }, - " | ", + ", \"name\" | \"version\"> | undefined; } | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FullAgentPolicyInput.streams", + "type": "Array", + "tags": [], + "label": "streams", + "description": [], + "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetType", - "text": "KibanaAssetType" + "section": "def-common.FullAgentPolicyInputStream", + "text": "FullAgentPolicyInputStream" }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetType", - "text": "ElasticsearchAssetType" - } + "[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.AssetParts.file", - "type": "string", + "id": "def-common.FullAgentPolicyInput.Unnamed", + "type": "IndexSignature", "tags": [], - "label": "file", + "label": "[key: string]: any", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "signature": [ + "[key: string]: any" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false } ], @@ -10695,51 +9001,48 @@ }, { "parentPluginId": "fleet", - "id": "def-common.BaseSettings", + "id": "def-common.FullAgentPolicyInputStream", "type": "Interface", "tags": [], - "label": "BaseSettings", + "label": "FullAgentPolicyInputStream", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.BaseSettings.has_seen_add_data_notice", - "type": "CompoundType", + "id": "def-common.FullAgentPolicyInputStream.id", + "type": "string", "tags": [], - "label": "has_seen_add_data_notice", + "label": "id", "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.BaseSettings.has_seen_fleet_migration_notice", - "type": "CompoundType", + "id": "def-common.FullAgentPolicyInputStream.data_stream", + "type": "Object", "tags": [], - "label": "has_seen_fleet_migration_notice", + "label": "data_stream", "description": [], "signature": [ - "boolean | undefined" + "{ dataset: string; type: string; }" ], - "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.BaseSettings.fleet_server_hosts", - "type": "Array", + "id": "def-common.FullAgentPolicyInputStream.Unnamed", + "type": "IndexSignature", "tags": [], - "label": "fleet_server_hosts", + "label": "[key: string]: any", "description": [], "signature": [ - "string[]" + "[key: string]: any" ], - "path": "x-pack/plugins/fleet/common/types/models/settings.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false } ], @@ -10747,51 +9050,48 @@ }, { "parentPluginId": "fleet", - "id": "def-common.BulkInstallPackageInfo", + "id": "def-common.FullAgentPolicyKibanaConfig", "type": "Interface", "tags": [], - "label": "BulkInstallPackageInfo", + "label": "FullAgentPolicyKibanaConfig", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.BulkInstallPackageInfo.name", - "type": "string", + "id": "def-common.FullAgentPolicyKibanaConfig.hosts", + "type": "Array", "tags": [], - "label": "name", + "label": "hosts", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.BulkInstallPackageInfo.version", + "id": "def-common.FullAgentPolicyKibanaConfig.protocol", "type": "string", "tags": [], - "label": "version", + "label": "protocol", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.BulkInstallPackageInfo.result", - "type": "Object", + "id": "def-common.FullAgentPolicyKibanaConfig.path", + "type": "string", "tags": [], - "label": "result", + "label": "path", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.InstallResult", - "text": "InstallResult" - } + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false } ], @@ -10799,25 +9099,25 @@ }, { "parentPluginId": "fleet", - "id": "def-common.BulkInstallPackagesRequest", + "id": "def-common.FullAgentPolicyOutputPermissions", "type": "Interface", "tags": [], - "label": "BulkInstallPackagesRequest", + "label": "FullAgentPolicyOutputPermissions", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.BulkInstallPackagesRequest.body", - "type": "Object", + "id": "def-common.FullAgentPolicyOutputPermissions.Unnamed", + "type": "IndexSignature", "tags": [], - "label": "body", + "label": "[packagePolicyName: string]: { cluster?: string[] | undefined; indices?: { names: string[]; privileges: string[]; }[] | undefined; }", "description": [], "signature": [ - "{ packages: string[]; }" + "[packagePolicyName: string]: { cluster?: string[] | undefined; indices?: { names: string[]; privileges: string[]; }[] | undefined; }" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false } ], @@ -10825,70 +9125,32 @@ }, { "parentPluginId": "fleet", - "id": "def-common.BulkInstallPackagesResponse", + "id": "def-common.GetAgentPoliciesRequest", "type": "Interface", "tags": [], - "label": "BulkInstallPackagesResponse", + "label": "GetAgentPoliciesRequest", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.BulkInstallPackagesResponse.items", - "type": "Array", - "tags": [], - "label": "items", - "description": [], - "signature": [ - "(", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.IBulkInstallPackageHTTPError", - "text": "IBulkInstallPackageHTTPError" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.BulkInstallPackageInfo", - "text": "BulkInstallPackageInfo" - }, - ")[]" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.BulkInstallPackagesResponse.response", - "type": "Array", + "id": "def-common.GetAgentPoliciesRequest.query", + "type": "CompoundType", "tags": [], - "label": "response", + "label": "query", "description": [], "signature": [ - "(", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.IBulkInstallPackageHTTPError", - "text": "IBulkInstallPackageHTTPError" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.BulkInstallPackageInfo", - "text": "BulkInstallPackageInfo" + "section": "def-common.ListWithKuery", + "text": "ListWithKuery" }, - ")[] | undefined" + " & { full?: boolean | undefined; }" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "deprecated": false } ], @@ -10896,88 +9158,68 @@ }, { "parentPluginId": "fleet", - "id": "def-common.BundledPackage", + "id": "def-common.GetAgentsResponse", "type": "Interface", "tags": [], - "label": "BundledPackage", + "label": "GetAgentsResponse", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.BundledPackage.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.GetAgentsResponse", + "text": "GetAgentsResponse" }, + " extends ", { - "parentPluginId": "fleet", - "id": "def-common.BundledPackage.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ListResult", + "text": "ListResult" }, + "<", { - "parentPluginId": "fleet", - "id": "def-common.BundledPackage.buffer", - "type": "Object", - "tags": [], - "label": "buffer", - "description": [], - "signature": [ - "Buffer" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Agent", + "text": "Agent" + }, + ">" ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.CategorySummaryItem", - "type": "Interface", - "tags": [], - "label": "CategorySummaryItem", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.CategorySummaryItem.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.CategorySummaryItem.title", - "type": "string", + "id": "def-common.GetAgentsResponse.totalInactive", + "type": "number", "tags": [], - "label": "title", + "label": "totalInactive", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.CategorySummaryItem.count", - "type": "number", + "id": "def-common.GetAgentsResponse.list", + "type": "Array", "tags": [], - "label": "count", + "label": "list", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Agent", + "text": "Agent" + }, + "[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "deprecated": false } ], @@ -10985,35 +9227,25 @@ }, { "parentPluginId": "fleet", - "id": "def-common.CheckPermissionsResponse", + "id": "def-common.GetAgentStatusResponse", "type": "Interface", "tags": [], - "label": "CheckPermissionsResponse", + "label": "GetAgentStatusResponse", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.CheckPermissionsResponse.error", - "type": "CompoundType", + "id": "def-common.GetAgentStatusResponse.results", + "type": "Object", "tags": [], - "label": "error", + "label": "results", "description": [], "signature": [ - "\"MISSING_SECURITY\" | \"MISSING_PRIVILEGES\" | \"MISSING_FLEET_SERVER_SETUP_PRIVILEGES\" | undefined" + "{ events: number; total: number; online: number; error: number; offline: number; other: number; updating: number; }" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.CheckPermissionsResponse.success", - "type": "boolean", - "tags": [], - "label": "success", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "deprecated": false } ], @@ -11021,23 +9253,29 @@ }, { "parentPluginId": "fleet", - "id": "def-common.CopyAgentPolicyRequest", + "id": "def-common.GetFullAgentPolicyResponse", "type": "Interface", "tags": [], - "label": "CopyAgentPolicyRequest", + "label": "GetFullAgentPolicyResponse", "description": [], "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.CopyAgentPolicyRequest.body", + "id": "def-common.GetFullAgentPolicyResponse.item", "type": "Object", "tags": [], - "label": "body", + "label": "item", "description": [], "signature": [ - "{ name: string; description?: string | undefined; }" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.FullAgentPolicy", + "text": "FullAgentPolicy" + } ], "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "deprecated": false @@ -11047,18 +9285,18 @@ }, { "parentPluginId": "fleet", - "id": "def-common.CopyAgentPolicyResponse", + "id": "def-common.GetInfoResponse", "type": "Interface", "tags": [], - "label": "CopyAgentPolicyResponse", + "label": "GetInfoResponse", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.CopyAgentPolicyResponse.item", - "type": "Object", + "id": "def-common.GetInfoResponse.item", + "type": "CompoundType", "tags": [], "label": "item", "description": [], @@ -11067,11 +9305,72 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.AgentPolicy", - "text": "AgentPolicy" - } + "section": "def-common.Installable", + "text": "Installable" + }, + "> | ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installable", + "text": "Installable" + }, + ">" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.GetInfoResponse.response", + "type": "CompoundType", + "tags": [], + "label": "response", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageInfo", + "text": "PackageInfo" + }, + " | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false } ], @@ -11079,28 +9378,28 @@ }, { "parentPluginId": "fleet", - "id": "def-common.CreateAgentPolicyRequest", + "id": "def-common.GetOneAgentPolicyResponse", "type": "Interface", "tags": [], - "label": "CreateAgentPolicyRequest", + "label": "GetOneAgentPolicyResponse", "description": [], "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.CreateAgentPolicyRequest.body", + "id": "def-common.GetOneAgentPolicyResponse.item", "type": "Object", "tags": [], - "label": "body", + "label": "item", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.NewAgentPolicy", - "text": "NewAgentPolicy" + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" } ], "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", @@ -11111,17 +9410,17 @@ }, { "parentPluginId": "fleet", - "id": "def-common.CreateAgentPolicyResponse", + "id": "def-common.GetOneAgentResponse", "type": "Interface", "tags": [], - "label": "CreateAgentPolicyResponse", + "label": "GetOneAgentResponse", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.CreateAgentPolicyResponse.item", + "id": "def-common.GetOneAgentResponse.item", "type": "Object", "tags": [], "label": "item", @@ -11131,11 +9430,11 @@ "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.AgentPolicy", - "text": "AgentPolicy" + "section": "def-common.Agent", + "text": "Agent" } ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", "deprecated": false } ], @@ -11143,30 +9442,29 @@ }, { "parentPluginId": "fleet", - "id": "def-common.CreatePackagePolicyRequest", + "id": "def-common.GetOnePackagePolicyResponse", "type": "Interface", "tags": [], - "label": "CreatePackagePolicyRequest", + "label": "GetOnePackagePolicyResponse", "description": [], "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.CreatePackagePolicyRequest.body", - "type": "CompoundType", + "id": "def-common.GetOnePackagePolicyResponse.item", + "type": "Object", "tags": [], - "label": "body", + "label": "item", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" - }, - " & { force?: boolean | undefined; }" + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + } ], "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false @@ -11176,28 +9474,28 @@ }, { "parentPluginId": "fleet", - "id": "def-common.CreatePackagePolicyResponse", + "id": "def-common.GetPackagePoliciesRequest", "type": "Interface", "tags": [], - "label": "CreatePackagePolicyResponse", + "label": "GetPackagePoliciesRequest", "description": [], "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.CreatePackagePolicyResponse.item", + "id": "def-common.GetPackagePoliciesRequest.query", "type": "Object", "tags": [], - "label": "item", + "label": "query", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicy", - "text": "PackagePolicy" + "section": "def-common.ListWithKuery", + "text": "ListWithKuery" } ], "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", @@ -11208,75 +9506,98 @@ }, { "parentPluginId": "fleet", - "id": "def-common.CurrentUpgrade", + "id": "def-common.GetPackagesResponse", "type": "Interface", "tags": [], - "label": "CurrentUpgrade", + "label": "GetPackagesResponse", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.CurrentUpgrade.actionId", - "type": "string", + "id": "def-common.GetPackagesResponse.items", + "type": "Array", "tags": [], - "label": "actionId", + "label": "items", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageListItem", + "text": "PackageListItem" + }, + "[]" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.CurrentUpgrade.complete", - "type": "boolean", + "id": "def-common.GetPackagesResponse.response", + "type": "Array", "tags": [], - "label": "complete", + "label": "response", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageList", + "text": "PackageList" + }, + " | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.IBulkInstallPackageHTTPError", + "type": "Interface", + "tags": [], + "label": "IBulkInstallPackageHTTPError", + "description": [], + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "deprecated": false, + "children": [ { "parentPluginId": "fleet", - "id": "def-common.CurrentUpgrade.nbAgents", - "type": "number", + "id": "def-common.IBulkInstallPackageHTTPError.name", + "type": "string", "tags": [], - "label": "nbAgents", + "label": "name", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.CurrentUpgrade.nbAgentsAck", + "id": "def-common.IBulkInstallPackageHTTPError.statusCode", "type": "number", "tags": [], - "label": "nbAgentsAck", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.CurrentUpgrade.version", - "type": "string", - "tags": [], - "label": "version", + "label": "statusCode", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.CurrentUpgrade.startTime", - "type": "string", + "id": "def-common.IBulkInstallPackageHTTPError.error", + "type": "CompoundType", "tags": [], - "label": "startTime", + "label": "error", "description": [], "signature": [ - "string | undefined" + "string | Error" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false } ], @@ -11284,196 +9605,227 @@ }, { "parentPluginId": "fleet", - "id": "def-common.DataStream", + "id": "def-common.Installation", "type": "Interface", "tags": [], - "label": "DataStream", + "label": "Installation", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installation", + "text": "Installation" + }, + " extends ", + "SavedObjectAttributes" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.DataStream.index", - "type": "string", + "id": "def-common.Installation.installed_kibana", + "type": "Array", "tags": [], - "label": "index", + "label": "installed_kibana", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetReference", + "text": "KibanaAssetReference" + }, + "[]" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DataStream.dataset", - "type": "string", + "id": "def-common.Installation.installed_es", + "type": "Array", "tags": [], - "label": "dataset", + "label": "installed_es", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.EsAssetReference", + "text": "EsAssetReference" + }, + "[]" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DataStream.namespace", - "type": "string", + "id": "def-common.Installation.package_assets", + "type": "Array", "tags": [], - "label": "namespace", + "label": "package_assets", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DataStream.type", - "type": "string", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageAssetReference", + "text": "PackageAssetReference" + }, + "[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.Installation.es_index_patterns", + "type": "Object", "tags": [], - "label": "type", + "label": "es_index_patterns", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "signature": [ + "{ [x: string]: string; }" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DataStream.package", + "id": "def-common.Installation.name", "type": "string", "tags": [], - "label": "package", + "label": "name", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DataStream.package_version", + "id": "def-common.Installation.version", "type": "string", "tags": [], - "label": "package_version", + "label": "version", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DataStream.last_activity_ms", - "type": "number", + "id": "def-common.Installation.install_status", + "type": "CompoundType", "tags": [], - "label": "last_activity_ms", + "label": "install_status", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "signature": [ + "\"installed\" | \"installing\" | \"install_failed\"" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DataStream.size_in_bytes", - "type": "number", + "id": "def-common.Installation.install_version", + "type": "string", + "tags": [], + "label": "install_version", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.Installation.install_started_at", + "type": "string", "tags": [], - "label": "size_in_bytes", + "label": "install_started_at", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DataStream.size_in_bytes_formatted", + "id": "def-common.Installation.install_source", "type": "CompoundType", "tags": [], - "label": "size_in_bytes_formatted", + "label": "install_source", "description": [], "signature": [ - "string | number" + "\"registry\" | \"upload\" | \"bundled\"" ], - "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DataStream.dashboards", - "type": "Array", + "id": "def-common.Installation.installed_kibana_space_id", + "type": "string", "tags": [], - "label": "dashboards", + "label": "installed_kibana_space_id", "description": [], "signature": [ - "{ id: string; title: string; }[]" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DataStream.serviceDetails", + "id": "def-common.Installation.keep_policies_up_to_date", "type": "CompoundType", "tags": [], - "label": "serviceDetails", + "label": "keep_policies_up_to_date", "description": [], "signature": [ - "{ environment: string; serviceName: string; } | null" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/data_stream.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DefaultPackagesInstallationError", - "type": "Interface", - "tags": [], - "label": "DefaultPackagesInstallationError", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.DefaultPackagesInstallationError.installType", - "type": "CompoundType", + "id": "def-common.Installation.install_format_schema_version", + "type": "string", "tags": [], - "label": "installType", + "label": "install_format_schema_version", "description": [], "signature": [ - "\"update\" | \"unknown\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" + "string | undefined" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DefaultPackagesInstallationError.error", - "type": "Object", + "id": "def-common.Installation.verification_status", + "type": "CompoundType", "tags": [], - "label": "error", + "label": "verification_status", "description": [], "signature": [ - "Error" + "\"unknown\" | \"verified\" | \"unverified\"" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DeleteAgentPolicyRequest", - "type": "Interface", - "tags": [], - "label": "DeleteAgentPolicyRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.DeleteAgentPolicyRequest.body", - "type": "Object", + "id": "def-common.Installation.verification_key_id", + "type": "CompoundType", "tags": [], - "label": "body", + "label": "verification_key_id", "description": [], "signature": [ - "{ agentPolicyId: string; }" + "string | null | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false } ], @@ -11481,107 +9833,84 @@ }, { "parentPluginId": "fleet", - "id": "def-common.DeleteAgentPolicyResponse", + "id": "def-common.InstallResult", "type": "Interface", "tags": [], - "label": "DeleteAgentPolicyResponse", + "label": "InstallResult", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.DeleteAgentPolicyResponse.id", - "type": "string", + "id": "def-common.InstallResult.assets", + "type": "Array", "tags": [], - "label": "id", + "label": "assets", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AssetReference", + "text": "AssetReference" + }, + "[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DeleteAgentPolicyResponse.name", - "type": "string", + "id": "def-common.InstallResult.status", + "type": "CompoundType", "tags": [], - "label": "name", + "label": "status", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "signature": [ + "\"installed\" | \"already_installed\" | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DeleteAgentRequest", - "type": "Interface", - "tags": [], - "label": "DeleteAgentRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.DeleteAgentRequest.params", + "id": "def-common.InstallResult.error", "type": "Object", "tags": [], - "label": "params", + "label": "error", "description": [], "signature": [ - "{ agentId: string; }" + "Error | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DeleteDownloadSourceResponse", - "type": "Interface", - "tags": [], - "label": "DeleteDownloadSourceResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.DeleteDownloadSourceResponse.id", - "type": "string", + "id": "def-common.InstallResult.installType", + "type": "CompoundType", "tags": [], - "label": "id", + "label": "installType", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", + "signature": [ + "\"unknown\" | \"update\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DeleteEnrollmentAPIKeyRequest", - "type": "Interface", - "tags": [], - "label": "DeleteEnrollmentAPIKeyRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.DeleteEnrollmentAPIKeyRequest.params", - "type": "Object", + "id": "def-common.InstallResult.installSource", + "type": "CompoundType", "tags": [], - "label": "params", + "label": "installSource", "description": [], "signature": [ - "{ keyId: string; }" + "\"registry\" | \"upload\" | \"bundled\"" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", "deprecated": false } ], @@ -11589,97 +9918,65 @@ }, { "parentPluginId": "fleet", - "id": "def-common.DeleteEnrollmentAPIKeyResponse", + "id": "def-common.ListResult", "type": "Interface", "tags": [], - "label": "DeleteEnrollmentAPIKeyResponse", + "label": "ListResult", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ListResult", + "text": "ListResult" + }, + "" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.DeleteEnrollmentAPIKeyResponse.action", - "type": "string", + "id": "def-common.ListResult.items", + "type": "Array", "tags": [], - "label": "action", + "label": "items", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "signature": [ + "T[]" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DeleteOutputResponse", - "type": "Interface", - "tags": [], - "label": "DeleteOutputResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.DeleteOutputResponse.id", - "type": "string", + "id": "def-common.ListResult.total", + "type": "number", "tags": [], - "label": "id", + "label": "total", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DeletePackagePoliciesRequest", - "type": "Interface", - "tags": [], - "label": "DeletePackagePoliciesRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.DeletePackagePoliciesRequest.body", - "type": "Object", + "id": "def-common.ListResult.page", + "type": "number", "tags": [], - "label": "body", + "label": "page", "description": [], - "signature": [ - "{ packagePolicyIds: string[]; force?: boolean | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DeletePackageRequest", - "type": "Interface", - "tags": [], - "label": "DeletePackageRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.DeletePackageRequest.params", - "type": "Object", + "id": "def-common.ListResult.perPage", + "type": "number", "tags": [], - "label": "params", + "label": "perPage", "description": [], - "signature": [ - "{ pkgkey?: string | undefined; pkgName: string; pkgVersion: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "deprecated": false } ], @@ -11687,95 +9984,88 @@ }, { "parentPluginId": "fleet", - "id": "def-common.DeletePackageResponse", + "id": "def-common.ListWithKuery", "type": "Interface", "tags": [], - "label": "DeletePackageResponse", + "label": "ListWithKuery", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ListWithKuery", + "text": "ListWithKuery" + }, + " extends ", + "HttpFetchQuery" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.DeletePackageResponse.response", - "type": "Array", + "id": "def-common.ListWithKuery.page", + "type": "number", "tags": [], - "label": "response", + "label": "page", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AssetReference", - "text": "AssetReference" - }, - "[] | undefined" + "number | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DeletePackageResponse.items", - "type": "Array", + "id": "def-common.ListWithKuery.perPage", + "type": "number", "tags": [], - "label": "items", + "label": "perPage", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AssetReference", - "text": "AssetReference" - }, - "[]" + "number | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DownloadSourceBase", - "type": "Interface", - "tags": [], - "label": "DownloadSourceBase", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/download_sources.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.DownloadSourceBase.name", + "id": "def-common.ListWithKuery.sortField", "type": "string", "tags": [], - "label": "name", + "label": "sortField", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/download_sources.ts", + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DownloadSourceBase.host", - "type": "string", + "id": "def-common.ListWithKuery.sortOrder", + "type": "CompoundType", "tags": [], - "label": "host", + "label": "sortOrder", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/download_sources.ts", + "signature": [ + "\"asc\" | \"desc\" | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DownloadSourceBase.is_default", - "type": "boolean", + "id": "def-common.ListWithKuery.kuery", + "type": "string", "tags": [], - "label": "is_default", + "label": "kuery", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/download_sources.ts", + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", "deprecated": false } ], @@ -11783,261 +10073,188 @@ }, { "parentPluginId": "fleet", - "id": "def-common.EnrollmentAPIKey", + "id": "def-common.NewAgentPolicy", "type": "Interface", "tags": [], - "label": "EnrollmentAPIKey", + "label": "NewAgentPolicy", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.EnrollmentAPIKey.id", + "id": "def-common.NewAgentPolicy.id", "type": "string", "tags": [], "label": "id", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.EnrollmentAPIKey.api_key_id", + "id": "def-common.NewAgentPolicy.name", "type": "string", "tags": [], - "label": "api_key_id", + "label": "name", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.EnrollmentAPIKey.api_key", + "id": "def-common.NewAgentPolicy.namespace", "type": "string", "tags": [], - "label": "api_key", + "label": "namespace", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.EnrollmentAPIKey.name", + "id": "def-common.NewAgentPolicy.description", "type": "string", "tags": [], - "label": "name", + "label": "description", "description": [], "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.EnrollmentAPIKey.active", - "type": "boolean", + "id": "def-common.NewAgentPolicy.is_default", + "type": "CompoundType", "tags": [], - "label": "active", + "label": "is_default", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.EnrollmentAPIKey.policy_id", - "type": "string", + "id": "def-common.NewAgentPolicy.is_default_fleet_server", + "type": "CompoundType", "tags": [], - "label": "policy_id", + "label": "is_default_fleet_server", "description": [], "signature": [ - "string | undefined" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.EnrollmentAPIKey.created_at", - "type": "string", + "id": "def-common.NewAgentPolicy.has_fleet_server", + "type": "CompoundType", "tags": [], - "label": "created_at", + "label": "has_fleet_server", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EpmPackageAdditions", - "type": "Interface", - "tags": [], - "label": "EpmPackageAdditions", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.EpmPackageAdditions.title", - "type": "string", + "id": "def-common.NewAgentPolicy.is_managed", + "type": "CompoundType", "tags": [], - "label": "title", + "label": "is_managed", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.EpmPackageAdditions.latestVersion", - "type": "string", + "id": "def-common.NewAgentPolicy.monitoring_enabled", + "type": "Array", "tags": [], - "label": "latestVersion", + "label": "monitoring_enabled", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "signature": [ + "(\"metrics\" | \"logs\")[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.EpmPackageAdditions.assets", - "type": "CompoundType", + "id": "def-common.NewAgentPolicy.unenroll_timeout", + "type": "number", "tags": [], - "label": "assets", + "label": "unenroll_timeout", "description": [], "signature": [ - "Record<\"kibana\", ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetTypeToParts", - "text": "KibanaAssetTypeToParts" - }, - "> & Record<\"elasticsearch\", ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetTypeToParts", - "text": "ElasticsearchAssetTypeToParts" - }, - ">" + "number | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.EpmPackageAdditions.notice", - "type": "string", + "id": "def-common.NewAgentPolicy.is_preconfigured", + "type": "CompoundType", "tags": [], - "label": "notice", + "label": "is_preconfigured", "description": [], "signature": [ - "string | undefined" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.EpmPackageAdditions.keepPoliciesUpToDate", + "id": "def-common.NewAgentPolicy.data_output_id", "type": "CompoundType", "tags": [], - "label": "keepPoliciesUpToDate", + "label": "data_output_id", "description": [], "signature": [ - "boolean | undefined" + "string | null | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ESAssetMetadata", - "type": "Interface", - "tags": [], - "label": "ESAssetMetadata", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.ESAssetMetadata.package", - "type": "Object", - "tags": [], - "label": "package", - "description": [], - "signature": [ - "{ name: string; } | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ESAssetMetadata.managed_by", - "type": "string", - "tags": [], - "label": "managed_by", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.ESAssetMetadata.managed", - "type": "boolean", - "tags": [], - "label": "managed", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FleetAuthz", - "type": "Interface", - "tags": [], - "label": "FleetAuthz", - "description": [], - "path": "x-pack/plugins/fleet/common/authz.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.FleetAuthz.fleet", - "type": "Object", + "id": "def-common.NewAgentPolicy.monitoring_output_id", + "type": "CompoundType", "tags": [], - "label": "fleet", + "label": "monitoring_output_id", "description": [], "signature": [ - "{ all: boolean; setup: boolean; readEnrollmentTokens: boolean; readAgentPolicies: boolean; }" + "string | null | undefined" ], - "path": "x-pack/plugins/fleet/common/authz.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetAuthz.integrations", - "type": "Object", + "id": "def-common.NewAgentPolicy.download_source_id", + "type": "CompoundType", "tags": [], - "label": "integrations", + "label": "download_source_id", "description": [], "signature": [ - "{ readPackageInfo: boolean; readInstalledPackages: boolean; installPackages: boolean; upgradePackages: boolean; removePackages: boolean; uploadPackages: boolean; readPackageSettings: boolean; writePackageSettings: boolean; readIntegrationPolicies: boolean; writeIntegrationPolicies: boolean; }" + "string | null | undefined" ], - "path": "x-pack/plugins/fleet/common/authz.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false } ], @@ -12045,173 +10262,133 @@ }, { "parentPluginId": "fleet", - "id": "def-common.FleetConfigType", + "id": "def-common.NewOutput", "type": "Interface", "tags": [], - "label": "FleetConfigType", + "label": "NewOutput", "description": [], - "path": "x-pack/plugins/fleet/common/types/index.ts", + "path": "x-pack/plugins/fleet/common/types/models/output.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.FleetConfigType.enabled", + "id": "def-common.NewOutput.is_default", "type": "boolean", "tags": [], - "label": "enabled", - "description": [], - "path": "x-pack/plugins/fleet/common/types/index.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FleetConfigType.registryUrl", - "type": "string", - "tags": [], - "label": "registryUrl", + "label": "is_default", "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/index.ts", + "path": "x-pack/plugins/fleet/common/types/models/output.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetConfigType.registryProxyUrl", - "type": "string", + "id": "def-common.NewOutput.is_default_monitoring", + "type": "boolean", "tags": [], - "label": "registryProxyUrl", + "label": "is_default_monitoring", "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/index.ts", + "path": "x-pack/plugins/fleet/common/types/models/output.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetConfigType.agents", - "type": "Object", + "id": "def-common.NewOutput.is_preconfigured", + "type": "CompoundType", "tags": [], - "label": "agents", + "label": "is_preconfigured", "description": [], "signature": [ - "{ enabled: boolean; elasticsearch: { hosts?: string[] | undefined; ca_sha256?: string | undefined; }; fleet_server?: { hosts?: string[] | undefined; } | undefined; }" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/types/index.ts", + "path": "x-pack/plugins/fleet/common/types/models/output.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetConfigType.agentPolicies", - "type": "Array", + "id": "def-common.NewOutput.name", + "type": "string", "tags": [], - "label": "agentPolicies", + "label": "name", "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PreconfiguredAgentPolicy", - "text": "PreconfiguredAgentPolicy" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/index.ts", + "path": "x-pack/plugins/fleet/common/types/models/output.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetConfigType.packages", - "type": "Array", + "id": "def-common.NewOutput.type", + "type": "CompoundType", "tags": [], - "label": "packages", + "label": "type", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PreconfiguredPackage", - "text": "PreconfiguredPackage" - }, - "[] | undefined" + "\"logstash\" | \"elasticsearch\"" ], - "path": "x-pack/plugins/fleet/common/types/index.ts", + "path": "x-pack/plugins/fleet/common/types/models/output.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetConfigType.outputs", + "id": "def-common.NewOutput.hosts", "type": "Array", "tags": [], - "label": "outputs", + "label": "hosts", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PreconfiguredOutput", - "text": "PreconfiguredOutput" - }, - "[] | undefined" + "string[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/index.ts", + "path": "x-pack/plugins/fleet/common/types/models/output.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetConfigType.agentIdVerificationEnabled", - "type": "CompoundType", + "id": "def-common.NewOutput.ca_sha256", + "type": "string", "tags": [], - "label": "agentIdVerificationEnabled", + "label": "ca_sha256", "description": [], "signature": [ - "boolean | undefined" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/index.ts", + "path": "x-pack/plugins/fleet/common/types/models/output.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetConfigType.enableExperimental", - "type": "Array", + "id": "def-common.NewOutput.ca_trusted_fingerprint", + "type": "string", "tags": [], - "label": "enableExperimental", + "label": "ca_trusted_fingerprint", "description": [], "signature": [ - "string[] | undefined" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/index.ts", + "path": "x-pack/plugins/fleet/common/types/models/output.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetConfigType.packageVerification", - "type": "Object", + "id": "def-common.NewOutput.config_yaml", + "type": "string", "tags": [], - "label": "packageVerification", + "label": "config_yaml", "description": [], "signature": [ - "{ gpgKeyPath?: string | undefined; } | undefined" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/index.ts", + "path": "x-pack/plugins/fleet/common/types/models/output.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetConfigType.developer", + "id": "def-common.NewOutput.ssl", "type": "Object", "tags": [], - "label": "developer", + "label": "ssl", "description": [], "signature": [ - "{ disableRegistryVersionCheck?: boolean | undefined; bundledPackageLocation?: string | undefined; } | undefined" + "{ certificate_authorities?: string[] | undefined; certificate?: string | undefined; key?: string | undefined; } | undefined" ], - "path": "x-pack/plugins/fleet/common/types/index.ts", + "path": "x-pack/plugins/fleet/common/types/models/output.ts", "deprecated": false } ], @@ -12219,461 +10396,532 @@ }, { "parentPluginId": "fleet", - "id": "def-common.FleetErrorResponse", + "id": "def-common.NewPackagePolicy", "type": "Interface", "tags": [], - "label": "FleetErrorResponse", + "label": "NewPackagePolicy", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/error.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.FleetErrorResponse.message", - "type": "string", + "id": "def-common.NewPackagePolicy.id", + "type": "CompoundType", "tags": [], - "label": "message", + "label": "id", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/error.ts", + "signature": [ + "string | number | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetErrorResponse.statusCode", - "type": "number", + "id": "def-common.NewPackagePolicy.name", + "type": "string", "tags": [], - "label": "statusCode", + "label": "name", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/error.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetErrorResponse.attributes", - "type": "Object", + "id": "def-common.NewPackagePolicy.description", + "type": "string", "tags": [], - "label": "attributes", + "label": "description", "description": [], "signature": [ - "{ type?: \"verification_failed\" | undefined; } | undefined" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/error.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent", - "type": "Interface", - "tags": [], - "label": "FleetServerAgent", - "description": [ - "\nAn Elastic Agent that has enrolled into Fleet" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent._version", - "type": "number", + "id": "def-common.NewPackagePolicy.namespace", + "type": "string", "tags": [], - "label": "_version", - "description": [ - "\nThe version of the document in the index" - ], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "label": "namespace", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.shared_id", - "type": "string", + "id": "def-common.NewPackagePolicy.enabled", + "type": "boolean", "tags": [], - "label": "shared_id", - "description": [ - "\nShared ID" - ], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "label": "enabled", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.type", + "id": "def-common.NewPackagePolicy.is_managed", "type": "CompoundType", "tags": [], - "label": "type", - "description": [ - "\nType" - ], + "label": "is_managed", + "description": [], "signature": [ - "\"PERMANENT\" | \"EPHEMERAL\" | \"TEMPORARY\"" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.active", - "type": "boolean", + "id": "def-common.NewPackagePolicy.policy_id", + "type": "string", "tags": [], - "label": "active", - "description": [ - "\nActive flag" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "label": "policy_id", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.enrolled_at", + "id": "def-common.NewPackagePolicy.output_id", "type": "string", "tags": [], - "label": "enrolled_at", - "description": [ - "\nDate/time the Elastic Agent enrolled" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "label": "output_id", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.unenrolled_at", - "type": "string", + "id": "def-common.NewPackagePolicy.package", + "type": "Object", "tags": [], - "label": "unenrolled_at", - "description": [ - "\nDate/time the Elastic Agent unenrolled" - ], + "label": "package", + "description": [], "signature": [ - "string | undefined" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyPackage", + "text": "PackagePolicyPackage" + }, + " | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.unenrollment_started_at", - "type": "string", + "id": "def-common.NewPackagePolicy.inputs", + "type": "Array", "tags": [], - "label": "unenrollment_started_at", - "description": [ - "\nDate/time the Elastic Agent unenrolled started" - ], + "label": "inputs", + "description": [], "signature": [ - "string | undefined" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicyInput", + "text": "NewPackagePolicyInput" + }, + "[]" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.upgraded_at", - "type": "CompoundType", + "id": "def-common.NewPackagePolicy.vars", + "type": "Object", "tags": [], - "label": "upgraded_at", - "description": [ - "\nDate/time the Elastic Agent was last upgraded" - ], + "label": "vars", + "description": [], "signature": [ - "string | null | undefined" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyConfigRecord", + "text": "PackagePolicyConfigRecord" + }, + " | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.upgrade_started_at", - "type": "CompoundType", + "id": "def-common.NewPackagePolicy.elasticsearch", + "type": "Object", "tags": [], - "label": "upgrade_started_at", - "description": [ - "\nDate/time the Elastic Agent started the current upgrade" + "label": "elasticsearch", + "description": [], + "signature": [ + "{ privileges?: { cluster?: string[] | undefined; } | undefined; } | undefined" ], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.NewPackagePolicyInput", + "type": "Interface", + "tags": [], + "label": "NewPackagePolicyInput", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.NewPackagePolicyInput.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], "signature": [ - "string | null | undefined" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.access_api_key_id", + "id": "def-common.NewPackagePolicyInput.type", "type": "string", "tags": [], - "label": "access_api_key_id", - "description": [ - "\nID of the API key the Elastic Agent must used to contact Fleet Server" - ], + "label": "type", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.NewPackagePolicyInput.policy_template", + "type": "string", + "tags": [], + "label": "policy_template", + "description": [], "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.agent", + "id": "def-common.NewPackagePolicyInput.enabled", + "type": "boolean", + "tags": [], + "label": "enabled", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.NewPackagePolicyInput.keep_enabled", + "type": "CompoundType", + "tags": [], + "label": "keep_enabled", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.NewPackagePolicyInput.vars", "type": "Object", "tags": [], - "label": "agent", + "label": "vars", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.FleetServerAgentMetadata", - "text": "FleetServerAgentMetadata" + "section": "def-common.PackagePolicyConfigRecord", + "text": "PackagePolicyConfigRecord" }, " | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.user_provided_metadata", + "id": "def-common.NewPackagePolicyInput.config", "type": "Object", "tags": [], - "label": "user_provided_metadata", - "description": [ - "\nUser provided metadata information for the Elastic Agent" - ], + "label": "config", + "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.AgentMetadata", - "text": "AgentMetadata" - } + "section": "def-common.PackagePolicyConfigRecord", + "text": "PackagePolicyConfigRecord" + }, + " | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.local_metadata", - "type": "Object", + "id": "def-common.NewPackagePolicyInput.streams", + "type": "Array", "tags": [], - "label": "local_metadata", - "description": [ - "\nLocal metadata information for the Elastic Agent" - ], + "label": "streams", + "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.AgentMetadata", - "text": "AgentMetadata" - } + "section": "def-common.NewPackagePolicyInputStream", + "text": "NewPackagePolicyInputStream" + }, + "[]" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.NewPackagePolicyInputStream", + "type": "Interface", + "tags": [], + "label": "NewPackagePolicyInputStream", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "deprecated": false, + "children": [ { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.policy_id", + "id": "def-common.NewPackagePolicyInputStream.id", "type": "string", "tags": [], - "label": "policy_id", - "description": [ - "\nThe policy ID for the Elastic Agent" - ], + "label": "id", + "description": [], "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.policy_revision_idx", - "type": "CompoundType", + "id": "def-common.NewPackagePolicyInputStream.enabled", + "type": "boolean", "tags": [], - "label": "policy_revision_idx", - "description": [ - "\nThe current policy revision_idx for the Elastic Agent" - ], - "signature": [ - "number | null | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "label": "enabled", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.policy_coordinator_idx", - "type": "number", + "id": "def-common.NewPackagePolicyInputStream.keep_enabled", + "type": "CompoundType", "tags": [], - "label": "policy_coordinator_idx", - "description": [ - "\nThe current policy coordinator for the Elastic Agent" - ], + "label": "keep_enabled", + "description": [], "signature": [ - "number | undefined" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.last_updated", - "type": "string", + "id": "def-common.NewPackagePolicyInputStream.data_stream", + "type": "Object", "tags": [], - "label": "last_updated", - "description": [ - "\nDate/time the Elastic Agent was last updated" - ], + "label": "data_stream", + "description": [], "signature": [ - "string | undefined" + "{ dataset: string; type: string; elasticsearch?: { privileges?: { indices?: string[] | undefined; } | undefined; } | undefined; }" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.last_checkin", - "type": "string", + "id": "def-common.NewPackagePolicyInputStream.vars", + "type": "Object", "tags": [], - "label": "last_checkin", - "description": [ - "\nDate/time the Elastic Agent checked in last time" - ], + "label": "vars", + "description": [], "signature": [ - "string | undefined" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyConfigRecord", + "text": "PackagePolicyConfigRecord" + }, + " | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.last_checkin_status", - "type": "CompoundType", + "id": "def-common.NewPackagePolicyInputStream.config", + "type": "Object", "tags": [], - "label": "last_checkin_status", - "description": [ - "\nLst checkin status" - ], + "label": "config", + "description": [], "signature": [ - "\"error\" | \"online\" | \"updating\" | \"degraded\" | undefined" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyConfigRecord", + "text": "PackagePolicyConfigRecord" + }, + " | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PackagePolicy", + "type": "Interface", + "tags": [], + "label": "PackagePolicy", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + }, + " extends Omit<", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" }, + ", \"inputs\">" + ], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "deprecated": false, + "children": [ { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.default_api_key_id", + "id": "def-common.PackagePolicy.id", "type": "string", "tags": [], - "label": "default_api_key_id", - "description": [ - "\nID of the API key the Elastic Agent uses to authenticate with elasticsearch" - ], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "label": "id", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.default_api_key", - "type": "string", + "id": "def-common.PackagePolicy.inputs", + "type": "Array", "tags": [], - "label": "default_api_key", - "description": [ - "\nAPI key the Elastic Agent uses to authenticate with elasticsearch" - ], + "label": "inputs", + "description": [], "signature": [ - "string | undefined" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyInput", + "text": "PackagePolicyInput" + }, + "[]" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.updated_at", + "id": "def-common.PackagePolicy.version", "type": "string", "tags": [], - "label": "updated_at", - "description": [ - "\nDate/time the Elastic Agent was last updated" - ], + "label": "version", + "description": [], "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.packages", - "type": "Array", + "id": "def-common.PackagePolicy.revision", + "type": "number", "tags": [], - "label": "packages", - "description": [ - "\nPackages array" - ], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "label": "revision", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.action_seq_no", - "type": "number", + "id": "def-common.PackagePolicy.updated_at", + "type": "string", "tags": [], - "label": "action_seq_no", - "description": [ - "\nThe last acknowledged action sequence number for the Elastic Agent" - ], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "label": "updated_at", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.tags", - "type": "Array", + "id": "def-common.PackagePolicy.updated_by", + "type": "string", "tags": [], - "label": "tags", - "description": [ - "\nA list of tags used for organizing/filtering agents" - ], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "label": "updated_by", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgent.default_api_key_history", - "type": "Array", + "id": "def-common.PackagePolicy.created_at", + "type": "string", "tags": [], - "label": "default_api_key_history", - "description": [ - "\nDefault API Key History" - ], - "signature": [ - "{ id: string; retired_at: string; }[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "label": "created_at", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PackagePolicy.created_by", + "type": "string", + "tags": [], + "label": "created_by", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false } ], @@ -12681,192 +10929,115 @@ }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentAction", + "id": "def-common.PackagePolicyConfigRecordEntry", "type": "Interface", "tags": [], - "label": "FleetServerAgentAction", - "description": [ - "\nAn Elastic Agent action" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "label": "PackagePolicyConfigRecordEntry", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentAction._id", + "id": "def-common.PackagePolicyConfigRecordEntry.type", "type": "string", "tags": [], - "label": "_id", - "description": [ - "\nThe unique identifier for action document" - ], + "label": "type", + "description": [], "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentAction._seq_no", - "type": "number", + "id": "def-common.PackagePolicyConfigRecordEntry.value", + "type": "Any", "tags": [], - "label": "_seq_no", - "description": [ - "\nThe action sequence number" - ], + "label": "value", + "description": [], "signature": [ - "number | undefined" + "any" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentAction.action_id", - "type": "string", + "id": "def-common.PackagePolicyConfigRecordEntry.frozen", + "type": "CompoundType", "tags": [], - "label": "action_id", - "description": [ - "\nThe unique identifier for the Elastic Agent action. There could be multiple documents with the same action_id if the action is split into two separate documents." - ], + "label": "frozen", + "description": [], "signature": [ - "string | undefined" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentAction.timestamp", - "type": "string", - "tags": [], - "label": "'@timestamp'", - "description": [ - "\nDate/time the action was created" - ], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentAction.expiration", - "type": "string", - "tags": [], - "label": "expiration", - "description": [ - "\nThe action expiration date/time" - ], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PackagePolicyInput", + "type": "Interface", + "tags": [], + "label": "PackagePolicyInput", + "description": [], + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentAction.type", - "type": "string", - "tags": [], - "label": "type", - "description": [ - "\nThe action type. APP_ACTION is the value for the actions that suppose to be routed to the endpoints/beats." - ], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyInput", + "text": "PackagePolicyInput" }, + " extends Omit<", { - "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentAction.input_id", - "type": "string", - "tags": [], - "label": "input_id", - "description": [ - "\nThe input identifier the actions should be routed to." - ], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicyInput", + "text": "NewPackagePolicyInput" }, + ", \"streams\">" + ], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "deprecated": false, + "children": [ { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentAction.agents", + "id": "def-common.PackagePolicyInput.streams", "type": "Array", "tags": [], - "label": "agents", - "description": [ - "\nThe Agent IDs the action is intended for. No support for json.RawMessage with the current generator. Could be useful to lazy parse the agent ids" - ], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentAction.start_time", - "type": "string", - "tags": [], - "label": "start_time", - "description": [ - "\nDate when the agent should execute that agent. This field could be altered by Fleet server for progressive rollout of the action." - ], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentAction.minimum_execution_duration", - "type": "number", - "tags": [], - "label": "minimum_execution_duration", - "description": [ - "\nMinimun execution duration in seconds, used for progressive rollout of the action." - ], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentAction.data", - "type": "Object", - "tags": [], - "label": "data", - "description": [ - "\nThe opaque payload." - ], + "label": "streams", + "description": [], "signature": [ - "{ [k: string]: unknown; } | undefined" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyInputStream", + "text": "PackagePolicyInputStream" + }, + "[]" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentAction.Unnamed", - "type": "IndexSignature", + "id": "def-common.PackagePolicyInput.compiled_input", + "type": "Any", "tags": [], - "label": "[k: string]: unknown", + "label": "compiled_input", "description": [], "signature": [ - "[k: string]: unknown" + "any" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false } ], @@ -12874,51 +11045,52 @@ }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentMetadata", + "id": "def-common.PackagePolicyInputStream", "type": "Interface", "tags": [], - "label": "FleetServerAgentMetadata", - "description": [ - "\nAn Elastic Agent metadata" + "label": "PackagePolicyInputStream", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyInputStream", + "text": "PackagePolicyInputStream" + }, + " extends ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicyInputStream", + "text": "NewPackagePolicyInputStream" + } ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentMetadata.id", + "id": "def-common.PackagePolicyInputStream.id", "type": "string", "tags": [], "label": "id", - "description": [ - "\nThe unique identifier for the Elastic Agent" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentMetadata.version", - "type": "string", - "tags": [], - "label": "version", - "description": [ - "\nThe version of the Elastic Agent" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerAgentMetadata.Unnamed", - "type": "IndexSignature", + "id": "def-common.PackagePolicyInputStream.compiled_stream", + "type": "Any", "tags": [], - "label": "[k: string]: any", + "label": "compiled_stream", "description": [], "signature": [ - "[k: string]: any" + "any" ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false } ], @@ -12926,120 +11098,104 @@ }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerEnrollmentAPIKey", + "id": "def-common.PackagePolicyPackage", "type": "Interface", "tags": [], - "label": "FleetServerEnrollmentAPIKey", - "description": [ - "\nAn Elastic Agent enrollment API key" - ], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "label": "PackagePolicyPackage", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.FleetServerEnrollmentAPIKey.active", - "type": "CompoundType", - "tags": [], - "label": "active", - "description": [ - "\nTrue when the key is active" - ], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FleetServerEnrollmentAPIKey.api_key_id", + "id": "def-common.PackagePolicyPackage.name", "type": "string", "tags": [], - "label": "api_key_id", - "description": [ - "\nThe unique identifier for the enrollment key, currently xid" - ], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "label": "name", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerEnrollmentAPIKey.api_key", + "id": "def-common.PackagePolicyPackage.title", "type": "string", "tags": [], - "label": "api_key", - "description": [ - "\nApi key" - ], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "label": "title", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerEnrollmentAPIKey.name", + "id": "def-common.PackagePolicyPackage.version", "type": "string", "tags": [], - "label": "name", - "description": [ - "\nEnrollment key name" - ], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "label": "version", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PackageSpecIcon", + "type": "Interface", + "tags": [], + "label": "PackageSpecIcon", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "deprecated": false, + "children": [ { "parentPluginId": "fleet", - "id": "def-common.FleetServerEnrollmentAPIKey.policy_id", + "id": "def-common.PackageSpecIcon.src", "type": "string", "tags": [], - "label": "policy_id", + "label": "src", "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerEnrollmentAPIKey.expire_at", + "id": "def-common.PackageSpecIcon.title", "type": "string", "tags": [], - "label": "expire_at", + "label": "title", "description": [], "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerEnrollmentAPIKey.created_at", + "id": "def-common.PackageSpecIcon.size", "type": "string", "tags": [], - "label": "created_at", + "label": "size", "description": [], "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerEnrollmentAPIKey.updated_at", + "id": "def-common.PackageSpecIcon.type", "type": "string", "tags": [], - "label": "updated_at", + "label": "type", "description": [], "signature": [ "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false } ], @@ -13047,239 +11203,235 @@ }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerPolicy", + "id": "def-common.PackageSpecManifest", "type": "Interface", "tags": [], - "label": "FleetServerPolicy", - "description": [ - "\nA policy that an Elastic Agent is attached to" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false, - "children": [ + "label": "PackageSpecManifest", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "deprecated": false, + "children": [ { "parentPluginId": "fleet", - "id": "def-common.FleetServerPolicy.timestamp", + "id": "def-common.PackageSpecManifest.format_version", "type": "string", "tags": [], - "label": "'@timestamp'", - "description": [ - "\nDate/time the policy revision was created" - ], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "label": "format_version", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerPolicy.policy_id", + "id": "def-common.PackageSpecManifest.name", "type": "string", "tags": [], - "label": "policy_id", - "description": [ - "\nThe ID of the policy" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "label": "name", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerPolicy.revision_idx", - "type": "number", + "id": "def-common.PackageSpecManifest.title", + "type": "string", "tags": [], - "label": "revision_idx", - "description": [ - "\nThe revision index of the policy" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "label": "title", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerPolicy.coordinator_idx", - "type": "number", + "id": "def-common.PackageSpecManifest.description", + "type": "string", "tags": [], - "label": "coordinator_idx", - "description": [ - "\nThe coordinator index of the policy" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "label": "description", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerPolicy.data", - "type": "Object", + "id": "def-common.PackageSpecManifest.version", + "type": "string", "tags": [], - "label": "data", - "description": [ - "\nThe opaque payload." - ], + "label": "version", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PackageSpecManifest.license", + "type": "string", + "tags": [], + "label": "license", + "description": [], "signature": [ - "{ [k: string]: unknown; }" + "\"basic\" | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerPolicy.default_fleet_server", - "type": "boolean", + "id": "def-common.PackageSpecManifest.type", + "type": "string", "tags": [], - "label": "default_fleet_server", - "description": [ - "\nTrue when this policy is the default policy to start Fleet Server" + "label": "type", + "description": [], + "signature": [ + "\"integration\" | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FleetServerPolicy.unenroll_timeout", - "type": "number", + "id": "def-common.PackageSpecManifest.release", + "type": "CompoundType", "tags": [], - "label": "unenroll_timeout", - "description": [ - "\nAuto unenroll any Elastic Agents which have not checked in for this many seconds" - ], + "label": "release", + "description": [], "signature": [ - "number | undefined" + "\"experimental\" | \"beta\" | \"ga\" | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicy", - "type": "Interface", - "tags": [], - "label": "FullAgentPolicy", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicy.id", - "type": "string", + "id": "def-common.PackageSpecManifest.categories", + "type": "Array", "tags": [], - "label": "id", + "label": "categories", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "signature": [ + "(", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageSpecCategory", + "text": "PackageSpecCategory" + }, + " | undefined)[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicy.outputs", + "id": "def-common.PackageSpecManifest.conditions", "type": "Object", "tags": [], - "label": "outputs", + "label": "conditions", "description": [], "signature": [ - "{ [key: string]: ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicyOutput", - "text": "FullAgentPolicyOutput" + "section": "def-common.PackageSpecConditions", + "text": "PackageSpecConditions" }, - "; }" + " | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicy.output_permissions", - "type": "Object", + "id": "def-common.PackageSpecManifest.icons", + "type": "Array", "tags": [], - "label": "output_permissions", + "label": "icons", "description": [], "signature": [ - "{ [output: string]: ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicyOutputPermissions", - "text": "FullAgentPolicyOutputPermissions" + "section": "def-common.PackageSpecIcon", + "text": "PackageSpecIcon" }, - "; } | undefined" + "[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicy.fleet", - "type": "CompoundType", + "id": "def-common.PackageSpecManifest.screenshots", + "type": "Array", "tags": [], - "label": "fleet", + "label": "screenshots", "description": [], "signature": [ - "{ hosts: string[]; } | { kibana: ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicyKibanaConfig", - "text": "FullAgentPolicyKibanaConfig" + "section": "def-common.PackageSpecScreenshot", + "text": "PackageSpecScreenshot" }, - "; } | undefined" + "[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicy.inputs", + "id": "def-common.PackageSpecManifest.policy_templates", "type": "Array", "tags": [], - "label": "inputs", + "label": "policy_templates", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicyInput", - "text": "FullAgentPolicyInput" + "section": "def-common.RegistryPolicyTemplate", + "text": "RegistryPolicyTemplate" }, - "[]" + "[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicy.revision", - "type": "number", + "id": "def-common.PackageSpecManifest.vars", + "type": "Array", "tags": [], - "label": "revision", + "label": "vars", "description": [], "signature": [ - "number | undefined" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryVarsEntry", + "text": "RegistryVarsEntry" + }, + "[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicy.agent", + "id": "def-common.PackageSpecManifest.owner", "type": "Object", "tags": [], - "label": "agent", + "label": "owner", "description": [], "signature": [ - "{ monitoring: { namespace?: string | undefined; use_output?: string | undefined; enabled: boolean; metrics: boolean; logs: boolean; }; download: { source_uri: string; }; } | undefined" + "{ github: string; }" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false } ], @@ -13287,129 +11439,107 @@ }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInput", + "id": "def-common.PackageSpecScreenshot", "type": "Interface", "tags": [], - "label": "FullAgentPolicyInput", + "label": "PackageSpecScreenshot", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInput.id", + "id": "def-common.PackageSpecScreenshot.src", "type": "string", "tags": [], - "label": "id", + "label": "src", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInput.name", + "id": "def-common.PackageSpecScreenshot.title", "type": "string", "tags": [], - "label": "name", + "label": "title", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInput.revision", - "type": "number", + "id": "def-common.PackageSpecScreenshot.size", + "type": "string", "tags": [], - "label": "revision", + "label": "size", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInput.type", + "id": "def-common.PackageSpecScreenshot.type", "type": "string", "tags": [], "label": "type", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInput.data_stream", - "type": "Object", - "tags": [], - "label": "data_stream", - "description": [], "signature": [ - "{ namespace: string; }" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInput.use_output", + "id": "def-common.PackageSpecScreenshot.path", "type": "string", "tags": [], - "label": "use_output", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInput.meta", - "type": "Object", - "tags": [], - "label": "meta", + "label": "path", "description": [], "signature": [ - "{ [key: string]: unknown; package?: Pick<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyPackage", - "text": "PackagePolicyPackage" - }, - ", \"name\" | \"version\"> | undefined; } | undefined" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", "deprecated": false - }, + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PostFleetSetupResponse", + "type": "Interface", + "tags": [], + "label": "PostFleetSetupResponse", + "description": [], + "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", + "deprecated": false, + "children": [ { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInput.streams", - "type": "Array", + "id": "def-common.PostFleetSetupResponse.isInitialized", + "type": "boolean", "tags": [], - "label": "streams", + "label": "isInitialized", "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicyInputStream", - "text": "FullAgentPolicyInputStream" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInput.Unnamed", - "type": "IndexSignature", + "id": "def-common.PostFleetSetupResponse.nonFatalErrors", + "type": "Array", "tags": [], - "label": "[key: string]: any", + "label": "nonFatalErrors", "description": [], "signature": [ - "[key: string]: any" + "{ name: string; message: string; }[]" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", "deprecated": false } ], @@ -13417,229 +11547,177 @@ }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInputStream", + "id": "def-common.RegistryDataStream", "type": "Interface", "tags": [], - "label": "FullAgentPolicyInputStream", + "label": "RegistryDataStream", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInputStream.id", + "id": "def-common.RegistryDataStream.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: any", + "description": [], + "signature": [ + "[key: string]: any" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.type", "type": "string", "tags": [], - "label": "id", + "label": "[RegistryDataStreamKeys.type]", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInputStream.data_stream", - "type": "Object", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.ilm_policy", + "type": "string", "tags": [], - "label": "data_stream", + "label": "[RegistryDataStreamKeys.ilm_policy]", "description": [], "signature": [ - "{ dataset: string; type: string; }" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyInputStream.Unnamed", - "type": "IndexSignature", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.hidden", + "type": "CompoundType", "tags": [], - "label": "[key: string]: any", + "label": "[RegistryDataStreamKeys.hidden]", "description": [], "signature": [ - "[key: string]: any" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyKibanaConfig", - "type": "Interface", - "tags": [], - "label": "FullAgentPolicyKibanaConfig", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyKibanaConfig.hosts", - "type": "Array", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.dataset", + "type": "string", "tags": [], - "label": "hosts", + "label": "[RegistryDataStreamKeys.dataset]", "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyKibanaConfig.protocol", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.title", "type": "string", "tags": [], - "label": "protocol", + "label": "[RegistryDataStreamKeys.title]", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyKibanaConfig.path", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.release", "type": "string", "tags": [], - "label": "path", + "label": "[RegistryDataStreamKeys.release]", "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyOutputPermissions", - "type": "Interface", - "tags": [], - "label": "FullAgentPolicyOutputPermissions", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyOutputPermissions.Unnamed", - "type": "IndexSignature", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.streams", + "type": "Array", "tags": [], - "label": "[packagePolicyName: string]: { cluster?: string[] | undefined; indices?: { names: string[]; privileges: string[]; }[] | undefined; }", + "label": "[RegistryDataStreamKeys.streams]", "description": [], "signature": [ - "[packagePolicyName: string]: { cluster?: string[] | undefined; indices?: { names: string[]; privileges: string[]; }[] | undefined; }" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryStream", + "text": "RegistryStream" + }, + "[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GenerateServiceTokenResponse", - "type": "Interface", - "tags": [], - "label": "GenerateServiceTokenResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GenerateServiceTokenResponse.name", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.package", "type": "string", "tags": [], - "label": "name", + "label": "[RegistryDataStreamKeys.package]", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.GenerateServiceTokenResponse.value", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.path", "type": "string", "tags": [], - "label": "value", + "label": "[RegistryDataStreamKeys.path]", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/app.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetAgentIncomingDataRequest", - "type": "Interface", - "tags": [], - "label": "GetAgentIncomingDataRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetAgentIncomingDataRequest.query", - "type": "Object", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.ingest_pipeline", + "type": "string", "tags": [], - "label": "query", + "label": "[RegistryDataStreamKeys.ingest_pipeline]", "description": [], "signature": [ - "{ agentsIds: string[]; previewData?: boolean | undefined; }" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetAgentIncomingDataResponse", - "type": "Interface", - "tags": [], - "label": "GetAgentIncomingDataResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetAgentIncomingDataResponse.items", - "type": "Array", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.elasticsearch", + "type": "Object", "tags": [], - "label": "items", + "label": "[RegistryDataStreamKeys.elasticsearch]", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.IncomingDataList", - "text": "IncomingDataList" + "section": "def-common.RegistryElasticsearch", + "text": "RegistryElasticsearch" }, - "[]" + " | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.GetAgentIncomingDataResponse.dataPreview", - "type": "Array", + "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.dataset_is_prefix", + "type": "CompoundType", "tags": [], - "label": "dataPreview", + "label": "[RegistryDataStreamKeys.dataset_is_prefix]", "description": [], "signature": [ - "SearchHit", - "[]" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false } ], @@ -13647,32 +11725,38 @@ }, { "parentPluginId": "fleet", - "id": "def-common.GetAgentPoliciesRequest", + "id": "def-common.RegistryDataStreamPrivileges", "type": "Interface", "tags": [], - "label": "GetAgentPoliciesRequest", + "label": "RegistryDataStreamPrivileges", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.GetAgentPoliciesRequest.query", - "type": "CompoundType", + "id": "def-common.RegistryDataStreamPrivileges.cluster", + "type": "Array", "tags": [], - "label": "query", + "label": "cluster", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ListWithKuery", - "text": "ListWithKuery" - }, - " & { full?: boolean | undefined; }" + "string[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryDataStreamPrivileges.indices", + "type": "Array", + "tags": [], + "label": "indices", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false } ], @@ -13680,32 +11764,73 @@ }, { "parentPluginId": "fleet", - "id": "def-common.GetAgentsRequest", + "id": "def-common.RegistryElasticsearch", "type": "Interface", "tags": [], - "label": "GetAgentsRequest", + "label": "RegistryElasticsearch", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.GetAgentsRequest.query", - "type": "CompoundType", + "id": "def-common.RegistryElasticsearch.privileges", + "type": "Object", "tags": [], - "label": "query", + "label": "privileges", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.ListWithKuery", - "text": "ListWithKuery" + "section": "def-common.RegistryDataStreamPrivileges", + "text": "RegistryDataStreamPrivileges" }, - " & { showInactive: boolean; showUpgradeable?: boolean | undefined; }" + " | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryElasticsearch.index_template.settings", + "type": "Object", + "tags": [], + "label": "'index_template.settings'", + "description": [], + "signature": [ + "IndicesIndexSettings", + " | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryElasticsearch.index_template.mappings", + "type": "Object", + "tags": [], + "label": "'index_template.mappings'", + "description": [], + "signature": [ + "MappingTypeMapping", + " | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryElasticsearch.ingest_pipeline.name", + "type": "string", + "tags": [], + "label": "'ingest_pipeline.name'", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false } ], @@ -13713,68 +11838,39 @@ }, { "parentPluginId": "fleet", - "id": "def-common.GetAgentsResponse", + "id": "def-common.RegistryImage", "type": "Interface", "tags": [], - "label": "GetAgentsResponse", + "label": "RegistryImage", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.GetAgentsResponse", - "text": "GetAgentsResponse" + "section": "def-common.RegistryImage", + "text": "RegistryImage" }, " extends ", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.ListResult", - "text": "ListResult" - }, - "<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Agent", - "text": "Agent" - }, - ">" + "section": "def-common.PackageSpecIcon", + "text": "PackageSpecIcon" + } ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.GetAgentsResponse.totalInactive", - "type": "number", - "tags": [], - "label": "totalInactive", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetAgentsResponse.list", - "type": "Array", + "id": "def-common.RegistryImage.path", + "type": "string", "tags": [], - "label": "list", + "label": "path", "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Agent", - "text": "Agent" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false } ], @@ -13782,189 +11878,108 @@ }, { "parentPluginId": "fleet", - "id": "def-common.GetAgentStatusRequest", + "id": "def-common.RegistryInput", "type": "Interface", "tags": [], - "label": "GetAgentStatusRequest", + "label": "RegistryInput", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.GetAgentStatusRequest.query", - "type": "Object", + "id": "def-common.RegistryInput.RegistryInputKeys.type", + "type": "string", "tags": [], - "label": "query", + "label": "[RegistryInputKeys.type]", "description": [], - "signature": [ - "{ kuery?: string | undefined; policyId?: string | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetAgentStatusResponse", - "type": "Interface", - "tags": [], - "label": "GetAgentStatusResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetAgentStatusResponse.results", - "type": "Object", + "id": "def-common.RegistryInput.RegistryInputKeys.title", + "type": "string", "tags": [], - "label": "results", + "label": "[RegistryInputKeys.title]", "description": [], - "signature": [ - "{ events: number; total: number; online: number; error: number; offline: number; other: number; updating: number; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetAgentTagsResponse", - "type": "Interface", - "tags": [], - "label": "GetAgentTagsResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetAgentTagsResponse.items", - "type": "Array", + "id": "def-common.RegistryInput.RegistryInputKeys.description", + "type": "string", "tags": [], - "label": "items", + "label": "[RegistryInputKeys.description]", "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetCategoriesRequest", - "type": "Interface", - "tags": [], - "label": "GetCategoriesRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetCategoriesRequest.query", - "type": "Object", + "id": "def-common.RegistryInput.RegistryInputKeys.template_path", + "type": "string", "tags": [], - "label": "query", + "label": "[RegistryInputKeys.template_path]", "description": [], "signature": [ - "{ experimental?: boolean | undefined; include_policy_templates?: boolean | undefined; }" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetCategoriesResponse", - "type": "Interface", - "tags": [], - "label": "GetCategoriesResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetCategoriesResponse.items", - "type": "Array", + "id": "def-common.RegistryInput.RegistryInputKeys.condition", + "type": "string", "tags": [], - "label": "items", + "label": "[RegistryInputKeys.condition]", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.CategorySummaryItem", - "text": "CategorySummaryItem" - }, - "[]" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.GetCategoriesResponse.response", - "type": "Array", + "id": "def-common.RegistryInput.RegistryInputKeys.input_group", + "type": "CompoundType", "tags": [], - "label": "response", + "label": "[RegistryInputKeys.input_group]", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.CategorySummaryList", - "text": "CategorySummaryList" + "section": "def-common.RegistryInputGroup", + "text": "RegistryInputGroup" }, " | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetCurrentUpgradesResponse", - "type": "Interface", - "tags": [], - "label": "GetCurrentUpgradesResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetCurrentUpgradesResponse.items", + "id": "def-common.RegistryInput.RegistryInputKeys.vars", "type": "Array", "tags": [], - "label": "items", + "label": "[RegistryInputKeys.vars]", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.CurrentUpgrade", - "text": "CurrentUpgrade" + "section": "def-common.RegistryVarsEntry", + "text": "RegistryVarsEntry" }, - "[]" + "[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false } ], @@ -13972,152 +11987,162 @@ }, { "parentPluginId": "fleet", - "id": "def-common.GetDataStreamsResponse", + "id": "def-common.RegistryPolicyTemplate", "type": "Interface", "tags": [], - "label": "GetDataStreamsResponse", + "label": "RegistryPolicyTemplate", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.GetDataStreamsResponse.data_streams", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.name", + "type": "string", + "tags": [], + "label": "[RegistryPolicyTemplateKeys.name]", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.title", + "type": "string", + "tags": [], + "label": "[RegistryPolicyTemplateKeys.title]", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.description", + "type": "string", + "tags": [], + "label": "[RegistryPolicyTemplateKeys.description]", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.icons", "type": "Array", "tags": [], - "label": "data_streams", + "label": "[RegistryPolicyTemplateKeys.icons]", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.DataStream", - "text": "DataStream" + "section": "def-common.RegistryImage", + "text": "RegistryImage" }, - "[]" + "[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetEnrollmentAPIKeysRequest", - "type": "Interface", - "tags": [], - "label": "GetEnrollmentAPIKeysRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetEnrollmentAPIKeysRequest.query", - "type": "Object", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.screenshots", + "type": "Array", "tags": [], - "label": "query", + "label": "[RegistryPolicyTemplateKeys.screenshots]", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.ListWithKuery", - "text": "ListWithKuery" - } + "section": "def-common.RegistryImage", + "text": "RegistryImage" + }, + "[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetFileRequest", - "type": "Interface", - "tags": [], - "label": "GetFileRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetFileRequest.params", - "type": "Object", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.categories", + "type": "Array", "tags": [], - "label": "params", + "label": "[RegistryPolicyTemplateKeys.categories]", "description": [], "signature": [ - "{ pkgName: string; pkgVersion: string; filePath: string; }" + "(", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageSpecCategory", + "text": "PackageSpecCategory" + }, + " | undefined)[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetFleetStatusResponse", - "type": "Interface", - "tags": [], - "label": "GetFleetStatusResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetFleetStatusResponse.isReady", - "type": "boolean", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.data_streams", + "type": "Array", "tags": [], - "label": "isReady", + "label": "[RegistryPolicyTemplateKeys.data_streams]", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", + "signature": [ + "string[] | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.GetFleetStatusResponse.missing_requirements", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.inputs", "type": "Array", "tags": [], - "label": "missing_requirements", + "label": "[RegistryPolicyTemplateKeys.inputs]", "description": [], "signature": [ - "(\"fleet_server\" | \"security_required\" | \"tls_required\" | \"api_keys\" | \"fleet_admin_user\")[]" + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryInput", + "text": "RegistryInput" + }, + "[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.GetFleetStatusResponse.missing_optional_features", - "type": "Array", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.readme", + "type": "string", "tags": [], - "label": "missing_optional_features", + "label": "[RegistryPolicyTemplateKeys.readme]", "description": [], "signature": [ - "\"encrypted_saved_object_encryption_key_required\"[]" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.GetFleetStatusResponse.package_verification_key_id", - "type": "string", + "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.multiple", + "type": "CompoundType", "tags": [], - "label": "package_verification_key_id", + "label": "[RegistryPolicyTemplateKeys.multiple]", "description": [], "signature": [ - "string | undefined" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false } ], @@ -14125,103 +12150,88 @@ }, { "parentPluginId": "fleet", - "id": "def-common.GetFullAgentConfigMapResponse", + "id": "def-common.RegistryStream", "type": "Interface", "tags": [], - "label": "GetFullAgentConfigMapResponse", + "label": "RegistryStream", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.GetFullAgentConfigMapResponse.item", + "id": "def-common.RegistryStream.RegistryStreamKeys.input", "type": "string", "tags": [], - "label": "item", + "label": "[RegistryStreamKeys.input]", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetFullAgentManifestResponse", - "type": "Interface", - "tags": [], - "label": "GetFullAgentManifestResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetFullAgentManifestResponse.item", + "id": "def-common.RegistryStream.RegistryStreamKeys.title", "type": "string", "tags": [], - "label": "item", + "label": "[RegistryStreamKeys.title]", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetFullAgentPolicyRequest", - "type": "Interface", - "tags": [], - "label": "GetFullAgentPolicyRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetFullAgentPolicyRequest.params", - "type": "Object", + "id": "def-common.RegistryStream.RegistryStreamKeys.description", + "type": "string", "tags": [], - "label": "params", + "label": "[RegistryStreamKeys.description]", "description": [], "signature": [ - "{ agentPolicyId: string; }" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetFullAgentPolicyResponse", - "type": "Interface", - "tags": [], - "label": "GetFullAgentPolicyResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetFullAgentPolicyResponse.item", - "type": "Object", + "id": "def-common.RegistryStream.RegistryStreamKeys.enabled", + "type": "CompoundType", "tags": [], - "label": "item", + "label": "[RegistryStreamKeys.enabled]", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryStream.RegistryStreamKeys.vars", + "type": "Array", + "tags": [], + "label": "[RegistryStreamKeys.vars]", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicy", - "text": "FullAgentPolicy" - } + "section": "def-common.RegistryVarsEntry", + "text": "RegistryVarsEntry" + }, + "[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryStream.RegistryStreamKeys.template_path", + "type": "string", + "tags": [], + "label": "[RegistryStreamKeys.template_path]", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false } ], @@ -14229,215 +12239,126 @@ }, { "parentPluginId": "fleet", - "id": "def-common.GetInfoRequest", + "id": "def-common.RegistryVarsEntry", "type": "Interface", "tags": [], - "label": "GetInfoRequest", + "label": "RegistryVarsEntry", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.GetInfoRequest.params", - "type": "Object", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.name", + "type": "string", + "tags": [], + "label": "[RegistryVarsEntryKeys.name]", + "description": [], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.title", + "type": "string", "tags": [], - "label": "params", + "label": "[RegistryVarsEntryKeys.title]", "description": [], "signature": [ - "{ pkgkey?: string | undefined; pkgName: string; pkgVersion: string; }" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetInfoResponse", - "type": "Interface", - "tags": [], - "label": "GetInfoResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetInfoResponse.item", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.description", + "type": "string", + "tags": [], + "label": "[RegistryVarsEntryKeys.description]", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.type", "type": "CompoundType", "tags": [], - "label": "item", + "label": "[RegistryVarsEntryKeys.type]", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Installable", - "text": "Installable" - }, - "> | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Installable", - "text": "Installable" - }, - ">" + "\"string\" | \"text\" | \"yaml\" | \"textarea\" | \"password\" | \"integer\" | \"bool\"" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.GetInfoResponse.response", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.required", "type": "CompoundType", "tags": [], - "label": "response", + "label": "[RegistryVarsEntryKeys.required]", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - }, - " | undefined" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetLimitedPackagesResponse", - "type": "Interface", - "tags": [], - "label": "GetLimitedPackagesResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetLimitedPackagesResponse.items", - "type": "Array", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.show_user", + "type": "CompoundType", "tags": [], - "label": "items", + "label": "[RegistryVarsEntryKeys.show_user]", "description": [], "signature": [ - "string[]" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.GetLimitedPackagesResponse.response", - "type": "Array", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.multi", + "type": "CompoundType", "tags": [], - "label": "response", + "label": "[RegistryVarsEntryKeys.multi]", "description": [], "signature": [ - "string[] | undefined" + "boolean | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetOneAgentPolicyRequest", - "type": "Interface", - "tags": [], - "label": "GetOneAgentPolicyRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetOneAgentPolicyRequest.params", - "type": "Object", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.default", + "type": "CompoundType", "tags": [], - "label": "params", + "label": "[RegistryVarsEntryKeys.default]", "description": [], "signature": [ - "{ agentPolicyId: string; }" + "string | boolean | string[] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetOneAgentPolicyResponse", - "type": "Interface", - "tags": [], - "label": "GetOneAgentPolicyResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetOneAgentPolicyResponse.item", + "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.os", "type": "Object", "tags": [], - "label": "item", + "label": "[RegistryVarsEntryKeys.os]", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentPolicy", - "text": "AgentPolicy" - } + "{ [key: string]: { default: string | string[]; }; } | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false } ], @@ -14445,25 +12366,42 @@ }, { "parentPluginId": "fleet", - "id": "def-common.GetOneAgentRequest", + "id": "def-common.UpdatePackagePolicy", "type": "Interface", "tags": [], - "label": "GetOneAgentRequest", + "label": "UpdatePackagePolicy", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.UpdatePackagePolicy", + "text": "UpdatePackagePolicy" + }, + " extends ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + } + ], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.GetOneAgentRequest.params", - "type": "Object", + "id": "def-common.UpdatePackagePolicy.version", + "type": "string", "tags": [], - "label": "params", + "label": "version", "description": [], "signature": [ - "{ agentId: string; }" + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false } ], @@ -14471,89 +12409,51 @@ }, { "parentPluginId": "fleet", - "id": "def-common.GetOneAgentResponse", + "id": "def-common.UpgradePackagePolicyBaseResponse", "type": "Interface", "tags": [], - "label": "GetOneAgentResponse", + "label": "UpgradePackagePolicyBaseResponse", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.GetOneAgentResponse.item", - "type": "Object", + "id": "def-common.UpgradePackagePolicyBaseResponse.name", + "type": "string", "tags": [], - "label": "item", + "label": "name", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Agent", - "text": "Agent" - } + "string | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetOneDownloadSourceRequest", - "type": "Interface", - "tags": [], - "label": "GetOneDownloadSourceRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetOneDownloadSourceRequest.params", - "type": "Object", + "id": "def-common.UpgradePackagePolicyBaseResponse.statusCode", + "type": "number", "tags": [], - "label": "params", + "label": "statusCode", "description": [], "signature": [ - "{ outputId: string; }" + "number | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetOneDownloadSourceResponse", - "type": "Interface", - "tags": [], - "label": "GetOneDownloadSourceResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetOneDownloadSourceResponse.item", + "id": "def-common.UpgradePackagePolicyBaseResponse.body", "type": "Object", "tags": [], - "label": "item", + "label": "body", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.DownloadSourceBase", - "text": "DownloadSourceBase" - } + "{ message: string; } | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false } ], @@ -14561,116 +12461,89 @@ }, { "parentPluginId": "fleet", - "id": "def-common.GetOneEnrollmentAPIKeyRequest", + "id": "def-common.UpgradePackagePolicyDryRunResponseItem", "type": "Interface", "tags": [], - "label": "GetOneEnrollmentAPIKeyRequest", + "label": "UpgradePackagePolicyDryRunResponseItem", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.UpgradePackagePolicyDryRunResponseItem", + "text": "UpgradePackagePolicyDryRunResponseItem" + }, + " extends ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.UpgradePackagePolicyBaseResponse", + "text": "UpgradePackagePolicyBaseResponse" + } + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.GetOneEnrollmentAPIKeyRequest.params", - "type": "Object", + "id": "def-common.UpgradePackagePolicyDryRunResponseItem.hasErrors", + "type": "boolean", "tags": [], - "label": "params", + "label": "hasErrors", "description": [], - "signature": [ - "{ keyId: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetOneEnrollmentAPIKeyResponse", - "type": "Interface", - "tags": [], - "label": "GetOneEnrollmentAPIKeyResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetOneEnrollmentAPIKeyResponse.item", + "id": "def-common.UpgradePackagePolicyDryRunResponseItem.diff", "type": "Object", "tags": [], - "label": "item", + "label": "diff", "description": [], "signature": [ + "[", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.EnrollmentAPIKey", - "text": "EnrollmentAPIKey" - } + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" + }, + ", ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.DryRunPackagePolicy", + "text": "DryRunPackagePolicy" + }, + "] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetOneOutputRequest", - "type": "Interface", - "tags": [], - "label": "GetOneOutputRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetOneOutputRequest.params", + "id": "def-common.UpgradePackagePolicyDryRunResponseItem.agent_diff", "type": "Object", "tags": [], - "label": "params", - "description": [], - "signature": [ - "{ outputId: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetOneOutputResponse", - "type": "Interface", - "tags": [], - "label": "GetOneOutputResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.GetOneOutputResponse.item", - "type": "CompoundType", - "tags": [], - "label": "item", + "label": "agent_diff", "description": [], "signature": [ + "[", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.NewOutput", - "text": "NewOutput" + "section": "def-common.FullAgentPolicyInput", + "text": "FullAgentPolicyInput" }, - " & { id: string; }" + "[]] | undefined" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false } ], @@ -14678,9369 +12551,1502 @@ }, { "parentPluginId": "fleet", - "id": "def-common.GetOnePackagePolicyRequest", + "id": "def-common.UpgradePackagePolicyResponseItem", "type": "Interface", "tags": [], - "label": "GetOnePackagePolicyRequest", + "label": "UpgradePackagePolicyResponseItem", "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.UpgradePackagePolicyResponseItem", + "text": "UpgradePackagePolicyResponseItem" + }, + " extends ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.UpgradePackagePolicyBaseResponse", + "text": "UpgradePackagePolicyBaseResponse" + } + ], "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.GetOnePackagePolicyRequest.params", - "type": "Object", + "id": "def-common.UpgradePackagePolicyResponseItem.id", + "type": "string", "tags": [], - "label": "params", + "label": "id", "description": [], - "signature": [ - "{ packagePolicyId: string; }" - ], "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetOnePackagePolicyResponse", - "type": "Interface", - "tags": [], - "label": "GetOnePackagePolicyResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.GetOnePackagePolicyResponse.item", - "type": "Object", + "id": "def-common.UpgradePackagePolicyResponseItem.success", + "type": "boolean", "tags": [], - "label": "item", + "label": "success", "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicy", - "text": "PackagePolicy" - } - ], "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", "deprecated": false } ], "initialIsOpen": false - }, + } + ], + "enums": [ { "parentPluginId": "fleet", - "id": "def-common.GetPackagePoliciesRequest", - "type": "Interface", + "id": "def-common.ElasticsearchAssetType", + "type": "Enum", "tags": [], - "label": "GetPackagePoliciesRequest", + "label": "ElasticsearchAssetType", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.GetPackagePoliciesRequest.query", - "type": "Object", - "tags": [], - "label": "query", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ListWithKuery", - "text": "ListWithKuery" - } - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false - } - ], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.GetPackagesRequest", - "type": "Interface", + "id": "def-common.KibanaAssetType", + "type": "Enum", "tags": [], - "label": "GetPackagesRequest", + "label": "KibanaAssetType", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.GetPackagesRequest.query", - "type": "Object", - "tags": [], - "label": "query", - "description": [], - "signature": [ - "{ category?: string | undefined; experimental?: boolean | undefined; excludeInstallStatus?: boolean | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - } - ], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.GetPackagesResponse", - "type": "Interface", + "id": "def-common.KibanaSavedObjectType", + "type": "Enum", "tags": [], - "label": "GetPackagesResponse", + "label": "KibanaSavedObjectType", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.GetPackagesResponse.items", - "type": "Array", - "tags": [], - "label": "items", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageListItem", - "text": "PackageListItem" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetPackagesResponse.response", - "type": "Array", - "tags": [], - "label": "response", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageList", - "text": "PackageList" - }, - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - } + "initialIsOpen": false + } + ], + "misc": [ + { + "parentPluginId": "fleet", + "id": "def-common.AGENT_ACTIONS_INDEX", + "type": "string", + "tags": [], + "label": "AGENT_ACTIONS_INDEX", + "description": [], + "signature": [ + "\".fleet-actions\"" ], + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.GetSettingsResponse", - "type": "Interface", + "id": "def-common.AGENT_ACTIONS_RESULTS_INDEX", + "type": "string", "tags": [], - "label": "GetSettingsResponse", + "label": "AGENT_ACTIONS_RESULTS_INDEX", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.GetSettingsResponse.item", - "type": "Object", - "tags": [], - "label": "item", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Settings", - "text": "Settings" - } - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", - "deprecated": false - } + "signature": [ + "\".fleet-actions-results\"" ], + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.GetStatsRequest", - "type": "Interface", + "id": "def-common.AGENT_POLICY_INDEX", + "type": "string", "tags": [], - "label": "GetStatsRequest", + "label": "AGENT_POLICY_INDEX", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.GetStatsRequest.params", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "{ pkgname: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - } + "signature": [ + "\".fleet-policies\"" ], + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.GetStatsResponse", - "type": "Interface", + "id": "def-common.AGENT_POLICY_SAVED_OBJECT_TYPE", + "type": "string", "tags": [], - "label": "GetStatsResponse", + "label": "AGENT_POLICY_SAVED_OBJECT_TYPE", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.GetStatsResponse.response", - "type": "Object", - "tags": [], - "label": "response", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageUsageStats", - "text": "PackageUsageStats" - } - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - } + "signature": [ + "\"ingest-agent-policies\"" ], + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.IBulkInstallPackageHTTPError", - "type": "Interface", + "id": "def-common.AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS", + "type": "number", "tags": [], - "label": "IBulkInstallPackageHTTPError", + "label": "AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.IBulkInstallPackageHTTPError.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IBulkInstallPackageHTTPError.statusCode", - "type": "number", - "tags": [], - "label": "statusCode", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IBulkInstallPackageHTTPError.error", - "type": "CompoundType", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "string | Error" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - } + "signature": [ + "30000" ], + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.IncomingDataList", - "type": "Interface", + "id": "def-common.AGENTS_INDEX", + "type": "string", "tags": [], - "label": "IncomingDataList", + "label": "AGENTS_INDEX", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", + "signature": [ + "\".fleet-agents\"" + ], + "path": "x-pack/plugins/fleet/common/constants/agent.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.IncomingDataList.Unnamed", - "type": "IndexSignature", - "tags": [], - "label": "[key: string]: { data: boolean; }", - "description": [], - "signature": [ - "[key: string]: { data: boolean; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - } + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENTS_PREFIX", + "type": "string", + "tags": [], + "label": "AGENTS_PREFIX", + "description": [], + "signature": [ + "\"fleet-agents\"" ], + "path": "x-pack/plugins/fleet/common/constants/agent.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.IndexTemplate", - "type": "Interface", + "id": "def-common.AgentStatus", + "type": "Type", "tags": [], - "label": "IndexTemplate", + "label": "AgentStatus", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "signature": [ + "\"error\" | \"warning\" | \"offline\" | \"online\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"updating\" | \"degraded\"" + ], + "path": "x-pack/plugins/fleet/common/types/models/agent.ts", "deprecated": false, - "children": [ + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.ArchivePackage", + "type": "Type", + "tags": [], + "label": "ArchivePackage", + "description": [], + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.IndexTemplate.priority", - "type": "number", - "tags": [], - "label": "priority", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageSpecManifest", + "text": "PackageSpecManifest" }, + " & Pick<", { - "parentPluginId": "fleet", - "id": "def-common.IndexTemplate.index_patterns", - "type": "Array", - "tags": [], - "label": "index_patterns", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IndexTemplate.template", - "type": "Object", - "tags": [], - "label": "template", - "description": [], - "signature": [ - "{ settings: any; mappings: any; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IndexTemplate.data_stream", - "type": "Object", - "tags": [], - "label": "data_stream", - "description": [], - "signature": [ - "{ hidden?: boolean | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryPackage", + "text": "RegistryPackage" }, + ", \"internal\" | \"assets\" | \"readme\" | \"data_streams\" | \"elasticsearch\">" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AssetReference", + "type": "Type", + "tags": [], + "label": "AssetReference", + "description": [], + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.IndexTemplate.composed_of", - "type": "Array", - "tags": [], - "label": "composed_of", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.EsAssetReference", + "text": "EsAssetReference" }, + " | ", { - "parentPluginId": "fleet", - "id": "def-common.IndexTemplate._meta", - "type": "Uncategorized", - "tags": [], - "label": "_meta", - "description": [], - "signature": [ - "object" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetReference", + "text": "KibanaAssetReference" } ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.IndexTemplateEntry", - "type": "Interface", + "id": "def-common.ASSETS_SAVED_OBJECT_TYPE", + "type": "string", "tags": [], - "label": "IndexTemplateEntry", + "label": "ASSETS_SAVED_OBJECT_TYPE", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "signature": [ + "\"epm-packages-assets\"" + ], + "path": "x-pack/plugins/fleet/common/constants/epm.ts", "deprecated": false, - "children": [ + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.DeletePackagePoliciesResponse", + "type": "Type", + "tags": [], + "label": "DeletePackagePoliciesResponse", + "description": [], + "signature": [ + "{ id: string; name?: string | undefined; success: boolean; package?: ", { - "parentPluginId": "fleet", - "id": "def-common.IndexTemplateEntry.templateName", - "type": "string", - "tags": [], - "label": "templateName", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyPackage", + "text": "PackagePolicyPackage" }, - { - "parentPluginId": "fleet", - "id": "def-common.IndexTemplateEntry.indexTemplate", - "type": "Object", - "tags": [], - "label": "indexTemplate", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.IndexTemplate", - "text": "IndexTemplate" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } + " | undefined; policy_id?: string | undefined; }[]" ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.IndexTemplateMappings", - "type": "Interface", + "id": "def-common.DocAssetType", + "type": "Type", "tags": [], - "label": "IndexTemplateMappings", + "label": "DocAssetType", "description": [], + "signature": [ + "\"notice\" | \"doc\"" + ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, - "children": [ + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.DryRunPackagePolicy", + "type": "Type", + "tags": [], + "label": "DryRunPackagePolicy", + "description": [], + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.IndexTemplateMappings.properties", - "type": "Any", - "tags": [], - "label": "properties", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewPackagePolicy", + "text": "NewPackagePolicy" + }, + " & { errors?: { key: string | undefined; message: string; }[] | undefined; missingVars?: string[] | undefined; }" ], + "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.Installation", - "type": "Interface", + "id": "def-common.ElasticsearchAssetParts", + "type": "Type", "tags": [], - "label": "Installation", + "label": "ElasticsearchAssetParts", "description": [], "signature": [ { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.Installation", - "text": "Installation" + "section": "def-common.AssetParts", + "text": "AssetParts" }, - " extends ", - "SavedObjectAttributes" + " & { service: \"elasticsearch\"; type: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetType", + "text": "ElasticsearchAssetType" + }, + "; }" ], "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, - "children": [ + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.ElasticsearchAssetTypeToParts", + "type": "Type", + "tags": [], + "label": "ElasticsearchAssetTypeToParts", + "description": [], + "signature": [ + "{ component_template: ", { - "parentPluginId": "fleet", - "id": "def-common.Installation.installed_kibana", - "type": "Array", - "tags": [], - "label": "installed_kibana", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetReference", - "text": "KibanaAssetReference" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" }, + "[]; ingest_pipeline: ", { - "parentPluginId": "fleet", - "id": "def-common.Installation.installed_es", - "type": "Array", - "tags": [], - "label": "installed_es", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.EsAssetReference", - "text": "EsAssetReference" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" }, + "[]; index_template: ", { - "parentPluginId": "fleet", - "id": "def-common.Installation.package_assets", - "type": "Array", - "tags": [], - "label": "package_assets", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageAssetReference", - "text": "PackageAssetReference" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" }, + "[]; ilm_policy: ", { - "parentPluginId": "fleet", - "id": "def-common.Installation.es_index_patterns", - "type": "Object", - "tags": [], - "label": "es_index_patterns", - "description": [], - "signature": [ - "{ [x: string]: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.Installation.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.Installation.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.Installation.install_status", - "type": "CompoundType", - "tags": [], - "label": "install_status", - "description": [], - "signature": [ - "\"installed\" | \"installing\" | \"install_failed\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.Installation.install_version", - "type": "string", - "tags": [], - "label": "install_version", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.Installation.install_started_at", - "type": "string", - "tags": [], - "label": "install_started_at", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.Installation.install_source", - "type": "CompoundType", - "tags": [], - "label": "install_source", - "description": [], - "signature": [ - "\"registry\" | \"upload\" | \"bundled\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.Installation.installed_kibana_space_id", - "type": "string", - "tags": [], - "label": "installed_kibana_space_id", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" }, + "[]; transform: ", { - "parentPluginId": "fleet", - "id": "def-common.Installation.keep_policies_up_to_date", - "type": "CompoundType", - "tags": [], - "label": "keep_policies_up_to_date", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" }, + "[]; data_stream_ilm_policy: ", { - "parentPluginId": "fleet", - "id": "def-common.Installation.install_format_schema_version", - "type": "string", - "tags": [], - "label": "install_format_schema_version", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" }, + "[]; ml_model: ", { - "parentPluginId": "fleet", - "id": "def-common.Installation.verification_status", - "type": "CompoundType", - "tags": [], - "label": "verification_status", - "description": [], - "signature": [ - "\"unknown\" | \"verified\" | \"unverified\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetParts", + "text": "ElasticsearchAssetParts" }, - { - "parentPluginId": "fleet", - "id": "def-common.Installation.verification_key_id", - "type": "CompoundType", - "tags": [], - "label": "verification_key_id", - "description": [], - "signature": [ - "string | null | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } + "[]; }" ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.InstallPackageRequest", - "type": "Interface", + "id": "def-common.EsAssetReference", + "type": "Type", "tags": [], - "label": "InstallPackageRequest", + "label": "EsAssetReference", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ + "signature": [ + "Pick<", + "SavedObjectReference", + ", \"id\"> & { type: ", { - "parentPluginId": "fleet", - "id": "def-common.InstallPackageRequest.params", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "{ pkgkey?: string | undefined; pkgName: string; pkgVersion: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - } + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ElasticsearchAssetType", + "text": "ElasticsearchAssetType" + }, + "; }" ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.InstallPackageResponse", - "type": "Interface", + "id": "def-common.FLEET_APM_PACKAGE", + "type": "string", "tags": [], - "label": "InstallPackageResponse", + "label": "FLEET_APM_PACKAGE", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.InstallPackageResponse.items", - "type": "Array", - "tags": [], - "label": "items", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AssetReference", - "text": "AssetReference" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstallPackageResponse._meta", - "type": "Object", - "tags": [], - "label": "_meta", - "description": [], - "signature": [ - "{ install_source: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.InstallSource", - "text": "InstallSource" - }, - "; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstallPackageResponse.response", - "type": "Array", - "tags": [], - "label": "response", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AssetReference", - "text": "AssetReference" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - } + "signature": [ + "\"apm\"" ], + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.InstallResult", - "type": "Interface", + "id": "def-common.FLEET_CLOUD_SECURITY_POSTURE_PACKAGE", + "type": "string", "tags": [], - "label": "InstallResult", + "label": "FLEET_CLOUD_SECURITY_POSTURE_PACKAGE", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.InstallResult.assets", - "type": "Array", - "tags": [], - "label": "assets", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AssetReference", - "text": "AssetReference" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstallResult.status", - "type": "CompoundType", - "tags": [], - "label": "status", - "description": [], - "signature": [ - "\"installed\" | \"already_installed\" | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstallResult.error", - "type": "Object", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "Error | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstallResult.installType", - "type": "CompoundType", - "tags": [], - "label": "installType", - "description": [], - "signature": [ - "\"update\" | \"unknown\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstallResult.installSource", - "type": "CompoundType", - "tags": [], - "label": "installSource", - "description": [], - "signature": [ - "\"registry\" | \"upload\" | \"bundled\"" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - } + "signature": [ + "\"cloud_security_posture\"" ], + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem", - "type": "Interface", + "id": "def-common.FLEET_ELASTIC_AGENT_PACKAGE", + "type": "string", "tags": [], - "label": "IntegrationCardItem", + "label": "FLEET_ELASTIC_AGENT_PACKAGE", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem.url", - "type": "string", - "tags": [], - "label": "url", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem.release", - "type": "CompoundType", - "tags": [], - "label": "release", - "description": [], - "signature": [ - "\"experimental\" | \"beta\" | \"ga\" | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem.description", - "type": "string", - "tags": [], - "label": "description", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem.icons", - "type": "Array", - "tags": [], - "label": "icons", - "description": [], - "signature": [ - "(", - { - "pluginId": "customIntegrations", - "scope": "common", - "docId": "kibCustomIntegrationsPluginApi", - "section": "def-common.CustomIntegrationIcon", - "text": "CustomIntegrationIcon" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecIcon", - "text": "PackageSpecIcon" - }, - ")[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem.integration", - "type": "string", - "tags": [], - "label": "integration", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem.categories", - "type": "Array", - "tags": [], - "label": "categories", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem.fromIntegrations", - "type": "string", - "tags": [], - "label": "fromIntegrations", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem.isUnverified", - "type": "CompoundType", - "tags": [], - "label": "isUnverified", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.IntegrationCardItem.showLabels", - "type": "CompoundType", - "tags": [], - "label": "showLabels", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } + "signature": [ + "\"elastic_agent\"" ], + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.ListResult", - "type": "Interface", + "id": "def-common.FLEET_ENDPOINT_PACKAGE", + "type": "string", "tags": [], - "label": "ListResult", + "label": "FLEET_ENDPOINT_PACKAGE", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ListResult", - "text": "ListResult" - }, - "" + "\"endpoint\"" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "path": "x-pack/plugins/fleet/common/constants/epm.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.ListResult.items", - "type": "Array", - "tags": [], - "label": "items", - "description": [], - "signature": [ - "T[]" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ListResult.total", - "type": "number", - "tags": [], - "label": "total", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ListResult.page", - "type": "number", - "tags": [], - "label": "page", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ListResult.perPage", - "type": "number", - "tags": [], - "label": "perPage", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", - "deprecated": false - } + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FLEET_KUBERNETES_PACKAGE", + "type": "string", + "tags": [], + "label": "FLEET_KUBERNETES_PACKAGE", + "description": [], + "signature": [ + "\"kubernetes\"" ], + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.ListWithKuery", - "type": "Interface", + "id": "def-common.FLEET_SERVER_ARTIFACTS_INDEX", + "type": "string", "tags": [], - "label": "ListWithKuery", + "label": "FLEET_SERVER_ARTIFACTS_INDEX", + "description": [], + "signature": [ + "\".fleet-artifacts\"" + ], + "path": "x-pack/plugins/fleet/common/constants/index.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FLEET_SERVER_PACKAGE", + "type": "string", + "tags": [], + "label": "FLEET_SERVER_PACKAGE", + "description": [], + "signature": [ + "\"fleet_server\"" + ], + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FLEET_SERVER_SERVERS_INDEX", + "type": "string", + "tags": [], + "label": "FLEET_SERVER_SERVERS_INDEX", + "description": [], + "signature": [ + "\".fleet-servers\"" + ], + "path": "x-pack/plugins/fleet/common/constants/index.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FLEET_SYNTHETICS_PACKAGE", + "type": "string", + "tags": [], + "label": "FLEET_SYNTHETICS_PACKAGE", + "description": [], + "signature": [ + "\"synthetics\"" + ], + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FLEET_SYSTEM_PACKAGE", + "type": "string", + "tags": [], + "label": "FLEET_SYSTEM_PACKAGE", + "description": [], + "signature": [ + "\"system\"" + ], + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.FullAgentPolicyOutput", + "type": "Type", + "tags": [], + "label": "FullAgentPolicyOutput", "description": [], "signature": [ + "Pick<", { "pluginId": "fleet", "scope": "common", "docId": "kibFleetPluginApi", - "section": "def-common.ListWithKuery", - "text": "ListWithKuery" + "section": "def-common.Output", + "text": "Output" }, - " extends ", - "HttpFetchQuery" + ", \"type\" | \"hosts\" | \"ca_sha256\"> & { [key: string]: any; }" ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", + "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.ListWithKuery.page", - "type": "number", - "tags": [], - "label": "page", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ListWithKuery.perPage", - "type": "number", - "tags": [], - "label": "perPage", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", - "deprecated": false - }, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.GetAgentPoliciesResponse", + "type": "Type", + "tags": [], + "label": "GetAgentPoliciesResponse", + "description": [], + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.ListWithKuery.sortField", - "type": "string", - "tags": [], - "label": "sortField", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ListResult", + "text": "ListResult" }, + "<", { - "parentPluginId": "fleet", - "id": "def-common.ListWithKuery.sortOrder", - "type": "CompoundType", - "tags": [], - "label": "sortOrder", - "description": [], - "signature": [ - "\"asc\" | \"desc\" | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.GetAgentPoliciesResponseItem", + "text": "GetAgentPoliciesResponseItem" }, - { - "parentPluginId": "fleet", - "id": "def-common.ListWithKuery.kuery", - "type": "string", - "tags": [], - "label": "kuery", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/common.ts", - "deprecated": false - } + ">" ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.MessageResponse", - "type": "Interface", + "id": "def-common.GetAgentPoliciesResponseItem", + "type": "Type", "tags": [], - "label": "MessageResponse", + "label": "GetAgentPoliciesResponseItem", "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.MessageResponse.response", - "type": "string", - "tags": [], - "label": "response", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - } + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AgentPolicy", + "text": "AgentPolicy" + }, + " & { agents?: number | undefined; }" ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.NewAgentAction", - "type": "Interface", + "id": "def-common.GetPackagePoliciesResponse", + "type": "Type", "tags": [], - "label": "NewAgentAction", + "label": "GetPackagePoliciesResponse", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false, - "children": [ + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.NewAgentAction.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\" | \"CANCEL\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ListResult", + "text": "ListResult" }, + "<", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentAction.data", - "type": "Any", - "tags": [], - "label": "data", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicy", + "text": "PackagePolicy" }, + ">" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.Installable", + "type": "Type", + "tags": [], + "label": "Installable", + "description": [], + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.NewAgentAction.ack_data", - "type": "Any", - "tags": [], - "label": "ack_data", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.InstallStatusExcluded", + "text": "InstallStatusExcluded" }, + " | ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentAction.sent_at", - "type": "string", - "tags": [], - "label": "sent_at", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.InstalledRegistry", + "text": "InstalledRegistry" }, + " | ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentAction.agents", - "type": "Array", - "tags": [], - "label": "agents", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installing", + "text": "Installing" }, + " | ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentAction.created_at", - "type": "string", - "tags": [], - "label": "created_at", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NotInstalled", + "text": "NotInstalled" }, + " | ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentAction.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.InstallFailed", + "text": "InstallFailed" }, + "" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.InstallablePackage", + "type": "Type", + "tags": [], + "label": "InstallablePackage", + "description": [], + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.NewAgentAction.expiration", - "type": "string", - "tags": [], - "label": "expiration", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryPackage", + "text": "RegistryPackage" }, + " | ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentAction.start_time", - "type": "string", - "tags": [], - "label": "start_time", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - }, + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.ArchivePackage", + "text": "ArchivePackage" + } + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.InstalledRegistry", + "type": "Type", + "tags": [], + "label": "InstalledRegistry", + "description": [], + "signature": [ + "T & { status: \"installed\"; savedObject: ", + "SavedObject", + "<", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentAction.minimum_execution_duration", - "type": "number", - "tags": [], - "label": "minimum_execution_duration", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installation", + "text": "Installation" }, - { - "parentPluginId": "fleet", - "id": "def-common.NewAgentAction.source_uri", - "type": "string", - "tags": [], - "label": "source_uri", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false - } + ">; }" ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy", - "type": "Interface", + "id": "def-common.InstallFailed", + "type": "Type", "tags": [], - "label": "NewAgentPolicy", + "label": "InstallFailed", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", + "signature": [ + "T & { status: \"install_failed\"; }" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, - "children": [ + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.Installing", + "type": "Type", + "tags": [], + "label": "Installing", + "description": [], + "signature": [ + "T & { status: \"installing\"; savedObject: ", + "SavedObject", + "<", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installation", + "text": "Installation" }, - { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false + ">; }" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.InstallStatusExcluded", + "type": "Type", + "tags": [], + "label": "InstallStatusExcluded", + "description": [], + "signature": [ + "T & { status: undefined; }" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.INTEGRATIONS_PLUGIN_ID", + "type": "string", + "tags": [], + "label": "INTEGRATIONS_PLUGIN_ID", + "description": [], + "signature": [ + "\"integrations\"" + ], + "path": "x-pack/plugins/fleet/common/constants/plugin.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.KibanaAssetParts", + "type": "Type", + "tags": [], + "label": "KibanaAssetParts", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.AssetParts", + "text": "AssetParts" }, + " & { service: \"kibana\"; type: ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.namespace", - "type": "string", - "tags": [], - "label": "namespace", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetType", + "text": "KibanaAssetType" }, + "; }" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.KibanaAssetReference", + "type": "Type", + "tags": [], + "label": "KibanaAssetReference", + "description": [], + "signature": [ + "Pick<", + "SavedObjectReference", + ", \"id\"> & { type: ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.description", - "type": "string", - "tags": [], - "label": "description", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaSavedObjectType", + "text": "KibanaSavedObjectType" }, + "; }" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.KibanaAssetTypeToParts", + "type": "Type", + "tags": [], + "label": "KibanaAssetTypeToParts", + "description": [], + "signature": [ + "{ dashboard: ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.is_default", - "type": "CompoundType", - "tags": [], - "label": "is_default", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" }, + "[]; visualization: ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.is_default_fleet_server", - "type": "CompoundType", - "tags": [], - "label": "is_default_fleet_server", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" }, + "[]; search: ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.has_fleet_server", - "type": "CompoundType", - "tags": [], - "label": "has_fleet_server", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" }, + "[]; index_pattern: ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.is_managed", - "type": "CompoundType", - "tags": [], - "label": "is_managed", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" }, + "[]; map: ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.monitoring_enabled", - "type": "Array", - "tags": [], - "label": "monitoring_enabled", - "description": [], - "signature": [ - "(\"metrics\" | \"logs\")[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" }, + "[]; lens: ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.unenroll_timeout", - "type": "number", - "tags": [], - "label": "unenroll_timeout", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" }, + "[]; security_rule: ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.is_preconfigured", - "type": "CompoundType", - "tags": [], - "label": "is_preconfigured", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" }, + "[]; csp_rule_template: ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.data_output_id", - "type": "CompoundType", - "tags": [], - "label": "data_output_id", - "description": [], - "signature": [ - "string | null | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" }, + "[]; ml_module: ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.monitoring_output_id", - "type": "CompoundType", - "tags": [], - "label": "monitoring_output_id", - "description": [], - "signature": [ - "string | null | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" }, + "[]; tag: ", { - "parentPluginId": "fleet", - "id": "def-common.NewAgentPolicy.download_source_id", - "type": "CompoundType", - "tags": [], - "label": "download_source_id", - "description": [], - "signature": [ - "string | null | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false - } + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, + "[]; osquery_pack_asset: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, + "[]; osquery_saved_query: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.KibanaAssetParts", + "text": "KibanaAssetParts" + }, + "[]; }" ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.NewOutput", - "type": "Interface", + "id": "def-common.NotInstalled", + "type": "Type", "tags": [], - "label": "NewOutput", + "label": "NotInstalled", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "signature": [ + "T & { status: \"not_installed\"; }" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", "deprecated": false, - "children": [ + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.Output", + "type": "Type", + "tags": [], + "label": "Output", + "description": [], + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.is_default", - "type": "boolean", - "tags": [], - "label": "is_default", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.NewOutput", + "text": "NewOutput" }, + " & { id: string; }" + ], + "path": "x-pack/plugins/fleet/common/types/models/output.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.OUTPUT_SAVED_OBJECT_TYPE", + "type": "string", + "tags": [], + "label": "OUTPUT_SAVED_OBJECT_TYPE", + "description": [], + "signature": [ + "\"ingest-outputs\"" + ], + "path": "x-pack/plugins/fleet/common/constants/output.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PACKAGE_POLICY_API_ROOT", + "type": "string", + "tags": [], + "label": "PACKAGE_POLICY_API_ROOT", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PACKAGE_POLICY_SAVED_OBJECT_TYPE", + "type": "string", + "tags": [], + "label": "PACKAGE_POLICY_SAVED_OBJECT_TYPE", + "description": [], + "signature": [ + "\"ingest-package-policies\"" + ], + "path": "x-pack/plugins/fleet/common/constants/package_policy.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PackageAssetReference", + "type": "Type", + "tags": [], + "label": "PackageAssetReference", + "description": [], + "signature": [ + "Pick<", + "SavedObjectReference", + ", \"id\"> & { type: \"epm-packages-assets\"; }" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PackageInfo", + "type": "Type", + "tags": [], + "label": "PackageInfo", + "description": [], + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.is_default_monitoring", - "type": "boolean", - "tags": [], - "label": "is_default_monitoring", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installable", + "text": "Installable" }, + "> | ", { - "parentPluginId": "fleet", - "id": "def-common.NewOutput.type", - "type": "CompoundType", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"logstash\" | \"elasticsearch\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installable", + "text": "Installable" }, + ">" ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicy", - "type": "Interface", + "id": "def-common.PackageList", + "type": "Type", "tags": [], - "label": "NewPackagePolicy", + "label": "PackageList", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicy.id", - "type": "CompoundType", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | number | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicy.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicy.description", - "type": "string", - "tags": [], - "label": "description", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicy.namespace", - "type": "string", - "tags": [], - "label": "namespace", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicy.enabled", - "type": "boolean", - "tags": [], - "label": "enabled", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicy.is_managed", - "type": "CompoundType", - "tags": [], - "label": "is_managed", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicy.policy_id", - "type": "string", - "tags": [], - "label": "policy_id", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicy.output_id", - "type": "string", - "tags": [], - "label": "output_id", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicy.package", - "type": "Object", - "tags": [], - "label": "package", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyPackage", - "text": "PackagePolicyPackage" - }, - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageListItem", + "text": "PackageListItem" }, + "[]" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PackageListItem", + "type": "Type", + "tags": [], + "label": "PackageListItem", + "description": [], + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicy.inputs", - "type": "Array", - "tags": [], - "label": "inputs", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicyInput", - "text": "NewPackagePolicyInput" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.Installable", + "text": "Installable" }, + "<", { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicy.vars", - "type": "Object", - "tags": [], - "label": "vars", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigRecord", - "text": "PackagePolicyConfigRecord" - }, - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistrySearchResult", + "text": "RegistrySearchResult" }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicy.elasticsearch", - "type": "Object", - "tags": [], - "label": "elasticsearch", - "description": [], - "signature": [ - "{ privileges?: { cluster?: string[] | undefined; } | undefined; } | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - } + "> & { integration?: string | undefined; id: string; }" ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInput", - "type": "Interface", + "id": "def-common.PackagePolicyConfigRecord", + "type": "Type", "tags": [], - "label": "NewPackagePolicyInput", + "label": "PackagePolicyConfigRecord", "description": [], + "signature": [ + "{ [x: string]: ", + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackagePolicyConfigRecordEntry", + "text": "PackagePolicyConfigRecordEntry" + }, + "; }" + ], "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInput.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PACKAGES_SAVED_OBJECT_TYPE", + "type": "string", + "tags": [], + "label": "PACKAGES_SAVED_OBJECT_TYPE", + "description": [], + "signature": [ + "\"epm-packages\"" + ], + "path": "x-pack/plugins/fleet/common/constants/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PackageSpecCategory", + "type": "Type", + "tags": [], + "label": "PackageSpecCategory", + "description": [], + "signature": [ + "\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\"" + ], + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PackageSpecConditions", + "type": "Type", + "tags": [], + "label": "PackageSpecConditions", + "description": [], + "signature": [ + "{ kibana: { version: string; }; }" + ], + "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PLUGIN_ID", + "type": "string", + "tags": [], + "label": "PLUGIN_ID", + "description": [], + "signature": [ + "\"fleet\"" + ], + "path": "x-pack/plugins/fleet/common/constants/plugin.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.PRECONFIGURATION_DELETION_RECORD_SAVED_OBJECT_TYPE", + "type": "string", + "tags": [], + "label": "PRECONFIGURATION_DELETION_RECORD_SAVED_OBJECT_TYPE", + "description": [], + "signature": [ + "\"fleet-preconfiguration-deletion-record\"" + ], + "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryInputGroup", + "type": "Type", + "tags": [], + "label": "RegistryInputGroup", + "description": [], + "signature": [ + "\"metrics\" | \"logs\"" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistryPackage", + "type": "Type", + "tags": [], + "label": "RegistryPackage", + "description": [], + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInput.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageSpecManifest", + "text": "PackageSpecManifest" }, + " & Partial & RegistryAdditionalProperties & RegistryOverridePropertyValue" + ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.RegistrySearchResult", + "type": "Type", + "tags": [], + "label": "RegistrySearchResult", + "description": [], + "signature": [ + "{ type?: \"integration\" | undefined; name: string; path: string; version: string; title: string; download: string; description: string; icons?: (", { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInput.policy_template", - "type": "string", - "tags": [], - "label": "policy_template", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageSpecIcon", + "text": "PackageSpecIcon" }, + "[] & ", { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInput.enabled", - "type": "boolean", - "tags": [], - "label": "enabled", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryImage", + "text": "RegistryImage" }, + "[]) | undefined; categories?: (", { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInput.keep_enabled", - "type": "CompoundType", - "tags": [], - "label": "keep_enabled", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.PackageSpecCategory", + "text": "PackageSpecCategory" }, + " | undefined)[] | undefined; internal?: boolean | undefined; release?: \"experimental\" | \"beta\" | \"ga\" | undefined; policy_templates?: ", { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInput.vars", - "type": "Object", - "tags": [], - "label": "vars", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigRecord", - "text": "PackagePolicyConfigRecord" - }, - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryPolicyTemplate", + "text": "RegistryPolicyTemplate" }, + "[] | undefined; data_streams?: ", { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInput.config", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigRecord", - "text": "PackagePolicyConfigRecord" - }, - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.RegistryDataStream", + "text": "RegistryDataStream" }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInput.streams", - "type": "Array", - "tags": [], - "label": "streams", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicyInputStream", - "text": "NewPackagePolicyInputStream" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - } + "[] | undefined; }" ], + "path": "x-pack/plugins/fleet/common/types/models/epm.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInputStream", - "type": "Interface", + "id": "def-common.SETUP_API_ROUTE", + "type": "string", "tags": [], - "label": "NewPackagePolicyInputStream", + "label": "SETUP_API_ROUTE", "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInputStream.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInputStream.enabled", - "type": "boolean", - "tags": [], - "label": "enabled", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInputStream.keep_enabled", - "type": "CompoundType", - "tags": [], - "label": "keep_enabled", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInputStream.data_stream", - "type": "Object", - "tags": [], - "label": "data_stream", - "description": [], - "signature": [ - "{ dataset: string; type: string; elasticsearch?: { privileges?: { indices?: string[] | undefined; } | undefined; } | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInputStream.vars", - "type": "Object", - "tags": [], - "label": "vars", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigRecord", - "text": "PackagePolicyConfigRecord" - }, - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NewPackagePolicyInputStream.config", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigRecord", - "text": "PackagePolicyConfigRecord" - }, - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - } - ], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.PackagePolicy", - "type": "Interface", + "id": "def-common.SO_SEARCH_LIMIT", + "type": "number", "tags": [], - "label": "PackagePolicy", + "label": "SO_SEARCH_LIMIT", "description": [], "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicy", - "text": "PackagePolicy" - }, - " extends Omit<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" - }, - ", \"inputs\">" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicy.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicy.inputs", - "type": "Array", - "tags": [], - "label": "inputs", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyInput", - "text": "PackagePolicyInput" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicy.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicy.revision", - "type": "number", - "tags": [], - "label": "revision", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicy.updated_at", - "type": "string", - "tags": [], - "label": "updated_at", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicy.updated_by", - "type": "string", - "tags": [], - "label": "updated_by", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicy.created_at", - "type": "string", - "tags": [], - "label": "created_at", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicy.created_by", - "type": "string", - "tags": [], - "label": "created_by", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - } + "10000" ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyConfigRecordEntry", - "type": "Interface", - "tags": [], - "label": "PackagePolicyConfigRecordEntry", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", + "path": "x-pack/plugins/fleet/common/constants/index.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyConfigRecordEntry.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyConfigRecordEntry.value", - "type": "Any", - "tags": [], - "label": "value", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyConfigRecordEntry.frozen", - "type": "CompoundType", - "tags": [], - "label": "frozen", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyConfigValidationResults", - "type": "Interface", - "tags": [], - "label": "PackagePolicyConfigValidationResults", - "description": [], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyConfigValidationResults.vars", - "type": "Object", - "tags": [], - "label": "vars", - "description": [], - "signature": [ - "ValidationEntry | undefined" - ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyInput", - "type": "Interface", - "tags": [], - "label": "PackagePolicyInput", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyInput", - "text": "PackagePolicyInput" - }, - " extends Omit<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicyInput", - "text": "NewPackagePolicyInput" - }, - ", \"streams\">" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyInput.streams", - "type": "Array", - "tags": [], - "label": "streams", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyInputStream", - "text": "PackagePolicyInputStream" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyInput.compiled_input", - "type": "Any", - "tags": [], - "label": "compiled_input", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyInputStream", - "type": "Interface", - "tags": [], - "label": "PackagePolicyInputStream", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyInputStream", - "text": "PackagePolicyInputStream" - }, - " extends ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicyInputStream", - "text": "NewPackagePolicyInputStream" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyInputStream.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyInputStream.compiled_stream", - "type": "Any", - "tags": [], - "label": "compiled_stream", - "description": [], - "signature": [ - "any" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyPackage", - "type": "Interface", - "tags": [], - "label": "PackagePolicyPackage", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyPackage.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyPackage.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyPackage.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecIcon", - "type": "Interface", - "tags": [], - "label": "PackageSpecIcon", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecIcon.src", - "type": "string", - "tags": [], - "label": "src", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecIcon.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecIcon.size", - "type": "string", - "tags": [], - "label": "size", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecIcon.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest", - "type": "Interface", - "tags": [], - "label": "PackageSpecManifest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.format_version", - "type": "string", - "tags": [], - "label": "format_version", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.description", - "type": "string", - "tags": [], - "label": "description", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.license", - "type": "string", - "tags": [], - "label": "license", - "description": [], - "signature": [ - "\"basic\" | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "\"integration\" | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.release", - "type": "CompoundType", - "tags": [], - "label": "release", - "description": [], - "signature": [ - "\"experimental\" | \"beta\" | \"ga\" | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.categories", - "type": "Array", - "tags": [], - "label": "categories", - "description": [], - "signature": [ - "(", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecCategory", - "text": "PackageSpecCategory" - }, - " | undefined)[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.conditions", - "type": "Object", - "tags": [], - "label": "conditions", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecConditions", - "text": "PackageSpecConditions" - }, - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.icons", - "type": "Array", - "tags": [], - "label": "icons", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecIcon", - "text": "PackageSpecIcon" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.screenshots", - "type": "Array", - "tags": [], - "label": "screenshots", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecScreenshot", - "text": "PackageSpecScreenshot" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.policy_templates", - "type": "Array", - "tags": [], - "label": "policy_templates", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryPolicyTemplate", - "text": "RegistryPolicyTemplate" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.vars", - "type": "Array", - "tags": [], - "label": "vars", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryVarsEntry", - "text": "RegistryVarsEntry" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecManifest.owner", - "type": "Object", - "tags": [], - "label": "owner", - "description": [], - "signature": [ - "{ github: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecScreenshot", - "type": "Interface", - "tags": [], - "label": "PackageSpecScreenshot", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecScreenshot.src", - "type": "string", - "tags": [], - "label": "src", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecScreenshot.title", - "type": "string", - "tags": [], - "label": "title", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecScreenshot.size", - "type": "string", - "tags": [], - "label": "size", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecScreenshot.type", - "type": "string", - "tags": [], - "label": "type", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecScreenshot.path", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageUsageStats", - "type": "Interface", - "tags": [], - "label": "PackageUsageStats", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PackageUsageStats.agent_policy_count", - "type": "number", - "tags": [], - "label": "agent_policy_count", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostAgentUnenrollRequest", - "type": "Interface", - "tags": [], - "label": "PostAgentUnenrollRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostAgentUnenrollRequest.params", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "{ agentId: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostAgentUnenrollRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ force?: boolean | undefined; revoke?: boolean | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostAgentUnenrollResponse", - "type": "Interface", - "tags": [], - "label": "PostAgentUnenrollResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostAgentUpgradeRequest", - "type": "Interface", - "tags": [], - "label": "PostAgentUpgradeRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostAgentUpgradeRequest.params", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "{ agentId: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostAgentUpgradeRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ source_uri?: string | undefined; version: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostAgentUpgradeResponse", - "type": "Interface", - "tags": [], - "label": "PostAgentUpgradeResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostBulkAgentReassignRequest", - "type": "Interface", - "tags": [], - "label": "PostBulkAgentReassignRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostBulkAgentReassignRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ policy_id: string; agents: string | string[]; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostBulkAgentUnenrollRequest", - "type": "Interface", - "tags": [], - "label": "PostBulkAgentUnenrollRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostBulkAgentUnenrollRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ agents: string | string[]; force?: boolean | undefined; revoke?: boolean | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostBulkAgentUpgradeRequest", - "type": "Interface", - "tags": [], - "label": "PostBulkAgentUpgradeRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostBulkAgentUpgradeRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ agents: string | string[]; source_uri?: string | undefined; version: string; rollout_duration_seconds?: number | undefined; start_time?: string | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostBulkUpdateAgentTagsRequest", - "type": "Interface", - "tags": [], - "label": "PostBulkUpdateAgentTagsRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostBulkUpdateAgentTagsRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ agents: string | string[]; tagsToAdd?: string[] | undefined; tagsToRemove?: string[] | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostDownloadSourceRequest", - "type": "Interface", - "tags": [], - "label": "PostDownloadSourceRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostDownloadSourceRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ id?: string | undefined; name: string; host: string; is_default?: boolean | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostEnrollmentAPIKeyRequest", - "type": "Interface", - "tags": [], - "label": "PostEnrollmentAPIKeyRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostEnrollmentAPIKeyRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ name?: string | undefined; policy_id: string; expiration?: string | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostEnrollmentAPIKeyResponse", - "type": "Interface", - "tags": [], - "label": "PostEnrollmentAPIKeyResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostEnrollmentAPIKeyResponse.action", - "type": "string", - "tags": [], - "label": "action", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostEnrollmentAPIKeyResponse.item", - "type": "Object", - "tags": [], - "label": "item", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.EnrollmentAPIKey", - "text": "EnrollmentAPIKey" - } - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostFleetSetupResponse", - "type": "Interface", - "tags": [], - "label": "PostFleetSetupResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostFleetSetupResponse.isInitialized", - "type": "boolean", - "tags": [], - "label": "isInitialized", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostFleetSetupResponse.nonFatalErrors", - "type": "Array", - "tags": [], - "label": "nonFatalErrors", - "description": [], - "signature": [ - "{ name: string; message: string; }[]" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostLogstashApiKeyResponse", - "type": "Interface", - "tags": [], - "label": "PostLogstashApiKeyResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostLogstashApiKeyResponse.api_key", - "type": "string", - "tags": [], - "label": "api_key", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostNewAgentActionRequest", - "type": "Interface", - "tags": [], - "label": "PostNewAgentActionRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostNewAgentActionRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ action: Omit<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewAgentAction", - "text": "NewAgentAction" - }, - ", \"agents\">; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostNewAgentActionRequest.params", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "{ agentId: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostNewAgentActionResponse", - "type": "Interface", - "tags": [], - "label": "PostNewAgentActionResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostNewAgentActionResponse.item", - "type": "Object", - "tags": [], - "label": "item", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentAction", - "text": "AgentAction" - } - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostOutputRequest", - "type": "Interface", - "tags": [], - "label": "PostOutputRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PostOutputRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ id?: string | undefined; type: \"logstash\" | \"elasticsearch\"; name: string; hosts?: string[] | undefined; ca_sha256?: string | undefined; ca_trusted_fingerprint?: string | undefined; is_default?: boolean | undefined; is_default_monitoring?: boolean | undefined; config_yaml?: string | undefined; ssl?: { certificate_authorities?: string[] | undefined; certificate?: string | undefined; key?: string | undefined; } | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PreconfigurationError", - "type": "Interface", - "tags": [], - "label": "PreconfigurationError", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PreconfigurationError.package", - "type": "Object", - "tags": [], - "label": "package", - "description": [], - "signature": [ - "{ name: string; version: string; } | undefined" - ], - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PreconfigurationError.agentPolicy", - "type": "Object", - "tags": [], - "label": "agentPolicy", - "description": [], - "signature": [ - "{ name: string; } | undefined" - ], - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PreconfigurationError.error", - "type": "Object", - "tags": [], - "label": "error", - "description": [], - "signature": [ - "Error" - ], - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PreconfiguredAgentPolicy", - "type": "Interface", - "tags": [], - "label": "PreconfiguredAgentPolicy", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PreconfiguredAgentPolicy", - "text": "PreconfiguredAgentPolicy" - }, - " extends Omit<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewAgentPolicy", - "text": "NewAgentPolicy" - }, - ", \"id\" | \"namespace\">" - ], - "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PreconfiguredAgentPolicy.id", - "type": "CompoundType", - "tags": [], - "label": "id", - "description": [], - "signature": [ - "string | number" - ], - "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PreconfiguredAgentPolicy.namespace", - "type": "string", - "tags": [], - "label": "namespace", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PreconfiguredAgentPolicy.package_policies", - "type": "Array", - "tags": [], - "label": "package_policies", - "description": [], - "signature": [ - "(Partial> & { id?: string | number | undefined; name: string; package: Partial<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyPackage", - "text": "PackagePolicyPackage" - }, - "> & { name: string; }; inputs?: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.InputsOverride", - "text": "InputsOverride" - }, - "[] | undefined; })[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PreconfiguredOutput", - "type": "Interface", - "tags": [], - "label": "PreconfiguredOutput", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PreconfiguredOutput", - "text": "PreconfiguredOutput" - }, - " extends Omit<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Output", - "text": "Output" - }, - ", \"config_yaml\">" - ], - "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PreconfiguredOutput.config", - "type": "Object", - "tags": [], - "label": "config", - "description": [], - "signature": [ - "Record | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PutAgentReassignRequest", - "type": "Interface", - "tags": [], - "label": "PutAgentReassignRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PutAgentReassignRequest.params", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "{ agentId: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PutAgentReassignRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ policy_id: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PutAgentReassignResponse", - "type": "Interface", - "tags": [], - "label": "PutAgentReassignResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PutDownloadSourceRequest", - "type": "Interface", - "tags": [], - "label": "PutDownloadSourceRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PutDownloadSourceRequest.params", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "{ outputId: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PutDownloadSourceRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ name: string; host: string; is_default?: boolean | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PutDownloadSourceResponse", - "type": "Interface", - "tags": [], - "label": "PutDownloadSourceResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PutDownloadSourceResponse.item", - "type": "Object", - "tags": [], - "label": "item", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.DownloadSourceBase", - "text": "DownloadSourceBase" - } - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PutOutputRequest", - "type": "Interface", - "tags": [], - "label": "PutOutputRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PutOutputRequest.params", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "{ outputId: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PutOutputRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ type?: \"logstash\" | \"elasticsearch\" | undefined; name?: string | undefined; hosts?: string[] | undefined; ca_sha256?: string | undefined; ca_trusted_fingerprint?: string | undefined; config_yaml?: string | undefined; is_default?: boolean | undefined; is_default_monitoring?: boolean | undefined; ssl?: { certificate_authorities?: string[] | undefined; certificate?: string | undefined; key?: string | undefined; } | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PutOutputResponse", - "type": "Interface", - "tags": [], - "label": "PutOutputResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PutOutputResponse.item", - "type": "CompoundType", - "tags": [], - "label": "item", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewOutput", - "text": "NewOutput" - }, - " & { id: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PutSettingsRequest", - "type": "Interface", - "tags": [], - "label": "PutSettingsRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PutSettingsRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ fleet_server_hosts?: string[] | undefined; preconfigured_fields?: \"fleet_server_hosts\"[] | undefined; has_seen_add_data_notice?: boolean | undefined; has_seen_fleet_migration_notice?: boolean | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PutSettingsResponse", - "type": "Interface", - "tags": [], - "label": "PutSettingsResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PutSettingsResponse.item", - "type": "Object", - "tags": [], - "label": "item", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Settings", - "text": "Settings" - } - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/settings.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream", - "type": "Interface", - "tags": [], - "label": "RegistryDataStream", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream.Unnamed", - "type": "IndexSignature", - "tags": [], - "label": "[key: string]: any", - "description": [], - "signature": [ - "[key: string]: any" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.type", - "type": "string", - "tags": [], - "label": "[RegistryDataStreamKeys.type]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.ilm_policy", - "type": "string", - "tags": [], - "label": "[RegistryDataStreamKeys.ilm_policy]", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.hidden", - "type": "CompoundType", - "tags": [], - "label": "[RegistryDataStreamKeys.hidden]", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.dataset", - "type": "string", - "tags": [], - "label": "[RegistryDataStreamKeys.dataset]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.title", - "type": "string", - "tags": [], - "label": "[RegistryDataStreamKeys.title]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.release", - "type": "string", - "tags": [], - "label": "[RegistryDataStreamKeys.release]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.streams", - "type": "Array", - "tags": [], - "label": "[RegistryDataStreamKeys.streams]", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryStream", - "text": "RegistryStream" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.package", - "type": "string", - "tags": [], - "label": "[RegistryDataStreamKeys.package]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.path", - "type": "string", - "tags": [], - "label": "[RegistryDataStreamKeys.path]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.ingest_pipeline", - "type": "string", - "tags": [], - "label": "[RegistryDataStreamKeys.ingest_pipeline]", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.elasticsearch", - "type": "Object", - "tags": [], - "label": "[RegistryDataStreamKeys.elasticsearch]", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryElasticsearch", - "text": "RegistryElasticsearch" - }, - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStream.RegistryDataStreamKeys.dataset_is_prefix", - "type": "CompoundType", - "tags": [], - "label": "[RegistryDataStreamKeys.dataset_is_prefix]", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStreamPrivileges", - "type": "Interface", - "tags": [], - "label": "RegistryDataStreamPrivileges", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStreamPrivileges.cluster", - "type": "Array", - "tags": [], - "label": "cluster", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStreamPrivileges.indices", - "type": "Array", - "tags": [], - "label": "indices", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryElasticsearch", - "type": "Interface", - "tags": [], - "label": "RegistryElasticsearch", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.RegistryElasticsearch.privileges", - "type": "Object", - "tags": [], - "label": "privileges", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryDataStreamPrivileges", - "text": "RegistryDataStreamPrivileges" - }, - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryElasticsearch.index_template.settings", - "type": "Object", - "tags": [], - "label": "'index_template.settings'", - "description": [], - "signature": [ - "IndicesIndexSettings", - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryElasticsearch.index_template.mappings", - "type": "Object", - "tags": [], - "label": "'index_template.mappings'", - "description": [], - "signature": [ - "MappingTypeMapping", - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryElasticsearch.ingest_pipeline.name", - "type": "string", - "tags": [], - "label": "'ingest_pipeline.name'", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryImage", - "type": "Interface", - "tags": [], - "label": "RegistryImage", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryImage", - "text": "RegistryImage" - }, - " extends ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecIcon", - "text": "PackageSpecIcon" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.RegistryImage.path", - "type": "string", - "tags": [], - "label": "path", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryInput", - "type": "Interface", - "tags": [], - "label": "RegistryInput", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.RegistryInput.RegistryInputKeys.type", - "type": "string", - "tags": [], - "label": "[RegistryInputKeys.type]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryInput.RegistryInputKeys.title", - "type": "string", - "tags": [], - "label": "[RegistryInputKeys.title]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryInput.RegistryInputKeys.description", - "type": "string", - "tags": [], - "label": "[RegistryInputKeys.description]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryInput.RegistryInputKeys.template_path", - "type": "string", - "tags": [], - "label": "[RegistryInputKeys.template_path]", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryInput.RegistryInputKeys.condition", - "type": "string", - "tags": [], - "label": "[RegistryInputKeys.condition]", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryInput.RegistryInputKeys.input_group", - "type": "CompoundType", - "tags": [], - "label": "[RegistryInputKeys.input_group]", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryInputGroup", - "text": "RegistryInputGroup" - }, - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryInput.RegistryInputKeys.vars", - "type": "Array", - "tags": [], - "label": "[RegistryInputKeys.vars]", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryVarsEntry", - "text": "RegistryVarsEntry" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate", - "type": "Interface", - "tags": [], - "label": "RegistryPolicyTemplate", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.name", - "type": "string", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.name]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.title", - "type": "string", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.title]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.description", - "type": "string", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.description]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.icons", - "type": "Array", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.icons]", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryImage", - "text": "RegistryImage" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.screenshots", - "type": "Array", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.screenshots]", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryImage", - "text": "RegistryImage" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.categories", - "type": "Array", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.categories]", - "description": [], - "signature": [ - "(", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecCategory", - "text": "PackageSpecCategory" - }, - " | undefined)[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.data_streams", - "type": "Array", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.data_streams]", - "description": [], - "signature": [ - "string[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.inputs", - "type": "Array", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.inputs]", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryInput", - "text": "RegistryInput" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.readme", - "type": "string", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.readme]", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplate.RegistryPolicyTemplateKeys.multiple", - "type": "CompoundType", - "tags": [], - "label": "[RegistryPolicyTemplateKeys.multiple]", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryStream", - "type": "Interface", - "tags": [], - "label": "RegistryStream", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.RegistryStream.RegistryStreamKeys.input", - "type": "string", - "tags": [], - "label": "[RegistryStreamKeys.input]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryStream.RegistryStreamKeys.title", - "type": "string", - "tags": [], - "label": "[RegistryStreamKeys.title]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryStream.RegistryStreamKeys.description", - "type": "string", - "tags": [], - "label": "[RegistryStreamKeys.description]", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryStream.RegistryStreamKeys.enabled", - "type": "CompoundType", - "tags": [], - "label": "[RegistryStreamKeys.enabled]", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryStream.RegistryStreamKeys.vars", - "type": "Array", - "tags": [], - "label": "[RegistryStreamKeys.vars]", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryVarsEntry", - "text": "RegistryVarsEntry" - }, - "[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryStream.RegistryStreamKeys.template_path", - "type": "string", - "tags": [], - "label": "[RegistryStreamKeys.template_path]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryVarsEntry", - "type": "Interface", - "tags": [], - "label": "RegistryVarsEntry", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.name", - "type": "string", - "tags": [], - "label": "[RegistryVarsEntryKeys.name]", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.title", - "type": "string", - "tags": [], - "label": "[RegistryVarsEntryKeys.title]", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.description", - "type": "string", - "tags": [], - "label": "[RegistryVarsEntryKeys.description]", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.type", - "type": "CompoundType", - "tags": [], - "label": "[RegistryVarsEntryKeys.type]", - "description": [], - "signature": [ - "\"string\" | \"text\" | \"yaml\" | \"textarea\" | \"password\" | \"integer\" | \"bool\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.required", - "type": "CompoundType", - "tags": [], - "label": "[RegistryVarsEntryKeys.required]", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.show_user", - "type": "CompoundType", - "tags": [], - "label": "[RegistryVarsEntryKeys.show_user]", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.multi", - "type": "CompoundType", - "tags": [], - "label": "[RegistryVarsEntryKeys.multi]", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.default", - "type": "CompoundType", - "tags": [], - "label": "[RegistryVarsEntryKeys.default]", - "description": [], - "signature": [ - "string | boolean | string[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryVarsEntry.RegistryVarsEntryKeys.os", - "type": "Object", - "tags": [], - "label": "[RegistryVarsEntryKeys.os]", - "description": [], - "signature": [ - "{ [key: string]: { default: string | string[]; }; } | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ServiceRequirements", - "type": "Interface", - "tags": [], - "label": "ServiceRequirements", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.ServiceRequirements.versions", - "type": "string", - "tags": [], - "label": "versions", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.Settings", - "type": "Interface", - "tags": [], - "label": "Settings", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Settings", - "text": "Settings" - }, - " extends ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.BaseSettings", - "text": "BaseSettings" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.Settings.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.Settings.preconfigured_fields", - "type": "Array", - "tags": [], - "label": "preconfigured_fields", - "description": [], - "signature": [ - "\"fleet_server_hosts\"[] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.SettingsSOAttributes", - "type": "Interface", - "tags": [], - "label": "SettingsSOAttributes", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.SettingsSOAttributes", - "text": "SettingsSOAttributes" - }, - " extends ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.BaseSettings", - "text": "BaseSettings" - }, - ",", - "SavedObjectAttributes" - ], - "path": "x-pack/plugins/fleet/common/types/models/settings.ts", - "deprecated": false, - "children": [], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.TemplateMapEntry", - "type": "Interface", - "tags": [], - "label": "TemplateMapEntry", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.TemplateMapEntry._meta", - "type": "Object", - "tags": [], - "label": "_meta", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ESAssetMetadata", - "text": "ESAssetMetadata" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.TemplateMapEntry.template", - "type": "CompoundType", - "tags": [], - "label": "template", - "description": [], - "signature": [ - "{ mappings: ", - "MappingTypeMapping", - "; } | { settings: object | ", - "IndicesIndexSettings", - "; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpdateAgentPolicyResponse", - "type": "Interface", - "tags": [], - "label": "UpdateAgentPolicyResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.UpdateAgentPolicyResponse.item", - "type": "Object", - "tags": [], - "label": "item", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentPolicy", - "text": "AgentPolicy" - } - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpdateAgentRequest", - "type": "Interface", - "tags": [], - "label": "UpdateAgentRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.UpdateAgentRequest.params", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "{ agentId: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpdateAgentRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ user_provided_metadata?: Record | undefined; tags?: string[] | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpdatePackagePolicy", - "type": "Interface", - "tags": [], - "label": "UpdatePackagePolicy", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.UpdatePackagePolicy", - "text": "UpdatePackagePolicy" - }, - " extends ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.UpdatePackagePolicy.version", - "type": "string", - "tags": [], - "label": "version", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpdatePackageRequest", - "type": "Interface", - "tags": [], - "label": "UpdatePackageRequest", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.UpdatePackageRequest.params", - "type": "Object", - "tags": [], - "label": "params", - "description": [], - "signature": [ - "{ pkgkey?: string | undefined; pkgName: string; pkgVersion: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpdatePackageRequest.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ keepPoliciesUpToDate?: boolean | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpdatePackageResponse", - "type": "Interface", - "tags": [], - "label": "UpdatePackageResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.UpdatePackageResponse.item", - "type": "CompoundType", - "tags": [], - "label": "item", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Installable", - "text": "Installable" - }, - "> | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Installable", - "text": "Installable" - }, - ">" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpdatePackageResponse.response", - "type": "CompoundType", - "tags": [], - "label": "response", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageInfo", - "text": "PackageInfo" - }, - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/epm.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpgradePackagePolicyBaseResponse", - "type": "Interface", - "tags": [], - "label": "UpgradePackagePolicyBaseResponse", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.UpgradePackagePolicyBaseResponse.name", - "type": "string", - "tags": [], - "label": "name", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpgradePackagePolicyBaseResponse.statusCode", - "type": "number", - "tags": [], - "label": "statusCode", - "description": [], - "signature": [ - "number | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpgradePackagePolicyBaseResponse.body", - "type": "Object", - "tags": [], - "label": "body", - "description": [], - "signature": [ - "{ message: string; } | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpgradePackagePolicyDryRunResponseItem", - "type": "Interface", - "tags": [], - "label": "UpgradePackagePolicyDryRunResponseItem", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.UpgradePackagePolicyDryRunResponseItem", - "text": "UpgradePackagePolicyDryRunResponseItem" - }, - " extends ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.UpgradePackagePolicyBaseResponse", - "text": "UpgradePackagePolicyBaseResponse" - } - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.UpgradePackagePolicyDryRunResponseItem.hasErrors", - "type": "boolean", - "tags": [], - "label": "hasErrors", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpgradePackagePolicyDryRunResponseItem.diff", - "type": "Object", - "tags": [], - "label": "diff", - "description": [], - "signature": [ - "[", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicy", - "text": "PackagePolicy" - }, - ", ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.DryRunPackagePolicy", - "text": "DryRunPackagePolicy" - }, - "] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpgradePackagePolicyDryRunResponseItem.agent_diff", - "type": "Object", - "tags": [], - "label": "agent_diff", - "description": [], - "signature": [ - "[", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.FullAgentPolicyInput", - "text": "FullAgentPolicyInput" - }, - "[]] | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpgradePackagePolicyResponseItem", - "type": "Interface", - "tags": [], - "label": "UpgradePackagePolicyResponseItem", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.UpgradePackagePolicyResponseItem", - "text": "UpgradePackagePolicyResponseItem" - }, - " extends ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.UpgradePackagePolicyBaseResponse", - "text": "UpgradePackagePolicyBaseResponse" - } - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.UpgradePackagePolicyResponseItem.id", - "type": "string", - "tags": [], - "label": "id", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpgradePackagePolicyResponseItem.success", - "type": "boolean", - "tags": [], - "label": "success", - "description": [], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], - "enums": [ - { - "parentPluginId": "fleet", - "id": "def-common.ElasticsearchAssetType", - "type": "Enum", - "tags": [], - "label": "ElasticsearchAssetType", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstallStatus", - "type": "Enum", - "tags": [], - "label": "InstallStatus", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.KibanaAssetType", - "type": "Enum", - "tags": [], - "label": "KibanaAssetType", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.KibanaSavedObjectType", - "type": "Enum", - "tags": [], - "label": "KibanaSavedObjectType", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryDataStreamKeys", - "type": "Enum", - "tags": [], - "label": "RegistryDataStreamKeys", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryInputKeys", - "type": "Enum", - "tags": [], - "label": "RegistryInputKeys", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPolicyTemplateKeys", - "type": "Enum", - "tags": [], - "label": "RegistryPolicyTemplateKeys", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryStreamKeys", - "type": "Enum", - "tags": [], - "label": "RegistryStreamKeys", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryVarsEntryKeys", - "type": "Enum", - "tags": [], - "label": "RegistryVarsEntryKeys", - "description": [], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "misc": [ - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_ACTIONS_INDEX", - "type": "string", - "tags": [], - "label": "AGENT_ACTIONS_INDEX", - "description": [], - "signature": [ - "\".fleet-actions\"" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_ACTIONS_RESULTS_INDEX", - "type": "string", - "tags": [], - "label": "AGENT_ACTIONS_RESULTS_INDEX", - "description": [], - "signature": [ - "\".fleet-actions-results\"" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_API_ROOT", - "type": "string", - "tags": [], - "label": "AGENT_POLICY_API_ROOT", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_DEFAULT_MONITORING_DATASETS", - "type": "Array", - "tags": [], - "label": "AGENT_POLICY_DEFAULT_MONITORING_DATASETS", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_INDEX", - "type": "string", - "tags": [], - "label": "AGENT_POLICY_INDEX", - "description": [], - "signature": [ - "\".fleet-policies\"" - ], - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_ROLLOUT_RATE_LIMIT_INTERVAL_MS", - "type": "number", - "tags": [], - "label": "AGENT_POLICY_ROLLOUT_RATE_LIMIT_INTERVAL_MS", - "description": [], - "signature": [ - "1000" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_ROLLOUT_RATE_LIMIT_REQUEST_PER_INTERVAL", - "type": "number", - "tags": [], - "label": "AGENT_POLICY_ROLLOUT_RATE_LIMIT_REQUEST_PER_INTERVAL", - "description": [], - "signature": [ - "5" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_SAVED_OBJECT_TYPE", - "type": "string", - "tags": [], - "label": "AGENT_POLICY_SAVED_OBJECT_TYPE", - "description": [], - "signature": [ - "\"ingest-agent-policies\"" - ], - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLLING_INTERVAL", - "type": "number", - "tags": [], - "label": "AGENT_POLLING_INTERVAL", - "description": [], - "signature": [ - "1000" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLLING_REQUEST_TIMEOUT_MARGIN_MS", - "type": "number", - "tags": [], - "label": "AGENT_POLLING_REQUEST_TIMEOUT_MARGIN_MS", - "description": [], - "signature": [ - "20000" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLLING_REQUEST_TIMEOUT_MS", - "type": "number", - "tags": [], - "label": "AGENT_POLLING_REQUEST_TIMEOUT_MS", - "description": [], - "signature": [ - "300000" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLLING_THRESHOLD_MS", - "type": "number", - "tags": [], - "label": "AGENT_POLLING_THRESHOLD_MS", - "description": [], - "signature": [ - "30000" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_TYPE_EPHEMERAL", - "type": "string", - "tags": [], - "label": "AGENT_TYPE_EPHEMERAL", - "description": [], - "signature": [ - "\"EPHEMERAL\"" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_TYPE_PERMANENT", - "type": "string", - "tags": [], - "label": "AGENT_TYPE_PERMANENT", - "description": [], - "signature": [ - "\"PERMANENT\"" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_TYPE_TEMPORARY", - "type": "string", - "tags": [], - "label": "AGENT_TYPE_TEMPORARY", - "description": [], - "signature": [ - "\"TEMPORARY\"" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_UPDATE_ACTIONS_INTERVAL_MS", - "type": "number", - "tags": [], - "label": "AGENT_UPDATE_ACTIONS_INTERVAL_MS", - "description": [], - "signature": [ - "5000" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS", - "type": "number", - "tags": [], - "label": "AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS", - "description": [], - "signature": [ - "30000" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentActionType", - "type": "Type", - "tags": [], - "label": "AgentActionType", - "description": [], - "signature": [ - "\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"POLICY_REASSIGN\" | \"CANCEL\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentAssetType", - "type": "Type", - "tags": [], - "label": "AgentAssetType", - "description": [], - "signature": [ - "{ readonly Input: \"input\"; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentPolicySOAttributes", - "type": "Type", - "tags": [], - "label": "AgentPolicySOAttributes", - "description": [], - "signature": [ - "{ status: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ValueOf", - "text": "ValueOf" - }, - "<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; name: string; namespace: string; description?: string | undefined; updated_at: string; updated_by: string; is_managed: boolean; is_default?: boolean | undefined; is_default_fleet_server?: boolean | undefined; has_fleet_server?: boolean | undefined; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; unenroll_timeout?: number | undefined; is_preconfigured?: boolean | undefined; data_output_id?: string | null | undefined; monitoring_output_id?: string | null | undefined; download_source_id?: string | null | undefined; package_policies: string[] | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicy", - "text": "PackagePolicy" - }, - "[]; revision: number; agents?: number | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentPolicyStatus", - "type": "Type", - "tags": [], - "label": "AgentPolicyStatus", - "description": [], - "signature": [ - "{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENTS_INDEX", - "type": "string", - "tags": [], - "label": "AGENTS_INDEX", - "description": [], - "signature": [ - "\".fleet-agents\"" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENTS_PREFIX", - "type": "string", - "tags": [], - "label": "AGENTS_PREFIX", - "description": [], - "signature": [ - "\"fleet-agents\"" - ], - "path": "x-pack/plugins/fleet/common/constants/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentStatus", - "type": "Type", - "tags": [], - "label": "AgentStatus", - "description": [], - "signature": [ - "\"error\" | \"warning\" | \"offline\" | \"online\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"updating\" | \"degraded\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AgentType", - "type": "Type", - "tags": [], - "label": "AgentType", - "description": [], - "signature": [ - "\"PERMANENT\" | \"EPHEMERAL\" | \"TEMPORARY\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.API_ROOT", - "type": "string", - "tags": [], - "label": "API_ROOT", - "description": [], - "signature": [ - "\"/api/fleet\"" - ], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ArchivePackage", - "type": "Type", - "tags": [], - "label": "ArchivePackage", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecManifest", - "text": "PackageSpecManifest" - }, - " & Pick<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryPackage", - "text": "RegistryPackage" - }, - ", \"internal\" | \"data_streams\" | \"assets\" | \"readme\" | \"elasticsearch\">" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AssetReference", - "type": "Type", - "tags": [], - "label": "AssetReference", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.EsAssetReference", - "text": "EsAssetReference" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetReference", - "text": "KibanaAssetReference" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ASSETS_SAVED_OBJECT_TYPE", - "type": "string", - "tags": [], - "label": "ASSETS_SAVED_OBJECT_TYPE", - "description": [], - "signature": [ - "\"epm-packages-assets\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AssetsGroupedByServiceByType", - "type": "Type", - "tags": [], - "label": "AssetsGroupedByServiceByType", - "description": [], - "signature": [ - "Record<\"kibana\", ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetTypeToParts", - "text": "KibanaAssetTypeToParts" - }, - "> & Record<\"elasticsearch\", ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetTypeToParts", - "text": "ElasticsearchAssetTypeToParts" - }, - ">" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AssetType", - "type": "Type", - "tags": [], - "label": "AssetType", - "description": [], - "signature": [ - "\"input\" | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.DocAssetType", - "text": "DocAssetType" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetType", - "text": "KibanaAssetType" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetType", - "text": "ElasticsearchAssetType" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AssetTypeToParts", - "type": "Type", - "tags": [], - "label": "AssetTypeToParts", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetTypeToParts", - "text": "KibanaAssetTypeToParts" - }, - " & ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetTypeToParts", - "text": "ElasticsearchAssetTypeToParts" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AUTO_UPDATE_PACKAGES", - "type": "Array", - "tags": [], - "label": "AUTO_UPDATE_PACKAGES", - "description": [], - "signature": [ - "{ name: string; version: string; }[]" - ], - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AUTO_UPGRADE_POLICIES_PACKAGES", - "type": "Array", - "tags": [], - "label": "AUTO_UPGRADE_POLICIES_PACKAGES", - "description": [], - "signature": [ - "{ name: string; version: string; }[]" - ], - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.autoUpdatePackages", - "type": "Array", - "tags": [], - "label": "autoUpdatePackages", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.autoUpgradePoliciesPackages", - "type": "Array", - "tags": [], - "label": "autoUpgradePoliciesPackages", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.CategoryId", - "type": "Type", - "tags": [], - "label": "CategoryId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.CategorySummaryList", - "type": "Type", - "tags": [], - "label": "CategorySummaryList", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.CategorySummaryItem", - "text": "CategorySummaryItem" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DATA_STREAM_API_ROOT", - "type": "string", - "tags": [], - "label": "DATA_STREAM_API_ROOT", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DataType", - "type": "Type", - "tags": [], - "label": "DataType", - "description": [], - "signature": [ - "{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DEFAULT_DOWNLOAD_SOURCE_ID", - "type": "string", - "tags": [], - "label": "DEFAULT_DOWNLOAD_SOURCE_ID", - "description": [], - "signature": [ - "\"fleet-default-download-source\"" - ], - "path": "x-pack/plugins/fleet/common/constants/download_source.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DEFAULT_DOWNLOAD_SOURCE_URI", - "type": "string", - "tags": [], - "label": "DEFAULT_DOWNLOAD_SOURCE_URI", - "description": [], - "signature": [ - "\"https://artifacts.elastic.co/downloads/beats/elastic-agent\"" - ], - "path": "x-pack/plugins/fleet/common/constants/download_source.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DEFAULT_OUTPUT_ID", - "type": "string", - "tags": [], - "label": "DEFAULT_OUTPUT_ID", - "description": [], - "signature": [ - "\"fleet-default-output\"" - ], - "path": "x-pack/plugins/fleet/common/constants/output.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DeletePackagePoliciesResponse", - "type": "Type", - "tags": [], - "label": "DeletePackagePoliciesResponse", - "description": [], - "signature": [ - "{ id: string; name?: string | undefined; success: boolean; package?: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyPackage", - "text": "PackagePolicyPackage" - }, - " | undefined; policy_id?: string | undefined; }[]" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DetailViewPanelName", - "type": "Type", - "tags": [], - "label": "DetailViewPanelName", - "description": [], - "signature": [ - "\"custom\" | \"overview\" | \"settings\" | \"policies\" | \"assets\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DocAssetType", - "type": "Type", - "tags": [], - "label": "DocAssetType", - "description": [], - "signature": [ - "\"notice\" | \"doc\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DOWNLOAD_SOURCE_API_ROOT", - "type": "string", - "tags": [], - "label": "DOWNLOAD_SOURCE_API_ROOT", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DOWNLOAD_SOURCE_SAVED_OBJECT_TYPE", - "type": "string", - "tags": [], - "label": "DOWNLOAD_SOURCE_SAVED_OBJECT_TYPE", - "description": [], - "signature": [ - "\"ingest-download-sources\"" - ], - "path": "x-pack/plugins/fleet/common/constants/download_source.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DownloadSource", - "type": "Type", - "tags": [], - "label": "DownloadSource", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.DownloadSourceBase", - "text": "DownloadSourceBase" - }, - " & { id: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/download_sources.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DownloadSourceAttributes", - "type": "Type", - "tags": [], - "label": "DownloadSourceAttributes", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.DownloadSourceBase", - "text": "DownloadSourceBase" - }, - " & { source_id?: string | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/download_sources.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DryRunPackagePolicy", - "type": "Type", - "tags": [], - "label": "DryRunPackagePolicy", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicy", - "text": "NewPackagePolicy" - }, - " & { errors?: { key: string | undefined; message: string; }[] | undefined; missingVars?: string[] | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ElasticsearchAssetParts", - "type": "Type", - "tags": [], - "label": "ElasticsearchAssetParts", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AssetParts", - "text": "AssetParts" - }, - " & { service: \"elasticsearch\"; type: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetType", - "text": "ElasticsearchAssetType" - }, - "; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ElasticsearchAssetTypeToParts", - "type": "Type", - "tags": [], - "label": "ElasticsearchAssetTypeToParts", - "description": [], - "signature": [ - "{ component_template: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetParts", - "text": "ElasticsearchAssetParts" - }, - "[]; ingest_pipeline: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetParts", - "text": "ElasticsearchAssetParts" - }, - "[]; index_template: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetParts", - "text": "ElasticsearchAssetParts" - }, - "[]; ilm_policy: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetParts", - "text": "ElasticsearchAssetParts" - }, - "[]; transform: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetParts", - "text": "ElasticsearchAssetParts" - }, - "[]; data_stream_ilm_policy: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetParts", - "text": "ElasticsearchAssetParts" - }, - "[]; ml_model: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetParts", - "text": "ElasticsearchAssetParts" - }, - "[]; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ENROLLMENT_API_KEYS_INDEX", - "type": "string", - "tags": [], - "label": "ENROLLMENT_API_KEYS_INDEX", - "description": [], - "signature": [ - "\".fleet-enrollment-api-keys\"" - ], - "path": "x-pack/plugins/fleet/common/constants/enrollment_api_key.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EnrollmentAPIKeySOAttributes", - "type": "Type", - "tags": [], - "label": "EnrollmentAPIKeySOAttributes", - "description": [], - "signature": [ - "{ name?: string | undefined; active: boolean; created_at: string; policy_id?: string | undefined; api_key_id: string; api_key: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROOT", - "type": "string", - "tags": [], - "label": "EPM_API_ROOT", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EpmPackageInstallStatus", - "type": "Type", - "tags": [], - "label": "EpmPackageInstallStatus", - "description": [], - "signature": [ - "\"installed\" | \"installing\" | \"install_failed\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EsAssetReference", - "type": "Type", - "tags": [], - "label": "EsAssetReference", - "description": [], - "signature": [ - "Pick<", - "SavedObjectReference", - ", \"id\"> & { type: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ElasticsearchAssetType", - "text": "ElasticsearchAssetType" - }, - "; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ExperimentalFeatures", - "type": "Type", - "tags": [], - "label": "ExperimentalFeatures", - "description": [], - "signature": [ - "{ readonly createPackagePolicyMultiPageLayout: boolean; readonly packageVerification: boolean; }" - ], - "path": "x-pack/plugins/fleet/common/experimental_features.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_APM_PACKAGE", - "type": "string", - "tags": [], - "label": "FLEET_APM_PACKAGE", - "description": [], - "signature": [ - "\"apm\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_CLOUD_SECURITY_POSTURE_PACKAGE", - "type": "string", - "tags": [], - "label": "FLEET_CLOUD_SECURITY_POSTURE_PACKAGE", - "description": [], - "signature": [ - "\"cloud_security_posture\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_ELASTIC_AGENT_DETAILS_DASHBOARD_ID", - "type": "string", - "tags": [], - "label": "FLEET_ELASTIC_AGENT_DETAILS_DASHBOARD_ID", - "description": [], - "signature": [ - "\"elastic_agent-f47f18cc-9c7d-4278-b2ea-a6dee816d395\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_ELASTIC_AGENT_PACKAGE", - "type": "string", - "tags": [], - "label": "FLEET_ELASTIC_AGENT_PACKAGE", - "description": [], - "signature": [ - "\"elastic_agent\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_ENDPOINT_PACKAGE", - "type": "string", - "tags": [], - "label": "FLEET_ENDPOINT_PACKAGE", - "description": [], - "signature": [ - "\"endpoint\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_KUBERNETES_PACKAGE", - "type": "string", - "tags": [], - "label": "FLEET_KUBERNETES_PACKAGE", - "description": [], - "signature": [ - "\"kubernetes\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_PACKAGES", - "type": "Array", - "tags": [], - "label": "FLEET_PACKAGES", - "description": [], - "signature": [ - "{ name: string; version: string; }[]" - ], - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_SERVER_ARTIFACTS_INDEX", - "type": "string", - "tags": [], - "label": "FLEET_SERVER_ARTIFACTS_INDEX", - "description": [], - "signature": [ - "\".fleet-artifacts\"" - ], - "path": "x-pack/plugins/fleet/common/constants/index.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_SERVER_INDICES", - "type": "Array", - "tags": [], - "label": "FLEET_SERVER_INDICES", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/fleet/common/constants/index.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_SERVER_INDICES_VERSION", - "type": "number", - "tags": [], - "label": "FLEET_SERVER_INDICES_VERSION", - "description": [], - "signature": [ - "1" - ], - "path": "x-pack/plugins/fleet/common/constants/index.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_SERVER_PACKAGE", - "type": "string", - "tags": [], - "label": "FLEET_SERVER_PACKAGE", - "description": [], - "signature": [ - "\"fleet_server\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_SERVER_SERVERS_INDEX", - "type": "string", - "tags": [], - "label": "FLEET_SERVER_SERVERS_INDEX", - "description": [], - "signature": [ - "\".fleet-servers\"" - ], - "path": "x-pack/plugins/fleet/common/constants/index.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_SYNTHETICS_PACKAGE", - "type": "string", - "tags": [], - "label": "FLEET_SYNTHETICS_PACKAGE", - "description": [], - "signature": [ - "\"synthetics\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FLEET_SYSTEM_PACKAGE", - "type": "string", - "tags": [], - "label": "FLEET_SYSTEM_PACKAGE", - "description": [], - "signature": [ - "\"system\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FleetErrorType", - "type": "Type", - "tags": [], - "label": "FleetErrorType", - "description": [], - "signature": [ - "\"verification_failed\"" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/error.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.FullAgentPolicyOutput", - "type": "Type", - "tags": [], - "label": "FullAgentPolicyOutput", - "description": [], - "signature": [ - "Pick<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Output", - "text": "Output" - }, - ", \"type\" | \"hosts\" | \"ca_sha256\"> & { [key: string]: any; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetAgentPoliciesResponse", - "type": "Type", - "tags": [], - "label": "GetAgentPoliciesResponse", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ListResult", - "text": "ListResult" - }, - "<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.GetAgentPoliciesResponseItem", - "text": "GetAgentPoliciesResponseItem" - }, - ">" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetAgentPoliciesResponseItem", - "type": "Type", - "tags": [], - "label": "GetAgentPoliciesResponseItem", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AgentPolicy", - "text": "AgentPolicy" - }, - " & { agents?: number | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetDownloadSourceResponse", - "type": "Type", - "tags": [], - "label": "GetDownloadSourceResponse", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ListResult", - "text": "ListResult" - }, - "<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.DownloadSource", - "text": "DownloadSource" - }, - ">" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/download_sources.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetEnrollmentAPIKeysResponse", - "type": "Type", - "tags": [], - "label": "GetEnrollmentAPIKeysResponse", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ListResult", - "text": "ListResult" - }, - "<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.EnrollmentAPIKey", - "text": "EnrollmentAPIKey" - }, - "> & { list?: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.EnrollmentAPIKey", - "text": "EnrollmentAPIKey" - }, - "[] | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetOutputsResponse", - "type": "Type", - "tags": [], - "label": "GetOutputsResponse", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ListResult", - "text": "ListResult" - }, - "<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Output", - "text": "Output" - }, - ">" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/output.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GetPackagePoliciesResponse", - "type": "Type", - "tags": [], - "label": "GetPackagePoliciesResponse", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ListResult", - "text": "ListResult" - }, - "<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicy", - "text": "PackagePolicy" - }, - ">" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GLOBAL_SETTINGS_ID", - "type": "string", - "tags": [], - "label": "GLOBAL_SETTINGS_ID", - "description": [], - "signature": [ - "\"fleet-default-settings\"" - ], - "path": "x-pack/plugins/fleet/common/constants/settings.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.GLOBAL_SETTINGS_SAVED_OBJECT_TYPE", - "type": "string", - "tags": [], - "label": "GLOBAL_SETTINGS_SAVED_OBJECT_TYPE", - "description": [], - "signature": [ - "\"ingest_manager_settings\"" - ], - "path": "x-pack/plugins/fleet/common/constants/settings.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InputsOverride", - "type": "Type", - "tags": [], - "label": "InputsOverride", - "description": [], - "signature": [ - "Partial<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewPackagePolicyInput", - "text": "NewPackagePolicyInput" - }, - "> & { vars?: (", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigRecord", - "text": "PackagePolicyConfigRecord" - }, - " & { name: string; })[] | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.INSTALL_SCRIPT_API_ROUTES", - "type": "string", - "tags": [], - "label": "INSTALL_SCRIPT_API_ROUTES", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.Installable", - "type": "Type", - "tags": [], - "label": "Installable", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.InstallStatusExcluded", - "text": "InstallStatusExcluded" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.InstalledRegistry", - "text": "InstalledRegistry" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Installing", - "text": "Installing" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NotInstalled", - "text": "NotInstalled" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.InstallFailed", - "text": "InstallFailed" - }, - "" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstallablePackage", - "type": "Type", - "tags": [], - "label": "InstallablePackage", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryPackage", - "text": "RegistryPackage" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.ArchivePackage", - "text": "ArchivePackage" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstallationStatus", - "type": "Type", - "tags": [], - "label": "InstallationStatus", - "description": [], - "signature": [ - "{ readonly Installed: \"installed\"; readonly Installing: \"installing\"; readonly InstallFailed: \"install_failed\"; readonly NotInstalled: \"not_installed\"; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstalledRegistry", - "type": "Type", - "tags": [], - "label": "InstalledRegistry", - "description": [], - "signature": [ - "T & { status: \"installed\"; savedObject: ", - "SavedObject", - "<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Installation", - "text": "Installation" - }, - ">; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstallFailed", - "type": "Type", - "tags": [], - "label": "InstallFailed", - "description": [], - "signature": [ - "T & { status: \"install_failed\"; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.Installing", - "type": "Type", - "tags": [], - "label": "Installing", - "description": [], - "signature": [ - "T & { status: \"installing\"; savedObject: ", - "SavedObject", - "<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Installation", - "text": "Installation" - }, - ">; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstallSource", - "type": "Type", - "tags": [], - "label": "InstallSource", - "description": [], - "signature": [ - "\"registry\" | \"upload\" | \"bundled\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstallStatusExcluded", - "type": "Type", - "tags": [], - "label": "InstallStatusExcluded", - "description": [], - "signature": [ - "T & { status: undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.InstallType", - "type": "Type", - "tags": [], - "label": "InstallType", - "description": [], - "signature": [ - "\"update\" | \"unknown\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.INTEGRATIONS_PLUGIN_ID", - "type": "string", - "tags": [], - "label": "INTEGRATIONS_PLUGIN_ID", - "description": [], - "signature": [ - "\"integrations\"" - ], - "path": "x-pack/plugins/fleet/common/constants/plugin.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.INTERNAL_ROOT", - "type": "string", - "tags": [], - "label": "INTERNAL_ROOT", - "description": [], - "signature": [ - "\"/internal/fleet\"" - ], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.K8S_API_ROOT", - "type": "string", - "tags": [], - "label": "K8S_API_ROOT", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.KEEP_POLICIES_UP_TO_DATE_PACKAGES", - "type": "Array", - "tags": [], - "label": "KEEP_POLICIES_UP_TO_DATE_PACKAGES", - "description": [], - "signature": [ - "{ name: string; version: string; }[]" - ], - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.KibanaAssetParts", - "type": "Type", - "tags": [], - "label": "KibanaAssetParts", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.AssetParts", - "text": "AssetParts" - }, - " & { service: \"kibana\"; type: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetType", - "text": "KibanaAssetType" - }, - "; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.KibanaAssetReference", - "type": "Type", - "tags": [], - "label": "KibanaAssetReference", - "description": [], - "signature": [ - "Pick<", - "SavedObjectReference", - ", \"id\"> & { type: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaSavedObjectType", - "text": "KibanaSavedObjectType" - }, - "; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.KibanaAssetTypeToParts", - "type": "Type", - "tags": [], - "label": "KibanaAssetTypeToParts", - "description": [], - "signature": [ - "{ dashboard: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetParts", - "text": "KibanaAssetParts" - }, - "[]; visualization: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetParts", - "text": "KibanaAssetParts" - }, - "[]; search: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetParts", - "text": "KibanaAssetParts" - }, - "[]; index_pattern: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetParts", - "text": "KibanaAssetParts" - }, - "[]; map: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetParts", - "text": "KibanaAssetParts" - }, - "[]; lens: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetParts", - "text": "KibanaAssetParts" - }, - "[]; security_rule: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetParts", - "text": "KibanaAssetParts" - }, - "[]; csp_rule_template: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetParts", - "text": "KibanaAssetParts" - }, - "[]; ml_module: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetParts", - "text": "KibanaAssetParts" - }, - "[]; tag: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetParts", - "text": "KibanaAssetParts" - }, - "[]; osquery_pack_asset: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetParts", - "text": "KibanaAssetParts" - }, - "[]; osquery_saved_query: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.KibanaAssetParts", - "text": "KibanaAssetParts" - }, - "[]; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.LICENCE_FOR_PER_POLICY_OUTPUT", - "type": "string", - "tags": [], - "label": "LICENCE_FOR_PER_POLICY_OUTPUT", - "description": [], - "signature": [ - "\"platinum\"" - ], - "path": "x-pack/plugins/fleet/common/constants/output.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.LICENSE_FOR_SCHEDULE_UPGRADE", - "type": "string", - "tags": [], - "label": "LICENSE_FOR_SCHEDULE_UPGRADE", - "description": [], - "signature": [ - "\"platinum\"" - ], - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.LIMITED_CONCURRENCY_ROUTE_TAG", - "type": "string", - "tags": [], - "label": "LIMITED_CONCURRENCY_ROUTE_TAG", - "description": [], - "signature": [ - "\"ingest:limited-concurrency\"" - ], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.MAX_TIME_COMPLETE_INSTALL", - "type": "number", - "tags": [], - "label": "MAX_TIME_COMPLETE_INSTALL", - "description": [], - "signature": [ - "60000" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.MonitoringType", - "type": "Type", - "tags": [], - "label": "MonitoringType", - "description": [], - "signature": [ - "(\"metrics\" | \"logs\")[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.monitoringTypes", - "type": "Array", - "tags": [], - "label": "monitoringTypes", - "description": [], - "signature": [ - "(\"metrics\" | \"logs\")[]" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.NotInstalled", - "type": "Type", - "tags": [], - "label": "NotInstalled", - "description": [], - "signature": [ - "T & { status: \"not_installed\"; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.Output", - "type": "Type", - "tags": [], - "label": "Output", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewOutput", - "text": "NewOutput" - }, - " & { id: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.OUTPUT_SAVED_OBJECT_TYPE", - "type": "string", - "tags": [], - "label": "OUTPUT_SAVED_OBJECT_TYPE", - "description": [], - "signature": [ - "\"ingest-outputs\"" - ], - "path": "x-pack/plugins/fleet/common/constants/output.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.OutputSOAttributes", - "type": "Type", - "tags": [], - "label": "OutputSOAttributes", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewOutput", - "text": "NewOutput" - }, - " & { output_id?: string | undefined; ssl?: string | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.OutputType", - "type": "Type", - "tags": [], - "label": "OutputType", - "description": [], - "signature": [ - "{ readonly Elasticsearch: \"elasticsearch\"; readonly Logstash: \"logstash\"; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/output.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PACKAGE_POLICY_API_ROOT", - "type": "string", - "tags": [], - "label": "PACKAGE_POLICY_API_ROOT", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PACKAGE_POLICY_DEFAULT_INDEX_PRIVILEGES", - "type": "Array", - "tags": [], - "label": "PACKAGE_POLICY_DEFAULT_INDEX_PRIVILEGES", - "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/fleet/common/constants/package_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PACKAGE_POLICY_SAVED_OBJECT_TYPE", - "type": "string", - "tags": [], - "label": "PACKAGE_POLICY_SAVED_OBJECT_TYPE", - "description": [], - "signature": [ - "\"ingest-package-policies\"" - ], - "path": "x-pack/plugins/fleet/common/constants/package_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PACKAGE_TEMPLATE_SUFFIX", - "type": "string", - "tags": [], - "label": "PACKAGE_TEMPLATE_SUFFIX", - "description": [], - "signature": [ - "\"@package\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageAssetReference", - "type": "Type", - "tags": [], - "label": "PackageAssetReference", - "description": [], - "signature": [ - "Pick<", - "SavedObjectReference", - ", \"id\"> & { type: \"epm-packages-assets\"; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageInfo", - "type": "Type", - "tags": [], - "label": "PackageInfo", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Installable", - "text": "Installable" - }, - "> | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Installable", - "text": "Installable" - }, - ">" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageList", - "type": "Type", - "tags": [], - "label": "PackageList", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageListItem", - "text": "PackageListItem" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageListItem", - "type": "Type", - "tags": [], - "label": "PackageListItem", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.Installable", - "text": "Installable" - }, - "<", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistrySearchResult", - "text": "RegistrySearchResult" - }, - "> & { integration?: string | undefined; id: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyConfigRecord", - "type": "Type", - "tags": [], - "label": "PackagePolicyConfigRecord", - "description": [], - "signature": [ - "{ [x: string]: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigRecordEntry", - "text": "PackagePolicyConfigRecordEntry" - }, - "; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyInputValidationResults", - "type": "Type", - "tags": [], - "label": "PackagePolicyInputValidationResults", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigValidationResults", - "text": "PackagePolicyConfigValidationResults" - }, - " & { streams?: Record | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicySOAttributes", - "type": "Type", - "tags": [], - "label": "PackagePolicySOAttributes", - "description": [], - "signature": [ - "{ name: string; namespace: string; package?: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyPackage", - "text": "PackagePolicyPackage" - }, - " | undefined; description?: string | undefined; enabled: boolean; updated_at: string; created_at: string; created_by: string; updated_by: string; vars?: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigRecord", - "text": "PackagePolicyConfigRecord" - }, - " | undefined; elasticsearch?: { privileges?: { cluster?: string[] | undefined; } | undefined; } | undefined; inputs: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyInput", - "text": "PackagePolicyInput" - }, - "[]; is_managed?: boolean | undefined; policy_id: string; output_id: string; revision: number; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagePolicyValidationResults", - "type": "Type", - "tags": [], - "label": "PackagePolicyValidationResults", - "description": [], - "signature": [ - "{ name: Errors; description: Errors; namespace: Errors; inputs: Record | null; } & ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackagePolicyConfigValidationResults", - "text": "PackagePolicyConfigValidationResults" - } - ], - "path": "x-pack/plugins/fleet/common/services/validate_package_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PACKAGES_SAVED_OBJECT_TYPE", - "type": "string", - "tags": [], - "label": "PACKAGES_SAVED_OBJECT_TYPE", - "description": [], - "signature": [ - "\"epm-packages\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackagesGroupedByStatus", - "type": "Type", - "tags": [], - "label": "PackagesGroupedByStatus", - "description": [], - "signature": [ - "{ installed: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageList", - "text": "PackageList" - }, - "; installing: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageList", - "text": "PackageList" - }, - "; install_failed: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageList", - "text": "PackageList" - }, - "; not_installed: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageList", - "text": "PackageList" - }, - "; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecCategory", - "type": "Type", - "tags": [], - "label": "PackageSpecCategory", - "description": [], - "signature": [ - "\"custom\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"monitoring\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"security\" | \"support\" | \"threat_intel\" | \"ticketing\" | \"version_control\" | \"web\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageSpecConditions", - "type": "Type", - "tags": [], - "label": "PackageSpecConditions", - "description": [], - "signature": [ - "{ kibana: { version: string; }; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/package_spec.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PackageVerificationStatus", - "type": "Type", - "tags": [], - "label": "PackageVerificationStatus", - "description": [], - "signature": [ - "\"unknown\" | \"verified\" | \"unverified\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PLUGIN_ID", - "type": "string", - "tags": [], - "label": "PLUGIN_ID", - "description": [], - "signature": [ - "\"fleet\"" - ], - "path": "x-pack/plugins/fleet/common/constants/plugin.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostBulkAgentReassignResponse", - "type": "Type", - "tags": [], - "label": "PostBulkAgentReassignResponse", - "description": [], - "signature": [ - "{ [x: string]: { success: boolean; error?: string | undefined; }; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostBulkAgentUnenrollResponse", - "type": "Type", - "tags": [], - "label": "PostBulkAgentUnenrollResponse", - "description": [], - "signature": [ - "{ [x: string]: { success: boolean; error?: string | undefined; }; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostBulkAgentUpgradeResponse", - "type": "Type", - "tags": [], - "label": "PostBulkAgentUpgradeResponse", - "description": [], - "signature": [ - "{ [x: string]: { success: boolean; error?: string | undefined; }; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PostBulkUpdateAgentTagsResponse", - "type": "Type", - "tags": [], - "label": "PostBulkUpdateAgentTagsResponse", - "description": [], - "signature": [ - "{ [x: string]: { success: boolean; error?: string | undefined; }; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PRECONFIGURATION_DELETION_RECORD_SAVED_OBJECT_TYPE", - "type": "string", - "tags": [], - "label": "PRECONFIGURATION_DELETION_RECORD_SAVED_OBJECT_TYPE", - "description": [], - "signature": [ - "\"fleet-preconfiguration-deletion-record\"" - ], - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PRECONFIGURATION_LATEST_KEYWORD", - "type": "string", - "tags": [], - "label": "PRECONFIGURATION_LATEST_KEYWORD", - "description": [], - "signature": [ - "\"latest\"" - ], - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PreconfiguredPackage", - "type": "Type", - "tags": [], - "label": "PreconfiguredPackage", - "description": [], - "signature": [ - "{ name: string; version: string; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/preconfiguration.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryInputGroup", - "type": "Type", - "tags": [], - "label": "RegistryInputGroup", - "description": [], - "signature": [ - "\"metrics\" | \"logs\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryPackage", - "type": "Type", - "tags": [], - "label": "RegistryPackage", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecManifest", - "text": "PackageSpecManifest" - }, - " & Partial & RegistryAdditionalProperties & RegistryOverridePropertyValue" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryRelease", - "type": "Type", - "tags": [], - "label": "RegistryRelease", - "description": [], - "signature": [ - "\"experimental\" | \"beta\" | \"ga\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistrySearchResult", - "type": "Type", - "tags": [], - "label": "RegistrySearchResult", - "description": [], - "signature": [ - "{ type?: \"integration\" | undefined; name: string; path: string; version: string; title: string; download: string; description: string; icons?: (", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecIcon", - "text": "PackageSpecIcon" - }, - "[] & ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryImage", - "text": "RegistryImage" - }, - "[]) | undefined; categories?: (", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecCategory", - "text": "PackageSpecCategory" - }, - " | undefined)[] | undefined; internal?: boolean | undefined; data_streams?: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryDataStream", - "text": "RegistryDataStream" - }, - "[] | undefined; release?: \"experimental\" | \"beta\" | \"ga\" | undefined; policy_templates?: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryPolicyTemplate", - "text": "RegistryPolicyTemplate" - }, - "[] | undefined; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistrySearchResults", - "type": "Type", - "tags": [], - "label": "RegistrySearchResults", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistrySearchResult", - "text": "RegistrySearchResult" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RegistryVarType", - "type": "Type", - "tags": [], - "label": "RegistryVarType", - "description": [], - "signature": [ - "\"string\" | \"text\" | \"yaml\" | \"textarea\" | \"password\" | \"integer\" | \"bool\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RequirementsByServiceName", - "type": "Type", - "tags": [], - "label": "RequirementsByServiceName", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecConditions", - "text": "PackageSpecConditions" - }, - " | undefined" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RequirementVersion", - "type": "Type", - "tags": [], - "label": "RequirementVersion", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.RequirementVersionRange", - "type": "Type", - "tags": [], - "label": "RequirementVersionRange", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ScreenshotItem", - "type": "Type", - "tags": [], - "label": "ScreenshotItem", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.RegistryImage", - "text": "RegistryImage" - }, - " | ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.PackageSpecScreenshot", - "text": "PackageSpecScreenshot" - } - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ServiceName", - "type": "Type", - "tags": [], - "label": "ServiceName", - "description": [], - "signature": [ - "\"kibana\" | \"elasticsearch\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.SETUP_API_ROUTE", - "type": "string", - "tags": [], - "label": "SETUP_API_ROUTE", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.SimplifiedAgentStatus", - "type": "Type", - "tags": [], - "label": "SimplifiedAgentStatus", - "description": [], - "signature": [ - "\"offline\" | \"inactive\" | \"updating\" | \"healthy\" | \"unhealthy\"" - ], - "path": "x-pack/plugins/fleet/common/types/models/agent.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.SO_SEARCH_LIMIT", - "type": "number", - "tags": [], - "label": "SO_SEARCH_LIMIT", - "description": [], - "signature": [ - "10000" - ], - "path": "x-pack/plugins/fleet/common/constants/index.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.TemplateMap", - "type": "Type", - "tags": [], - "label": "TemplateMap", - "description": [], - "signature": [ - "{ [x: string]: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.TemplateMapEntry", - "text": "TemplateMapEntry" - }, - "; }" - ], - "path": "x-pack/plugins/fleet/common/types/models/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpdateAgentPolicyRequest", - "type": "Type", - "tags": [], - "label": "UpdateAgentPolicyRequest", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.GetOneAgentPolicyRequest", - "text": "GetOneAgentPolicyRequest" - }, - " & { body: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.NewAgentPolicy", - "text": "NewAgentPolicy" - }, - "; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpdatePackagePolicyRequest", - "type": "Type", - "tags": [], - "label": "UpdatePackagePolicyRequest", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.GetOnePackagePolicyRequest", - "text": "GetOnePackagePolicyRequest" - }, - " & { body: ", - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.UpdatePackagePolicy", - "text": "UpdatePackagePolicy" - }, - "; }" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpdatePackagePolicyResponse", - "type": "Type", - "tags": [], - "label": "UpdatePackagePolicyResponse", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.CreatePackagePolicyResponse", - "text": "CreatePackagePolicyResponse" - } - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpgradePackagePolicyDryRunResponse", - "type": "Type", - "tags": [], - "label": "UpgradePackagePolicyDryRunResponse", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.UpgradePackagePolicyDryRunResponseItem", - "text": "UpgradePackagePolicyDryRunResponseItem" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UpgradePackagePolicyResponse", - "type": "Type", - "tags": [], - "label": "UpgradePackagePolicyResponse", - "description": [], - "signature": [ - { - "pluginId": "fleet", - "scope": "common", - "docId": "kibFleetPluginApi", - "section": "def-common.UpgradePackagePolicyResponseItem", - "text": "UpgradePackagePolicyResponseItem" - }, - "[]" - ], - "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.USER_SETTINGS_TEMPLATE_SUFFIX", - "type": "string", - "tags": [], - "label": "USER_SETTINGS_TEMPLATE_SUFFIX", - "description": [], - "signature": [ - "\"@custom\"" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.UUID_V5_NAMESPACE", - "type": "string", - "tags": [], - "label": "UUID_V5_NAMESPACE", - "description": [], - "signature": [ - "\"dde7c2de-1370-4c19-9975-b473d0e03508\"" - ], - "path": "x-pack/plugins/fleet/common/constants/preconfiguration.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ValueOf", - "type": "Type", - "tags": [], - "label": "ValueOf", - "description": [ - "\nCreates a Union Type for all the values of an object" - ], - "signature": [ - "T[keyof T]" - ], - "path": "x-pack/plugins/fleet/common/types/index.ts", - "deprecated": false, - "initialIsOpen": false - } - ], - "objects": [ - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES", - "type": "Object", - "tags": [], - "label": "AGENT_API_ROUTES", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.LIST_PATTERN", - "type": "string", - "tags": [], - "label": "LIST_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.INFO_PATTERN", - "type": "string", - "tags": [], - "label": "INFO_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.UPDATE_PATTERN", - "type": "string", - "tags": [], - "label": "UPDATE_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.BULK_UPDATE_AGENT_TAGS_PATTERN", - "type": "string", - "tags": [], - "label": "BULK_UPDATE_AGENT_TAGS_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.DELETE_PATTERN", - "type": "string", - "tags": [], - "label": "DELETE_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.CHECKIN_PATTERN", - "type": "string", - "tags": [], - "label": "CHECKIN_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.ACKS_PATTERN", - "type": "string", - "tags": [], - "label": "ACKS_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.ACTIONS_PATTERN", - "type": "string", - "tags": [], - "label": "ACTIONS_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.CANCEL_ACTIONS_PATTERN", - "type": "string", - "tags": [], - "label": "CANCEL_ACTIONS_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.UNENROLL_PATTERN", - "type": "string", - "tags": [], - "label": "UNENROLL_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.BULK_UNENROLL_PATTERN", - "type": "string", - "tags": [], - "label": "BULK_UNENROLL_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.REASSIGN_PATTERN", - "type": "string", - "tags": [], - "label": "REASSIGN_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.BULK_REASSIGN_PATTERN", - "type": "string", - "tags": [], - "label": "BULK_REASSIGN_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.STATUS_PATTERN", - "type": "string", - "tags": [], - "label": "STATUS_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.DATA_PATTERN", - "type": "string", - "tags": [], - "label": "DATA_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.STATUS_PATTERN_DEPRECATED", - "type": "string", - "tags": [], - "label": "STATUS_PATTERN_DEPRECATED", - "description": [ - "// deprecated since 8.0" - ], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.UPGRADE_PATTERN", - "type": "string", - "tags": [], - "label": "UPGRADE_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.BULK_UPGRADE_PATTERN", - "type": "string", - "tags": [], - "label": "BULK_UPGRADE_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.CURRENT_UPGRADES_PATTERN", - "type": "string", - "tags": [], - "label": "CURRENT_UPGRADES_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_API_ROUTES.LIST_TAGS_PATTERN", - "type": "string", - "tags": [], - "label": "LIST_TAGS_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_API_ROUTES", - "type": "Object", - "tags": [], - "label": "AGENT_POLICY_API_ROUTES", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_API_ROUTES.LIST_PATTERN", - "type": "string", - "tags": [], - "label": "LIST_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_API_ROUTES.INFO_PATTERN", - "type": "string", - "tags": [], - "label": "INFO_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_API_ROUTES.CREATE_PATTERN", - "type": "string", - "tags": [], - "label": "CREATE_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_API_ROUTES.UPDATE_PATTERN", - "type": "string", - "tags": [], - "label": "UPDATE_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_API_ROUTES.COPY_PATTERN", - "type": "string", - "tags": [], - "label": "COPY_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_API_ROUTES.DELETE_PATTERN", - "type": "string", - "tags": [], - "label": "DELETE_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_PATTERN", - "type": "string", - "tags": [], - "label": "FULL_INFO_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_DOWNLOAD_PATTERN", - "type": "string", - "tags": [], - "label": "FULL_INFO_DOWNLOAD_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentAssetTypes", - "type": "Object", - "tags": [], - "label": "agentAssetTypes", - "description": [], - "signature": [ - "{ readonly Input: \"input\"; }" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService", - "type": "Object", - "tags": [], - "label": "agentPolicyRouteService", - "description": [], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getListPath", - "type": "Function", - "tags": [], - "label": "getListPath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getInfoPath", - "type": "Function", - "tags": [], - "label": "getInfoPath", - "description": [], - "signature": [ - "(agentPolicyId: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getInfoPath.$1", - "type": "string", - "tags": [], - "label": "agentPolicyId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getCreatePath", - "type": "Function", - "tags": [], - "label": "getCreatePath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getUpdatePath", - "type": "Function", - "tags": [], - "label": "getUpdatePath", - "description": [], - "signature": [ - "(agentPolicyId: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getUpdatePath.$1", - "type": "string", - "tags": [], - "label": "agentPolicyId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getCopyPath", - "type": "Function", - "tags": [], - "label": "getCopyPath", - "description": [], - "signature": [ - "(agentPolicyId: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getCopyPath.$1", - "type": "string", - "tags": [], - "label": "agentPolicyId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getDeletePath", - "type": "Function", - "tags": [], - "label": "getDeletePath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getInfoFullPath", - "type": "Function", - "tags": [], - "label": "getInfoFullPath", - "description": [], - "signature": [ - "(agentPolicyId: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getInfoFullPath.$1", - "type": "string", - "tags": [], - "label": "agentPolicyId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getInfoFullDownloadPath", - "type": "Function", - "tags": [], - "label": "getInfoFullDownloadPath", - "description": [], - "signature": [ - "(agentPolicyId: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getInfoFullDownloadPath.$1", - "type": "string", - "tags": [], - "label": "agentPolicyId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getK8sInfoPath", - "type": "Function", - "tags": [], - "label": "getK8sInfoPath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getK8sFullDownloadPath", - "type": "Function", - "tags": [], - "label": "getK8sFullDownloadPath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getResetOnePreconfiguredAgentPolicyPath", - "type": "Function", - "tags": [], - "label": "getResetOnePreconfiguredAgentPolicyPath", - "description": [], - "signature": [ - "(agentPolicyId: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getResetOnePreconfiguredAgentPolicyPath.$1", - "type": "string", - "tags": [], - "label": "agentPolicyId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyRouteService.getResetAllPreconfiguredAgentPolicyPath", - "type": "Function", - "tags": [], - "label": "getResetAllPreconfiguredAgentPolicyPath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentPolicyStatuses", - "type": "Object", - "tags": [], - "label": "agentPolicyStatuses", - "description": [], - "signature": [ - "{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }" - ], - "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService", - "type": "Object", - "tags": [], - "label": "agentRouteService", - "description": [], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getInfoPath", - "type": "Function", - "tags": [], - "label": "getInfoPath", - "description": [], - "signature": [ - "(agentId: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getInfoPath.$1", - "type": "string", - "tags": [], - "label": "agentId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getUpdatePath", - "type": "Function", - "tags": [], - "label": "getUpdatePath", - "description": [], - "signature": [ - "(agentId: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getUpdatePath.$1", - "type": "string", - "tags": [], - "label": "agentId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getBulkUpdateTagsPath", - "type": "Function", - "tags": [], - "label": "getBulkUpdateTagsPath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getUnenrollPath", - "type": "Function", - "tags": [], - "label": "getUnenrollPath", - "description": [], - "signature": [ - "(agentId: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getUnenrollPath.$1", - "type": "string", - "tags": [], - "label": "agentId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getBulkUnenrollPath", - "type": "Function", - "tags": [], - "label": "getBulkUnenrollPath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getReassignPath", - "type": "Function", - "tags": [], - "label": "getReassignPath", - "description": [], - "signature": [ - "(agentId: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getReassignPath.$1", - "type": "string", - "tags": [], - "label": "agentId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getBulkReassignPath", - "type": "Function", - "tags": [], - "label": "getBulkReassignPath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getUpgradePath", - "type": "Function", - "tags": [], - "label": "getUpgradePath", - "description": [], - "signature": [ - "(agentId: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getUpgradePath.$1", - "type": "string", - "tags": [], - "label": "agentId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getBulkUpgradePath", - "type": "Function", - "tags": [], - "label": "getBulkUpgradePath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getCurrentUpgradesPath", - "type": "Function", - "tags": [], - "label": "getCurrentUpgradesPath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getCancelActionPath", - "type": "Function", - "tags": [], - "label": "getCancelActionPath", - "description": [], - "signature": [ - "(actionId: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getCancelActionPath.$1", - "type": "string", - "tags": [], - "label": "actionId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getListPath", - "type": "Function", - "tags": [], - "label": "getListPath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getStatusPath", - "type": "Function", - "tags": [], - "label": "getStatusPath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getIncomingDataPath", - "type": "Function", - "tags": [], - "label": "getIncomingDataPath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getCreateActionPath", - "type": "Function", - "tags": [], - "label": "getCreateActionPath", - "description": [], - "signature": [ - "(agentId: string) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getCreateActionPath.$1", - "type": "string", - "tags": [], - "label": "agentId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [] - }, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.UpdatePackagePolicyResponse", + "type": "Type", + "tags": [], + "label": "UpdatePackagePolicyResponse", + "description": [], + "signature": [ { - "parentPluginId": "fleet", - "id": "def-common.agentRouteService.getListTagsPath", - "type": "Function", - "tags": [], - "label": "getListTagsPath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.CreatePackagePolicyResponse", + "text": "CreatePackagePolicyResponse" } ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "deprecated": false, "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.AGENTS_SETUP_API_ROUTES", + "id": "def-common.UpgradePackagePolicyResponse", + "type": "Type", + "tags": [], + "label": "UpgradePackagePolicyResponse", + "description": [], + "signature": [ + { + "pluginId": "fleet", + "scope": "common", + "docId": "kibFleetPluginApi", + "section": "def-common.UpgradePackagePolicyResponseItem", + "text": "UpgradePackagePolicyResponseItem" + }, + "[]" + ], + "path": "x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "fleet", + "id": "def-common.AGENT_API_ROUTES", "type": "Object", "tags": [], - "label": "AGENTS_SETUP_API_ROUTES", + "label": "AGENT_API_ROUTES", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.AGENTS_SETUP_API_ROUTES.INFO_PATTERN", + "id": "def-common.AGENT_API_ROUTES.LIST_PATTERN", + "type": "string", + "tags": [], + "label": "LIST_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENT_API_ROUTES.INFO_PATTERN", "type": "string", "tags": [], "label": "INFO_PATTERN", @@ -24050,281 +14056,184 @@ }, { "parentPluginId": "fleet", - "id": "def-common.AGENTS_SETUP_API_ROUTES.CREATE_PATTERN", + "id": "def-common.AGENT_API_ROUTES.UPDATE_PATTERN", "type": "string", "tags": [], - "label": "CREATE_PATTERN", + "label": "UPDATE_PATTERN", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.allowedExperimentalValues", - "type": "Object", - "tags": [], - "label": "allowedExperimentalValues", - "description": [ - "\nA list of allowed values that can be used in `xpack.fleet.enableExperimental`.\nThis object is then used to validate and parse the value entered." - ], - "signature": [ - "{ readonly createPackagePolicyMultiPageLayout: boolean; readonly packageVerification: boolean; }" - ], - "path": "x-pack/plugins/fleet/common/experimental_features.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.APP_API_ROUTES", - "type": "Object", - "tags": [], - "label": "APP_API_ROUTES", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.APP_API_ROUTES.HEALTH_CHECK_PATTERN", + "id": "def-common.AGENT_API_ROUTES.BULK_UPDATE_AGENT_TAGS_PATTERN", "type": "string", "tags": [], - "label": "HEALTH_CHECK_PATTERN", + "label": "BULK_UPDATE_AGENT_TAGS_PATTERN", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.APP_API_ROUTES.CHECK_PERMISSIONS_PATTERN", + "id": "def-common.AGENT_API_ROUTES.DELETE_PATTERN", "type": "string", "tags": [], - "label": "CHECK_PERMISSIONS_PATTERN", + "label": "DELETE_PATTERN", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.APP_API_ROUTES.GENERATE_SERVICE_TOKEN_PATTERN", + "id": "def-common.AGENT_API_ROUTES.CHECKIN_PATTERN", "type": "string", "tags": [], - "label": "GENERATE_SERVICE_TOKEN_PATTERN", + "label": "CHECKIN_PATTERN", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.APP_API_ROUTES.GENERATE_SERVICE_TOKEN_PATTERN_DEPRECATED", + "id": "def-common.AGENT_API_ROUTES.ACKS_PATTERN", "type": "string", "tags": [], - "label": "GENERATE_SERVICE_TOKEN_PATTERN_DEPRECATED", - "description": [ - "// deprecated since 8.0" - ], + "label": "ACKS_PATTERN", + "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.appRoutesService", - "type": "Object", - "tags": [], - "label": "appRoutesService", - "description": [], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.appRoutesService.getCheckPermissionsPath", - "type": "Function", + "id": "def-common.AGENT_API_ROUTES.ACTIONS_PATTERN", + "type": "string", "tags": [], - "label": "getCheckPermissionsPath", + "label": "ACTIONS_PATTERN", "description": [], - "signature": [ - "(fleetServerSetup?: boolean | undefined) => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.appRoutesService.getCheckPermissionsPath.$1", - "type": "CompoundType", - "tags": [], - "label": "fleetServerSetup", - "description": [], - "signature": [ - "boolean | undefined" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": false - } - ], - "returnComment": [] + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.appRoutesService.getRegenerateServiceTokenPath", - "type": "Function", + "id": "def-common.AGENT_API_ROUTES.CANCEL_ACTIONS_PATTERN", + "type": "string", "tags": [], - "label": "getRegenerateServiceTokenPath", + "label": "CANCEL_ACTIONS_PATTERN", "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DATA_STREAM_API_ROUTES", - "type": "Object", - "tags": [], - "label": "DATA_STREAM_API_ROUTES", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "children": [ + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, { "parentPluginId": "fleet", - "id": "def-common.DATA_STREAM_API_ROUTES.LIST_PATTERN", + "id": "def-common.AGENT_API_ROUTES.UNENROLL_PATTERN", "type": "string", "tags": [], - "label": "LIST_PATTERN", + "label": "UNENROLL_PATTERN", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.dataStreamRouteService", - "type": "Object", - "tags": [], - "label": "dataStreamRouteService", - "description": [], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.dataStreamRouteService.getListPath", - "type": "Function", + "id": "def-common.AGENT_API_ROUTES.BULK_UNENROLL_PATTERN", + "type": "string", "tags": [], - "label": "getListPath", + "label": "BULK_UNENROLL_PATTERN", "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.dataTypes", - "type": "Object", - "tags": [], - "label": "dataTypes", - "description": [], - "signature": [ - "{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.DEFAULT_OUTPUT", - "type": "Object", - "tags": [], - "label": "DEFAULT_OUTPUT", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/output.ts", - "deprecated": false, - "children": [ + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENT_API_ROUTES.REASSIGN_PATTERN", + "type": "string", + "tags": [], + "label": "REASSIGN_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENT_API_ROUTES.BULK_REASSIGN_PATTERN", + "type": "string", + "tags": [], + "label": "BULK_REASSIGN_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, { "parentPluginId": "fleet", - "id": "def-common.DEFAULT_OUTPUT.name", + "id": "def-common.AGENT_API_ROUTES.STATUS_PATTERN", "type": "string", "tags": [], - "label": "name", + "label": "STATUS_PATTERN", "description": [], - "path": "x-pack/plugins/fleet/common/constants/output.ts", + "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DEFAULT_OUTPUT.is_default", - "type": "boolean", + "id": "def-common.AGENT_API_ROUTES.DATA_PATTERN", + "type": "string", "tags": [], - "label": "is_default", + "label": "DATA_PATTERN", "description": [], - "signature": [ - "true" + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENT_API_ROUTES.STATUS_PATTERN_DEPRECATED", + "type": "string", + "tags": [], + "label": "STATUS_PATTERN_DEPRECATED", + "description": [ + "// deprecated since 8.0" ], - "path": "x-pack/plugins/fleet/common/constants/output.ts", + "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DEFAULT_OUTPUT.is_default_monitoring", - "type": "boolean", + "id": "def-common.AGENT_API_ROUTES.UPGRADE_PATTERN", + "type": "string", "tags": [], - "label": "is_default_monitoring", + "label": "UPGRADE_PATTERN", "description": [], - "signature": [ - "true" - ], - "path": "x-pack/plugins/fleet/common/constants/output.ts", + "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DEFAULT_OUTPUT.type", + "id": "def-common.AGENT_API_ROUTES.BULK_UPGRADE_PATTERN", "type": "string", "tags": [], - "label": "type", + "label": "BULK_UPGRADE_PATTERN", "description": [], - "signature": [ - "\"elasticsearch\"" - ], - "path": "x-pack/plugins/fleet/common/constants/output.ts", + "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.DEFAULT_OUTPUT.hosts", - "type": "Array", + "id": "def-common.AGENT_API_ROUTES.CURRENT_UPGRADES_PATTERN", + "type": "string", "tags": [], - "label": "hosts", + "label": "CURRENT_UPGRADES_PATTERN", "description": [], - "signature": [ - "string[]" - ], - "path": "x-pack/plugins/fleet/common/constants/output.ts", + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENT_API_ROUTES.LIST_TAGS_PATTERN", + "type": "string", + "tags": [], + "label": "LIST_TAGS_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false } ], @@ -24332,17 +14241,17 @@ }, { "parentPluginId": "fleet", - "id": "def-common.DOWNLOAD_SOURCE_API_ROUTES", + "id": "def-common.AGENT_POLICY_API_ROUTES", "type": "Object", "tags": [], - "label": "DOWNLOAD_SOURCE_API_ROUTES", + "label": "AGENT_POLICY_API_ROUTES", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.DOWNLOAD_SOURCE_API_ROUTES.LIST_PATTERN", + "id": "def-common.AGENT_POLICY_API_ROUTES.LIST_PATTERN", "type": "string", "tags": [], "label": "LIST_PATTERN", @@ -24352,7 +14261,7 @@ }, { "parentPluginId": "fleet", - "id": "def-common.DOWNLOAD_SOURCE_API_ROUTES.INFO_PATTERN", + "id": "def-common.AGENT_POLICY_API_ROUTES.INFO_PATTERN", "type": "string", "tags": [], "label": "INFO_PATTERN", @@ -24362,7 +14271,7 @@ }, { "parentPluginId": "fleet", - "id": "def-common.DOWNLOAD_SOURCE_API_ROUTES.CREATE_PATTERN", + "id": "def-common.AGENT_POLICY_API_ROUTES.CREATE_PATTERN", "type": "string", "tags": [], "label": "CREATE_PATTERN", @@ -24372,7 +14281,7 @@ }, { "parentPluginId": "fleet", - "id": "def-common.DOWNLOAD_SOURCE_API_ROUTES.UPDATE_PATTERN", + "id": "def-common.AGENT_POLICY_API_ROUTES.UPDATE_PATTERN", "type": "string", "tags": [], "label": "UPDATE_PATTERN", @@ -24382,76 +14291,91 @@ }, { "parentPluginId": "fleet", - "id": "def-common.DOWNLOAD_SOURCE_API_ROUTES.DELETE_PATTERN", + "id": "def-common.AGENT_POLICY_API_ROUTES.COPY_PATTERN", + "type": "string", + "tags": [], + "label": "COPY_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENT_POLICY_API_ROUTES.DELETE_PATTERN", "type": "string", "tags": [], "label": "DELETE_PATTERN", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_PATTERN", + "type": "string", + "tags": [], + "label": "FULL_INFO_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_DOWNLOAD_PATTERN", + "type": "string", + "tags": [], + "label": "FULL_INFO_DOWNLOAD_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.downloadSourceRoutesService", + "id": "def-common.agentPolicyRouteService", "type": "Object", "tags": [], - "label": "downloadSourceRoutesService", + "label": "agentPolicyRouteService", "description": [], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.downloadSourceRoutesService.getInfoPath", + "id": "def-common.agentPolicyRouteService.getListPath", "type": "Function", "tags": [], - "label": "getInfoPath", + "label": "getListPath", "description": [], "signature": [ - "(downloadSourceId: string) => string" + "() => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.downloadSourceRoutesService.getInfoPath.$1", - "type": "string", - "tags": [], - "label": "downloadSourceId", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } - ], + "children": [], "returnComment": [] }, { "parentPluginId": "fleet", - "id": "def-common.downloadSourceRoutesService.getUpdatePath", + "id": "def-common.agentPolicyRouteService.getInfoPath", "type": "Function", "tags": [], - "label": "getUpdatePath", + "label": "getInfoPath", "description": [], "signature": [ - "(downloadSourceId: string) => string" + "(agentPolicyId: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.downloadSourceRoutesService.getUpdatePath.$1", + "id": "def-common.agentPolicyRouteService.getInfoPath.$1", "type": "string", "tags": [], - "label": "downloadSourceId", + "label": "agentPolicyId", "description": [], "signature": [ "string" @@ -24465,10 +14389,10 @@ }, { "parentPluginId": "fleet", - "id": "def-common.downloadSourceRoutesService.getListPath", + "id": "def-common.agentPolicyRouteService.getCreatePath", "type": "Function", "tags": [], - "label": "getListPath", + "label": "getCreatePath", "description": [], "signature": [ "() => string" @@ -24480,23 +14404,23 @@ }, { "parentPluginId": "fleet", - "id": "def-common.downloadSourceRoutesService.getDeletePath", + "id": "def-common.agentPolicyRouteService.getUpdatePath", "type": "Function", "tags": [], - "label": "getDeletePath", + "label": "getUpdatePath", "description": [], "signature": [ - "(downloadSourceId: string) => string" + "(agentPolicyId: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.downloadSourceRoutesService.getDeletePath.$1", + "id": "def-common.agentPolicyRouteService.getUpdatePath.$1", "type": "string", "tags": [], - "label": "downloadSourceId", + "label": "agentPolicyId", "description": [], "signature": [ "string" @@ -24510,148 +14434,40 @@ }, { "parentPluginId": "fleet", - "id": "def-common.downloadSourceRoutesService.getCreatePath", + "id": "def-common.agentPolicyRouteService.getCopyPath", "type": "Function", "tags": [], - "label": "getCreatePath", + "label": "getCopyPath", "description": [], "signature": [ - "() => string" + "(agentPolicyId: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ENROLLMENT_API_KEY_ROUTES", - "type": "Object", - "tags": [], - "label": "ENROLLMENT_API_KEY_ROUTES", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.ENROLLMENT_API_KEY_ROUTES.CREATE_PATTERN", - "type": "string", - "tags": [], - "label": "CREATE_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ENROLLMENT_API_KEY_ROUTES.LIST_PATTERN", - "type": "string", - "tags": [], - "label": "LIST_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ENROLLMENT_API_KEY_ROUTES.INFO_PATTERN", - "type": "string", - "tags": [], - "label": "INFO_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ENROLLMENT_API_KEY_ROUTES.DELETE_PATTERN", - "type": "string", - "tags": [], - "label": "DELETE_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ENROLLMENT_API_KEY_ROUTES.CREATE_PATTERN_DEPRECATED", - "type": "string", - "tags": [], - "label": "CREATE_PATTERN_DEPRECATED", - "description": [ - "// deprecated since 8.0" - ], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ENROLLMENT_API_KEY_ROUTES.LIST_PATTERN_DEPRECATED", - "type": "string", - "tags": [], - "label": "LIST_PATTERN_DEPRECATED", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ENROLLMENT_API_KEY_ROUTES.INFO_PATTERN_DEPRECATED", - "type": "string", - "tags": [], - "label": "INFO_PATTERN_DEPRECATED", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.ENROLLMENT_API_KEY_ROUTES.DELETE_PATTERN_DEPRECATED", - "type": "string", - "tags": [], - "label": "DELETE_PATTERN_DEPRECATED", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.enrollmentAPIKeyRouteService", - "type": "Object", - "tags": [], - "label": "enrollmentAPIKeyRouteService", - "description": [], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.enrollmentAPIKeyRouteService.getListPath", - "type": "Function", - "tags": [], - "label": "getListPath", - "description": [], - "signature": [ - "() => string" + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.agentPolicyRouteService.getCopyPath.$1", + "type": "string", + "tags": [], + "label": "agentPolicyId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": true + } ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], "returnComment": [] }, { "parentPluginId": "fleet", - "id": "def-common.enrollmentAPIKeyRouteService.getCreatePath", + "id": "def-common.agentPolicyRouteService.getDeletePath", "type": "Function", "tags": [], - "label": "getCreatePath", + "label": "getDeletePath", "description": [], "signature": [ "() => string" @@ -24663,23 +14479,23 @@ }, { "parentPluginId": "fleet", - "id": "def-common.enrollmentAPIKeyRouteService.getInfoPath", + "id": "def-common.agentPolicyRouteService.getInfoFullPath", "type": "Function", "tags": [], - "label": "getInfoPath", + "label": "getInfoFullPath", "description": [], "signature": [ - "(keyId: string) => string" + "(agentPolicyId: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.enrollmentAPIKeyRouteService.getInfoPath.$1", + "id": "def-common.agentPolicyRouteService.getInfoFullPath.$1", "type": "string", "tags": [], - "label": "keyId", + "label": "agentPolicyId", "description": [], "signature": [ "string" @@ -24693,23 +14509,23 @@ }, { "parentPluginId": "fleet", - "id": "def-common.enrollmentAPIKeyRouteService.getDeletePath", + "id": "def-common.agentPolicyRouteService.getInfoFullDownloadPath", "type": "Function", "tags": [], - "label": "getDeletePath", + "label": "getInfoFullDownloadPath", "description": [], "signature": [ - "(keyId: string) => string" + "(agentPolicyId: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.enrollmentAPIKeyRouteService.getDeletePath.$1", + "id": "def-common.agentPolicyRouteService.getInfoFullDownloadPath.$1", "type": "string", "tags": [], - "label": "keyId", + "label": "agentPolicyId", "description": [], "signature": [ "string" @@ -24720,199 +14536,175 @@ } ], "returnComment": [] - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES", - "type": "Object", - "tags": [], - "label": "EPM_API_ROUTES", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES.BULK_INSTALL_PATTERN", - "type": "string", - "tags": [], - "label": "BULK_INSTALL_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES.LIST_PATTERN", - "type": "string", - "tags": [], - "label": "LIST_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES.LIMITED_LIST_PATTERN", - "type": "string", - "tags": [], - "label": "LIMITED_LIST_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES.INFO_PATTERN", - "type": "string", - "tags": [], - "label": "INFO_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES.INSTALL_FROM_REGISTRY_PATTERN", - "type": "string", - "tags": [], - "label": "INSTALL_FROM_REGISTRY_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES.INSTALL_BY_UPLOAD_PATTERN", - "type": "string", - "tags": [], - "label": "INSTALL_BY_UPLOAD_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES.DELETE_PATTERN", - "type": "string", - "tags": [], - "label": "DELETE_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES.FILEPATH_PATTERN", - "type": "string", - "tags": [], - "label": "FILEPATH_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES.CATEGORIES_PATTERN", - "type": "string", - "tags": [], - "label": "CATEGORIES_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES.STATS_PATTERN", - "type": "string", + "id": "def-common.agentPolicyRouteService.getK8sInfoPath", + "type": "Function", "tags": [], - "label": "STATS_PATTERN", + "label": "getK8sInfoPath", "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES.INFO_PATTERN_DEPRECATED", - "type": "string", + "id": "def-common.agentPolicyRouteService.getK8sFullDownloadPath", + "type": "Function", "tags": [], - "label": "INFO_PATTERN_DEPRECATED", + "label": "getK8sFullDownloadPath", "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] }, { "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES.INSTALL_FROM_REGISTRY_PATTERN_DEPRECATED", - "type": "string", + "id": "def-common.agentPolicyRouteService.getResetOnePreconfiguredAgentPolicyPath", + "type": "Function", "tags": [], - "label": "INSTALL_FROM_REGISTRY_PATTERN_DEPRECATED", + "label": "getResetOnePreconfiguredAgentPolicyPath", "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false + "signature": [ + "(agentPolicyId: string) => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.agentPolicyRouteService.getResetOnePreconfiguredAgentPolicyPath.$1", + "type": "string", + "tags": [], + "label": "agentPolicyId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "fleet", - "id": "def-common.EPM_API_ROUTES.DELETE_PATTERN_DEPRECATED", - "type": "string", + "id": "def-common.agentPolicyRouteService.getResetAllPreconfiguredAgentPolicyPath", + "type": "Function", "tags": [], - "label": "DELETE_PATTERN_DEPRECATED", + "label": "getResetAllPreconfiguredAgentPolicyPath", "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.epmRouteService", + "id": "def-common.agentPolicyStatuses", "type": "Object", "tags": [], - "label": "epmRouteService", + "label": "agentPolicyStatuses", + "description": [], + "signature": [ + "{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }" + ], + "path": "x-pack/plugins/fleet/common/constants/agent_policy.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService", + "type": "Object", + "tags": [], + "label": "agentRouteService", "description": [], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getCategoriesPath", + "id": "def-common.agentRouteService.getInfoPath", "type": "Function", "tags": [], - "label": "getCategoriesPath", + "label": "getInfoPath", "description": [], "signature": [ - "() => string" + "(agentId: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getInfoPath.$1", + "type": "string", + "tags": [], + "label": "agentId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getListPath", + "id": "def-common.agentRouteService.getUpdatePath", "type": "Function", "tags": [], - "label": "getListPath", + "label": "getUpdatePath", "description": [], "signature": [ - "() => string" + "(agentId: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getUpdatePath.$1", + "type": "string", + "tags": [], + "label": "agentId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": true + } + ], "returnComment": [] }, { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getListLimitedPath", + "id": "def-common.agentRouteService.getBulkUpdateTagsPath", "type": "Function", "tags": [], - "label": "getListLimitedPath", + "label": "getBulkUpdateTagsPath", "description": [], "signature": [ "() => string" @@ -24924,23 +14716,23 @@ }, { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getInfoPath", + "id": "def-common.agentRouteService.getUnenrollPath", "type": "Function", "tags": [], - "label": "getInfoPath", + "label": "getUnenrollPath", "description": [], "signature": [ - "(pkgName: string, pkgVersion?: string | undefined) => string" + "(agentId: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getInfoPath.$1", + "id": "def-common.agentRouteService.getUnenrollPath.$1", "type": "string", "tags": [], - "label": "pkgName", + "label": "agentId", "description": [], "signature": [ "string" @@ -24948,43 +14740,44 @@ "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "isRequired": true - }, - { - "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getInfoPath.$2", - "type": "string", - "tags": [], - "label": "pkgVersion", - "description": [], - "signature": [ - "string | undefined" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getStatsPath", + "id": "def-common.agentRouteService.getBulkUnenrollPath", "type": "Function", "tags": [], - "label": "getStatsPath", + "label": "getBulkUnenrollPath", "description": [], "signature": [ - "(pkgName: string) => string" + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getReassignPath", + "type": "Function", + "tags": [], + "label": "getReassignPath", + "description": [], + "signature": [ + "(agentId: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getStatsPath.$1", + "id": "def-common.agentRouteService.getReassignPath.$1", "type": "string", "tags": [], - "label": "pkgName", + "label": "agentId", "description": [], "signature": [ "string" @@ -24998,23 +14791,38 @@ }, { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getFilePath", + "id": "def-common.agentRouteService.getBulkReassignPath", "type": "Function", "tags": [], - "label": "getFilePath", + "label": "getBulkReassignPath", "description": [], "signature": [ - "(filePath: string) => string" + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getUpgradePath", + "type": "Function", + "tags": [], + "label": "getUpgradePath", + "description": [], + "signature": [ + "(agentId: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getFilePath.$1", + "id": "def-common.agentRouteService.getUpgradePath.$1", "type": "string", "tags": [], - "label": "filePath", + "label": "agentId", "description": [], "signature": [ "string" @@ -25028,37 +14836,53 @@ }, { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getInstallPath", + "id": "def-common.agentRouteService.getBulkUpgradePath", "type": "Function", "tags": [], - "label": "getInstallPath", + "label": "getBulkUpgradePath", "description": [], "signature": [ - "(pkgName: string, pkgVersion: string) => string" + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getCurrentUpgradesPath", + "type": "Function", + "tags": [], + "label": "getCurrentUpgradesPath", + "description": [], + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getCancelActionPath", + "type": "Function", + "tags": [], + "label": "getCancelActionPath", + "description": [], + "signature": [ + "(actionId: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getInstallPath.$1", - "type": "string", - "tags": [], - "label": "pkgName", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getInstallPath.$2", + "id": "def-common.agentRouteService.getCancelActionPath.$1", "type": "string", "tags": [], - "label": "pkgVersion", + "label": "actionId", "description": [], "signature": [ "string" @@ -25072,10 +14896,10 @@ }, { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getBulkInstallPath", + "id": "def-common.agentRouteService.getListPath", "type": "Function", "tags": [], - "label": "getBulkInstallPath", + "label": "getListPath", "description": [], "signature": [ "() => string" @@ -25087,81 +14911,53 @@ }, { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getRemovePath", + "id": "def-common.agentRouteService.getStatusPath", "type": "Function", "tags": [], - "label": "getRemovePath", + "label": "getStatusPath", "description": [], "signature": [ - "(pkgName: string, pkgVersion: string) => string" + "() => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getRemovePath.$1", - "type": "string", - "tags": [], - "label": "pkgName", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getRemovePath.$2", - "type": "string", - "tags": [], - "label": "pkgVersion", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - } + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getIncomingDataPath", + "type": "Function", + "tags": [], + "label": "getIncomingDataPath", + "description": [], + "signature": [ + "() => string" ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], "returnComment": [] }, { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getUpdatePath", + "id": "def-common.agentRouteService.getCreateActionPath", "type": "Function", "tags": [], - "label": "getUpdatePath", + "label": "getCreateActionPath", "description": [], "signature": [ - "(pkgName: string, pkgVersion: string) => string" + "(agentId: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getUpdatePath.$1", - "type": "string", - "tags": [], - "label": "pkgName", - "description": [], - "signature": [ - "string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "isRequired": true - }, - { - "parentPluginId": "fleet", - "id": "def-common.epmRouteService.getUpdatePath.$2", + "id": "def-common.agentRouteService.getCreateActionPath.$1", "type": "string", "tags": [], - "label": "pkgVersion", + "label": "agentId", "description": [], "signature": [ "string" @@ -25172,41 +14968,104 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.agentRouteService.getListTagsPath", + "type": "Function", + "tags": [], + "label": "getListTagsPath", + "description": [], + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENTS_SETUP_API_ROUTES", + "type": "Object", + "tags": [], + "label": "AGENTS_SETUP_API_ROUTES", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.AGENTS_SETUP_API_ROUTES.INFO_PATTERN", + "type": "string", + "tags": [], + "label": "INFO_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.AGENTS_SETUP_API_ROUTES.CREATE_PATTERN", + "type": "string", + "tags": [], + "label": "CREATE_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false } ], "initialIsOpen": false }, { "parentPluginId": "fleet", - "id": "def-common.fleetSetupRouteService", + "id": "def-common.appRoutesService", "type": "Object", "tags": [], - "label": "fleetSetupRouteService", + "label": "appRoutesService", "description": [], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.fleetSetupRouteService.getFleetSetupPath", + "id": "def-common.appRoutesService.getCheckPermissionsPath", "type": "Function", "tags": [], - "label": "getFleetSetupPath", + "label": "getCheckPermissionsPath", "description": [], "signature": [ - "() => string" + "(fleetServerSetup?: boolean | undefined) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, - "children": [], + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.appRoutesService.getCheckPermissionsPath.$1", + "type": "CompoundType", + "tags": [], + "label": "fleetServerSetup", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": false + } + ], "returnComment": [] }, { "parentPluginId": "fleet", - "id": "def-common.fleetSetupRouteService.postFleetSetupPath", + "id": "def-common.appRoutesService.getRegenerateServiceTokenPath", "type": "Function", "tags": [], - "label": "postFleetSetupPath", + "label": "getRegenerateServiceTokenPath", "description": [], "signature": [ "() => string" @@ -25221,74 +15080,47 @@ }, { "parentPluginId": "fleet", - "id": "def-common.installationStatuses", - "type": "Object", - "tags": [], - "label": "installationStatuses", - "description": [], - "signature": [ - "{ readonly Installed: \"installed\"; readonly Installing: \"installing\"; readonly InstallFailed: \"install_failed\"; readonly NotInstalled: \"not_installed\"; }" - ], - "path": "x-pack/plugins/fleet/common/constants/epm.ts", - "deprecated": false, - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.K8S_API_ROUTES", + "id": "def-common.EPM_API_ROUTES", "type": "Object", "tags": [], - "label": "K8S_API_ROUTES", + "label": "EPM_API_ROUTES", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.K8S_API_ROUTES.K8S_DOWNLOAD_PATTERN", + "id": "def-common.EPM_API_ROUTES.BULK_INSTALL_PATTERN", "type": "string", "tags": [], - "label": "K8S_DOWNLOAD_PATTERN", + "label": "BULK_INSTALL_PATTERN", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.K8S_API_ROUTES.K8S_INFO_PATTERN", + "id": "def-common.EPM_API_ROUTES.LIST_PATTERN", "type": "string", "tags": [], - "label": "K8S_INFO_PATTERN", + "label": "LIST_PATTERN", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.OUTPUT_API_ROUTES", - "type": "Object", - "tags": [], - "label": "OUTPUT_API_ROUTES", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "children": [ + }, { "parentPluginId": "fleet", - "id": "def-common.OUTPUT_API_ROUTES.LIST_PATTERN", + "id": "def-common.EPM_API_ROUTES.LIMITED_LIST_PATTERN", "type": "string", "tags": [], - "label": "LIST_PATTERN", + "label": "LIMITED_LIST_PATTERN", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.OUTPUT_API_ROUTES.INFO_PATTERN", + "id": "def-common.EPM_API_ROUTES.INFO_PATTERN", "type": "string", "tags": [], "label": "INFO_PATTERN", @@ -25298,17 +15130,27 @@ }, { "parentPluginId": "fleet", - "id": "def-common.OUTPUT_API_ROUTES.UPDATE_PATTERN", + "id": "def-common.EPM_API_ROUTES.INSTALL_FROM_REGISTRY_PATTERN", "type": "string", "tags": [], - "label": "UPDATE_PATTERN", + "label": "INSTALL_FROM_REGISTRY_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.EPM_API_ROUTES.INSTALL_BY_UPLOAD_PATTERN", + "type": "string", + "tags": [], + "label": "INSTALL_BY_UPLOAD_PATTERN", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false }, { "parentPluginId": "fleet", - "id": "def-common.OUTPUT_API_ROUTES.DELETE_PATTERN", + "id": "def-common.EPM_API_ROUTES.DELETE_PATTERN", "type": "string", "tags": [], "label": "DELETE_PATTERN", @@ -25318,56 +15160,215 @@ }, { "parentPluginId": "fleet", - "id": "def-common.OUTPUT_API_ROUTES.CREATE_PATTERN", + "id": "def-common.EPM_API_ROUTES.FILEPATH_PATTERN", "type": "string", "tags": [], - "label": "CREATE_PATTERN", + "label": "FILEPATH_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.EPM_API_ROUTES.CATEGORIES_PATTERN", + "type": "string", + "tags": [], + "label": "CATEGORIES_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.EPM_API_ROUTES.STATS_PATTERN", + "type": "string", + "tags": [], + "label": "STATS_PATTERN", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.EPM_API_ROUTES.INFO_PATTERN_DEPRECATED", + "type": "string", + "tags": [], + "label": "INFO_PATTERN_DEPRECATED", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.EPM_API_ROUTES.INSTALL_FROM_REGISTRY_PATTERN_DEPRECATED", + "type": "string", + "tags": [], + "label": "INSTALL_FROM_REGISTRY_PATTERN_DEPRECATED", + "description": [], + "path": "x-pack/plugins/fleet/common/constants/routes.ts", + "deprecated": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.EPM_API_ROUTES.DELETE_PATTERN_DEPRECATED", + "type": "string", + "tags": [], + "label": "DELETE_PATTERN_DEPRECATED", "description": [], "path": "x-pack/plugins/fleet/common/constants/routes.ts", "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.epmRouteService", + "type": "Object", + "tags": [], + "label": "epmRouteService", + "description": [], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.epmRouteService.getCategoriesPath", + "type": "Function", + "tags": [], + "label": "getCategoriesPath", + "description": [], + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.epmRouteService.getListPath", + "type": "Function", + "tags": [], + "label": "getListPath", + "description": [], + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.epmRouteService.getListLimitedPath", + "type": "Function", + "tags": [], + "label": "getListLimitedPath", + "description": [], + "signature": [ + "() => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.epmRouteService.getInfoPath", + "type": "Function", + "tags": [], + "label": "getInfoPath", + "description": [], + "signature": [ + "(pkgName: string, pkgVersion?: string | undefined) => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.epmRouteService.getInfoPath.$1", + "type": "string", + "tags": [], + "label": "pkgName", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "fleet", + "id": "def-common.epmRouteService.getInfoPath.$2", + "type": "string", + "tags": [], + "label": "pkgVersion", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "fleet", + "id": "def-common.epmRouteService.getStatsPath", + "type": "Function", + "tags": [], + "label": "getStatsPath", + "description": [], + "signature": [ + "(pkgName: string) => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.epmRouteService.getStatsPath.$1", + "type": "string", + "tags": [], + "label": "pkgName", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] }, { "parentPluginId": "fleet", - "id": "def-common.OUTPUT_API_ROUTES.LOGSTASH_API_KEY_PATTERN", - "type": "string", - "tags": [], - "label": "LOGSTASH_API_KEY_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.outputRoutesService", - "type": "Object", - "tags": [], - "label": "outputRoutesService", - "description": [], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.outputRoutesService.getInfoPath", + "id": "def-common.epmRouteService.getFilePath", "type": "Function", "tags": [], - "label": "getInfoPath", + "label": "getFilePath", "description": [], "signature": [ - "(outputId: string) => string" + "(filePath: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.outputRoutesService.getInfoPath.$1", + "id": "def-common.epmRouteService.getFilePath.$1", "type": "string", "tags": [], - "label": "outputId", + "label": "filePath", "description": [], "signature": [ "string" @@ -25381,23 +15382,37 @@ }, { "parentPluginId": "fleet", - "id": "def-common.outputRoutesService.getUpdatePath", + "id": "def-common.epmRouteService.getInstallPath", "type": "Function", "tags": [], - "label": "getUpdatePath", + "label": "getInstallPath", "description": [], "signature": [ - "(outputId: string) => string" + "(pkgName: string, pkgVersion: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.outputRoutesService.getUpdatePath.$1", + "id": "def-common.epmRouteService.getInstallPath.$1", + "type": "string", + "tags": [], + "label": "pkgName", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "fleet", + "id": "def-common.epmRouteService.getInstallPath.$2", "type": "string", "tags": [], - "label": "outputId", + "label": "pkgVersion", "description": [], "signature": [ "string" @@ -25411,10 +15426,10 @@ }, { "parentPluginId": "fleet", - "id": "def-common.outputRoutesService.getListPath", + "id": "def-common.epmRouteService.getBulkInstallPath", "type": "Function", "tags": [], - "label": "getListPath", + "label": "getBulkInstallPath", "description": [], "signature": [ "() => string" @@ -25426,23 +15441,37 @@ }, { "parentPluginId": "fleet", - "id": "def-common.outputRoutesService.getDeletePath", + "id": "def-common.epmRouteService.getRemovePath", "type": "Function", "tags": [], - "label": "getDeletePath", + "label": "getRemovePath", "description": [], "signature": [ - "(outputId: string) => string" + "(pkgName: string, pkgVersion: string) => string" ], "path": "x-pack/plugins/fleet/common/services/routes.ts", "deprecated": false, "children": [ { "parentPluginId": "fleet", - "id": "def-common.outputRoutesService.getDeletePath.$1", + "id": "def-common.epmRouteService.getRemovePath.$1", + "type": "string", + "tags": [], + "label": "pkgName", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "fleet", + "id": "def-common.epmRouteService.getRemovePath.$2", "type": "string", "tags": [], - "label": "outputId", + "label": "pkgVersion", "description": [], "signature": [ "string" @@ -25456,10 +15485,67 @@ }, { "parentPluginId": "fleet", - "id": "def-common.outputRoutesService.getCreatePath", + "id": "def-common.epmRouteService.getUpdatePath", "type": "Function", "tags": [], - "label": "getCreatePath", + "label": "getUpdatePath", + "description": [], + "signature": [ + "(pkgName: string, pkgVersion: string) => string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.epmRouteService.getUpdatePath.$1", + "type": "string", + "tags": [], + "label": "pkgName", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "fleet", + "id": "def-common.epmRouteService.getUpdatePath.$2", + "type": "string", + "tags": [], + "label": "pkgVersion", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "fleet", + "id": "def-common.fleetSetupRouteService", + "type": "Object", + "tags": [], + "label": "fleetSetupRouteService", + "description": [], + "path": "x-pack/plugins/fleet/common/services/routes.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "fleet", + "id": "def-common.fleetSetupRouteService.getFleetSetupPath", + "type": "Function", + "tags": [], + "label": "getFleetSetupPath", "description": [], "signature": [ "() => string" @@ -25471,10 +15557,10 @@ }, { "parentPluginId": "fleet", - "id": "def-common.outputRoutesService.getCreateLogstashApiKeyPath", + "id": "def-common.fleetSetupRouteService.postFleetSetupPath", "type": "Function", "tags": [], - "label": "getCreateLogstashApiKeyPath", + "label": "postFleetSetupPath", "description": [], "signature": [ "() => string" @@ -25487,20 +15573,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "fleet", - "id": "def-common.outputType", - "type": "Object", - "tags": [], - "label": "outputType", - "description": [], - "signature": [ - "{ readonly Elasticsearch: \"elasticsearch\"; readonly Logstash: \"logstash\"; }" - ], - "path": "x-pack/plugins/fleet/common/constants/output.ts", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "fleet", "id": "def-common.PACKAGE_POLICY_API_ROUTES", @@ -25757,125 +15829,6 @@ ], "initialIsOpen": false }, - { - "parentPluginId": "fleet", - "id": "def-common.PRECONFIGURATION_API_ROUTES", - "type": "Object", - "tags": [], - "label": "PRECONFIGURATION_API_ROUTES", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.PRECONFIGURATION_API_ROUTES.UPDATE_PATTERN", - "type": "string", - "tags": [], - "label": "UPDATE_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PRECONFIGURATION_API_ROUTES.RESET_PATTERN", - "type": "string", - "tags": [], - "label": "RESET_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.PRECONFIGURATION_API_ROUTES.RESET_ONE_PATTERN", - "type": "string", - "tags": [], - "label": "RESET_ONE_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.SETTINGS_API_ROUTES", - "type": "Object", - "tags": [], - "label": "SETTINGS_API_ROUTES", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.SETTINGS_API_ROUTES.INFO_PATTERN", - "type": "string", - "tags": [], - "label": "INFO_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.SETTINGS_API_ROUTES.UPDATE_PATTERN", - "type": "string", - "tags": [], - "label": "UPDATE_PATTERN", - "description": [], - "path": "x-pack/plugins/fleet/common/constants/routes.ts", - "deprecated": false - } - ], - "initialIsOpen": false - }, - { - "parentPluginId": "fleet", - "id": "def-common.settingsRoutesService", - "type": "Object", - "tags": [], - "label": "settingsRoutesService", - "description": [], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [ - { - "parentPluginId": "fleet", - "id": "def-common.settingsRoutesService.getInfoPath", - "type": "Function", - "tags": [], - "label": "getInfoPath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - }, - { - "parentPluginId": "fleet", - "id": "def-common.settingsRoutesService.getUpdatePath", - "type": "Function", - "tags": [], - "label": "getUpdatePath", - "description": [], - "signature": [ - "() => string" - ], - "path": "x-pack/plugins/fleet/common/services/routes.ts", - "deprecated": false, - "children": [], - "returnComment": [] - } - ], - "initialIsOpen": false - }, { "parentPluginId": "fleet", "id": "def-common.setupRouteService", diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx index 198b522880ac4..83097df4df36b 100644 --- a/api_docs/fleet.mdx +++ b/api_docs/fleet.mdx @@ -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-25 +date: 2022-07-28 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. --- @@ -18,7 +18,7 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 1541 | 8 | 1409 | 10 | +| 953 | 3 | 858 | 9 | ## Client @@ -68,9 +68,6 @@ Contact [Fleet](https://github.com/orgs/elastic/teams/fleet) for questions regar ### Functions -### Classes - - ### Interfaces diff --git a/api_docs/global_search.devdocs.json b/api_docs/global_search.devdocs.json index 4c1ca7278bff6..bd4fd58369336 100644 --- a/api_docs/global_search.devdocs.json +++ b/api_docs/global_search.devdocs.json @@ -612,13 +612,7 @@ "description": [], "signature": [ "{ savedObjects: { client: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", "; typeRegistry: ", { "pluginId": "core", diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx index 138d9292e017c..c9158764cf123 100644 --- a/api_docs/global_search.mdx +++ b/api_docs/global_search.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/home.devdocs.json b/api_docs/home.devdocs.json index 6007d62a8816f..14a039d123e3d 100644 --- a/api_docs/home.devdocs.json +++ b/api_docs/home.devdocs.json @@ -1628,7 +1628,7 @@ "signature": [ "{ getSampleDatasets: () => ", "Writable", - "[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", + "[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", "SavedObject", "[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ", { @@ -1662,7 +1662,7 @@ "signature": [ "() => ", "Writable", - "[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>" + "[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record; 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", - "[]; defaultIndex: string; previewImagePath: string; overviewDashboard: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", + "[]; previewImagePath: string; overviewDashboard: string; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", "SavedObject", "[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ", { diff --git a/api_docs/home.mdx b/api_docs/home.mdx index 469f76a82daa7..75e30b511bf04 100644 --- a/api_docs/home.mdx +++ b/api_docs/home.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx index d750ba0bfedf6..21d8005d85e20 100644 --- a/api_docs/index_lifecycle_management.mdx +++ b/api_docs/index_lifecycle_management.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/index_management.devdocs.json b/api_docs/index_management.devdocs.json index 8c93e29dd27e9..89672d6e856d7 100644 --- a/api_docs/index_management.devdocs.json +++ b/api_docs/index_management.devdocs.json @@ -2437,7 +2437,7 @@ "label": "MAJOR_VERSION", "description": [], "signature": [ - "\"8.4.0\"" + "\"8.5.0\"" ], "path": "x-pack/plugins/index_management/common/constants/plugin.ts", "deprecated": false, diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx index fa4c82bfc3692..f78d564c61f92 100644 --- a/api_docs/index_management.mdx +++ b/api_docs/index_management.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/infra.devdocs.json b/api_docs/infra.devdocs.json index f3e0d7ab4ad1d..d9ee7fb6b4497 100644 --- a/api_docs/infra.devdocs.json +++ b/api_docs/infra.devdocs.json @@ -614,13 +614,7 @@ "description": [], "signature": [ "(savedObjectsClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", sourceId?: string | undefined) => Promise" ], "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, diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx index ad8d9532d9448..ac7bb087a093a 100644 --- a/api_docs/infra.mdx +++ b/api_docs/infra.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx index 8d198076655b8..2a391c05b7154 100644 --- a/api_docs/inspector.mdx +++ b/api_docs/inspector.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/interactive_setup.mdx b/api_docs/interactive_setup.mdx index 03596635b7803..f43c87e710983 100644 --- a/api_docs/interactive_setup.mdx +++ b/api_docs/interactive_setup.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/kbn_ace.mdx b/api_docs/kbn_ace.mdx index 4f6918007222f..cbe09a1756558 100644 --- a/api_docs/kbn_ace.mdx +++ b/api_docs/kbn_ace.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/kbn_aiops_components.mdx b/api_docs/kbn_aiops_components.mdx index 53b75509415c7..9fc99c8be29af 100644 --- a/api_docs/kbn_aiops_components.mdx +++ b/api_docs/kbn_aiops_components.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/kbn_aiops_utils.mdx b/api_docs/kbn_aiops_utils.mdx index 93bdadf5e3c98..6778875771941 100644 --- a/api_docs/kbn_aiops_utils.mdx +++ b/api_docs/kbn_aiops_utils.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/kbn_alerts.mdx b/api_docs/kbn_alerts.mdx index 82a0831707ec3..f2c9ad40db199 100644 --- a/api_docs/kbn_alerts.mdx +++ b/api_docs/kbn_alerts.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/kbn_analytics.mdx b/api_docs/kbn_analytics.mdx index 8cd6863bcc014..180411fc6b756 100644 --- a/api_docs/kbn_analytics.mdx +++ b/api_docs/kbn_analytics.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/kbn_analytics_client.mdx b/api_docs/kbn_analytics_client.mdx index 427df038bf768..b761819ed97fc 100644 --- a/api_docs/kbn_analytics_client.mdx +++ b/api_docs/kbn_analytics_client.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx index 174b74afb37d6..d1a90ca31c399 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_browser.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx index 839d8440fa084..b540d5d9f1faa 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_common.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx index a9f334faae6cc..3ce29f378880c 100644 --- a/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx +++ b/api_docs/kbn_analytics_shippers_elastic_v3_server.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/kbn_analytics_shippers_fullstory.mdx b/api_docs/kbn_analytics_shippers_fullstory.mdx index be6aa8a761dcc..1255fc4e20cd4 100644 --- a/api_docs/kbn_analytics_shippers_fullstory.mdx +++ b/api_docs/kbn_analytics_shippers_fullstory.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/kbn_apm_config_loader.mdx b/api_docs/kbn_apm_config_loader.mdx index b451b5caab525..35848dbd04733 100644 --- a/api_docs/kbn_apm_config_loader.mdx +++ b/api_docs/kbn_apm_config_loader.mdx @@ -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-25 +date: 2022-07-28 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. --- diff --git a/api_docs/kbn_apm_utils.mdx b/api_docs/kbn_apm_utils.mdx index 410356df20b16..b9582b7d618a8 100644 --- a/api_docs/kbn_apm_utils.mdx +++ b/api_docs/kbn_apm_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-apm-utils title: "@kbn/apm-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/apm-utils plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/apm-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. --- diff --git a/api_docs/kbn_axe_config.mdx b/api_docs/kbn_axe_config.mdx index 3be0a54d0c062..00519afd29b79 100644 --- a/api_docs/kbn_axe_config.mdx +++ b/api_docs/kbn_axe_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-axe-config title: "@kbn/axe-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/axe-config plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/axe-config'] 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. --- diff --git a/api_docs/kbn_bazel_packages.mdx b/api_docs/kbn_bazel_packages.mdx index f8fbdf71d00ec..7bfa961f3c6fd 100644 --- a/api_docs/kbn_bazel_packages.mdx +++ b/api_docs/kbn_bazel_packages.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-bazel-packages title: "@kbn/bazel-packages" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/bazel-packages plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/bazel-packages'] 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. --- diff --git a/api_docs/kbn_ci_stats_core.mdx b/api_docs/kbn_ci_stats_core.mdx index 9315de94d343b..738a164189e42 100644 --- a/api_docs/kbn_ci_stats_core.mdx +++ b/api_docs/kbn_ci_stats_core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-core title: "@kbn/ci-stats-core" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-core plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-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. --- diff --git a/api_docs/kbn_ci_stats_performance_metrics.mdx b/api_docs/kbn_ci_stats_performance_metrics.mdx index 2cce41bb2f569..cd35041838c8d 100644 --- a/api_docs/kbn_ci_stats_performance_metrics.mdx +++ b/api_docs/kbn_ci_stats_performance_metrics.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-performance-metrics title: "@kbn/ci-stats-performance-metrics" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-performance-metrics plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-performance-metrics'] 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. --- diff --git a/api_docs/kbn_ci_stats_reporter.mdx b/api_docs/kbn_ci_stats_reporter.mdx index 2ceb66379377d..86d7808623dc3 100644 --- a/api_docs/kbn_ci_stats_reporter.mdx +++ b/api_docs/kbn_ci_stats_reporter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ci-stats-reporter title: "@kbn/ci-stats-reporter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ci-stats-reporter plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ci-stats-reporter'] 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. --- diff --git a/api_docs/kbn_cli_dev_mode.mdx b/api_docs/kbn_cli_dev_mode.mdx index 3a84b45e49a40..23f7ff6e4621b 100644 --- a/api_docs/kbn_cli_dev_mode.mdx +++ b/api_docs/kbn_cli_dev_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-cli-dev-mode title: "@kbn/cli-dev-mode" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/cli-dev-mode plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/cli-dev-mode'] 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. --- diff --git a/api_docs/kbn_coloring.mdx b/api_docs/kbn_coloring.mdx index 3fafe1b2a4f60..74d1e4780568e 100644 --- a/api_docs/kbn_coloring.mdx +++ b/api_docs/kbn_coloring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-coloring title: "@kbn/coloring" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/coloring plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/coloring'] 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. --- diff --git a/api_docs/kbn_config.mdx b/api_docs/kbn_config.mdx index 04931728e3bcc..edee0c4188f69 100644 --- a/api_docs/kbn_config.mdx +++ b/api_docs/kbn_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config title: "@kbn/config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config'] 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. --- diff --git a/api_docs/kbn_config_mocks.mdx b/api_docs/kbn_config_mocks.mdx index 28d11c965e04d..bc47ed8abe9a2 100644 --- a/api_docs/kbn_config_mocks.mdx +++ b/api_docs/kbn_config_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-mocks title: "@kbn/config-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-mocks'] 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. --- diff --git a/api_docs/kbn_config_schema.mdx b/api_docs/kbn_config_schema.mdx index a2344d9e96931..e1ed92ac2d966 100644 --- a/api_docs/kbn_config_schema.mdx +++ b/api_docs/kbn_config_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-config-schema title: "@kbn/config-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/config-schema plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/config-schema'] 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. --- diff --git a/api_docs/kbn_core_analytics_browser.mdx b/api_docs/kbn_core_analytics_browser.mdx index 4525e1515ef38..020cc5f096fe1 100644 --- a/api_docs/kbn_core_analytics_browser.mdx +++ b/api_docs/kbn_core_analytics_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser title: "@kbn/core-analytics-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-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. --- diff --git a/api_docs/kbn_core_analytics_browser_internal.mdx b/api_docs/kbn_core_analytics_browser_internal.mdx index 523927d717040..36e87055b52ad 100644 --- a/api_docs/kbn_core_analytics_browser_internal.mdx +++ b/api_docs/kbn_core_analytics_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-internal title: "@kbn/core-analytics-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-internal'] 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. --- diff --git a/api_docs/kbn_core_analytics_browser_mocks.mdx b/api_docs/kbn_core_analytics_browser_mocks.mdx index a511e020de5e3..71412c3e72269 100644 --- a/api_docs/kbn_core_analytics_browser_mocks.mdx +++ b/api_docs/kbn_core_analytics_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-browser-mocks title: "@kbn/core-analytics-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-browser-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-browser-mocks'] 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. --- diff --git a/api_docs/kbn_core_analytics_server.mdx b/api_docs/kbn_core_analytics_server.mdx index 9f290e7ea5e22..a446608fbbf7a 100644 --- a/api_docs/kbn_core_analytics_server.mdx +++ b/api_docs/kbn_core_analytics_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server title: "@kbn/core-analytics-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-server plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-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. --- diff --git a/api_docs/kbn_core_analytics_server_internal.mdx b/api_docs/kbn_core_analytics_server_internal.mdx index 351a210df51b5..460a92d575c4a 100644 --- a/api_docs/kbn_core_analytics_server_internal.mdx +++ b/api_docs/kbn_core_analytics_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-internal title: "@kbn/core-analytics-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-server-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-internal'] 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. --- diff --git a/api_docs/kbn_core_analytics_server_mocks.mdx b/api_docs/kbn_core_analytics_server_mocks.mdx index 081177c99a98f..d894c2a1c784d 100644 --- a/api_docs/kbn_core_analytics_server_mocks.mdx +++ b/api_docs/kbn_core_analytics_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-analytics-server-mocks title: "@kbn/core-analytics-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-analytics-server-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-analytics-server-mocks'] 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. --- diff --git a/api_docs/kbn_core_base_browser_mocks.mdx b/api_docs/kbn_core_base_browser_mocks.mdx index ed0b71bac6f13..fde2037a031fa 100644 --- a/api_docs/kbn_core_base_browser_mocks.mdx +++ b/api_docs/kbn_core_base_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-browser-mocks title: "@kbn/core-base-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-browser-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-browser-mocks'] 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. --- diff --git a/api_docs/kbn_core_base_common.mdx b/api_docs/kbn_core_base_common.mdx index bf48dca91867e..f41e7c6bbc70b 100644 --- a/api_docs/kbn_core_base_common.mdx +++ b/api_docs/kbn_core_base_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-common title: "@kbn/core-base-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-common plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-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. --- diff --git a/api_docs/kbn_core_base_server_internal.mdx b/api_docs/kbn_core_base_server_internal.mdx index 8c26ec9f48f2c..694ae6113145c 100644 --- a/api_docs/kbn_core_base_server_internal.mdx +++ b/api_docs/kbn_core_base_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-internal title: "@kbn/core-base-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-server-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-internal'] 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. --- diff --git a/api_docs/kbn_core_base_server_mocks.mdx b/api_docs/kbn_core_base_server_mocks.mdx index 9bc5edb9166ec..a928a81793b73 100644 --- a/api_docs/kbn_core_base_server_mocks.mdx +++ b/api_docs/kbn_core_base_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-base-server-mocks title: "@kbn/core-base-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-base-server-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-base-server-mocks'] 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. --- diff --git a/api_docs/kbn_core_capabilities_common.devdocs.json b/api_docs/kbn_core_capabilities_common.devdocs.json new file mode 100644 index 0000000000000..428d9901c8c62 --- /dev/null +++ b/api_docs/kbn_core_capabilities_common.devdocs.json @@ -0,0 +1,103 @@ +{ + "id": "@kbn/core-capabilities-common", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-capabilities-common", + "id": "def-common.Capabilities", + "type": "Interface", + "tags": [], + "label": "Capabilities", + "description": [ + "\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n" + ], + "path": "packages/core/capabilities/core-capabilities-common/src/capabilities.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-capabilities-common", + "id": "def-common.Capabilities.navLinks", + "type": "Object", + "tags": [], + "label": "navLinks", + "description": [ + "Navigation link capabilities." + ], + "signature": [ + "{ [x: string]: boolean; }" + ], + "path": "packages/core/capabilities/core-capabilities-common/src/capabilities.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-capabilities-common", + "id": "def-common.Capabilities.management", + "type": "Object", + "tags": [], + "label": "management", + "description": [ + "Management section capabilities." + ], + "signature": [ + "{ [sectionId: string]: Record; }" + ], + "path": "packages/core/capabilities/core-capabilities-common/src/capabilities.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-capabilities-common", + "id": "def-common.Capabilities.catalogue", + "type": "Object", + "tags": [], + "label": "catalogue", + "description": [ + "Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options." + ], + "signature": [ + "{ [x: string]: boolean; }" + ], + "path": "packages/core/capabilities/core-capabilities-common/src/capabilities.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-capabilities-common", + "id": "def-common.Capabilities.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: Record>", + "description": [ + "Custom capabilities, registered by plugins." + ], + "signature": [ + "[key: string]: Record>" + ], + "path": "packages/core/capabilities/core-capabilities-common/src/capabilities.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_capabilities_common.mdx b/api_docs/kbn_core_capabilities_common.mdx new file mode 100644 index 0000000000000..2d60af3426ee7 --- /dev/null +++ b/api_docs/kbn_core_capabilities_common.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreCapabilitiesCommonPluginApi +slug: /kibana-dev-docs/api/kbn-core-capabilities-common +title: "@kbn/core-capabilities-common" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-capabilities-common plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-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. +--- +import kbnCoreCapabilitiesCommonObj from './kbn_core_capabilities_common.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 5 | 0 | 0 | 0 | + +## Common + +### Interfaces + + diff --git a/api_docs/kbn_core_capabilities_server.devdocs.json b/api_docs/kbn_core_capabilities_server.devdocs.json new file mode 100644 index 0000000000000..4713bfc357f49 --- /dev/null +++ b/api_docs/kbn_core_capabilities_server.devdocs.json @@ -0,0 +1,328 @@ +{ + "id": "@kbn/core-capabilities-server", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesSetup", + "type": "Interface", + "tags": [], + "label": "CapabilitiesSetup", + "description": [ + "\nAPIs to manage the {@link Capabilities} that will be used by the application.\n\nPlugins relying on capabilities to toggle some of their features should register them during the setup phase\nusing the `registerProvider` method.\n\nPlugins having the responsibility to restrict capabilities depending on a given context should register\ntheir capabilities switcher using the `registerSwitcher` method.\n\nRefers to the methods documentation for complete description and examples.\n" + ], + "path": "packages/core/capabilities/core-capabilities-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesSetup.registerProvider", + "type": "Function", + "tags": [], + "label": "registerProvider", + "description": [ + "\nRegister a {@link CapabilitiesProvider} to be used to provide {@link Capabilities}\nwhen resolving them.\n" + ], + "signature": [ + "(provider: ", + { + "pluginId": "@kbn/core-capabilities-server", + "scope": "server", + "docId": "kibKbnCoreCapabilitiesServerPluginApi", + "section": "def-server.CapabilitiesProvider", + "text": "CapabilitiesProvider" + }, + ") => void" + ], + "path": "packages/core/capabilities/core-capabilities-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesSetup.registerProvider.$1", + "type": "Function", + "tags": [], + "label": "provider", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-capabilities-server", + "scope": "server", + "docId": "kibKbnCoreCapabilitiesServerPluginApi", + "section": "def-server.CapabilitiesProvider", + "text": "CapabilitiesProvider" + } + ], + "path": "packages/core/capabilities/core-capabilities-server/src/contracts.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesSetup.registerSwitcher", + "type": "Function", + "tags": [], + "label": "registerSwitcher", + "description": [ + "\nRegister a {@link CapabilitiesSwitcher} to be used to change the default state\nof the {@link Capabilities} entries when resolving them.\n\nA capabilities switcher can only change the state of existing capabilities.\nCapabilities added or removed when invoking the switcher will be ignored.\n" + ], + "signature": [ + "(switcher: ", + { + "pluginId": "@kbn/core-capabilities-server", + "scope": "server", + "docId": "kibKbnCoreCapabilitiesServerPluginApi", + "section": "def-server.CapabilitiesSwitcher", + "text": "CapabilitiesSwitcher" + }, + ") => void" + ], + "path": "packages/core/capabilities/core-capabilities-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesSetup.registerSwitcher.$1", + "type": "Function", + "tags": [], + "label": "switcher", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-capabilities-server", + "scope": "server", + "docId": "kibKbnCoreCapabilitiesServerPluginApi", + "section": "def-server.CapabilitiesSwitcher", + "text": "CapabilitiesSwitcher" + } + ], + "path": "packages/core/capabilities/core-capabilities-server/src/contracts.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesStart", + "type": "Interface", + "tags": [], + "label": "CapabilitiesStart", + "description": [ + "\nAPIs to access the application {@link Capabilities}.\n" + ], + "path": "packages/core/capabilities/core-capabilities-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesStart.resolveCapabilities", + "type": "Function", + "tags": [], + "label": "resolveCapabilities", + "description": [ + "\nResolve the {@link Capabilities} to be used for given request" + ], + "signature": [ + "(request: ", + "KibanaRequest", + ", options?: ", + { + "pluginId": "@kbn/core-capabilities-server", + "scope": "server", + "docId": "kibKbnCoreCapabilitiesServerPluginApi", + "section": "def-server.ResolveCapabilitiesOptions", + "text": "ResolveCapabilitiesOptions" + }, + " | undefined) => Promise<", + "Capabilities", + ">" + ], + "path": "packages/core/capabilities/core-capabilities-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesStart.resolveCapabilities.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "packages/core/capabilities/core-capabilities-server/src/contracts.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesStart.resolveCapabilities.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-capabilities-server", + "scope": "server", + "docId": "kibKbnCoreCapabilitiesServerPluginApi", + "section": "def-server.ResolveCapabilitiesOptions", + "text": "ResolveCapabilitiesOptions" + }, + " | undefined" + ], + "path": "packages/core/capabilities/core-capabilities-server/src/contracts.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.ResolveCapabilitiesOptions", + "type": "Interface", + "tags": [], + "label": "ResolveCapabilitiesOptions", + "description": [ + "\nDefines a set of additional options for the `resolveCapabilities` method of {@link CapabilitiesStart}.\n" + ], + "path": "packages/core/capabilities/core-capabilities-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.ResolveCapabilitiesOptions.useDefaultCapabilities", + "type": "boolean", + "tags": [], + "label": "useDefaultCapabilities", + "description": [ + "\nIndicates if capability switchers are supposed to return a default set of capabilities." + ], + "path": "packages/core/capabilities/core-capabilities-server/src/contracts.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesProvider", + "type": "Type", + "tags": [], + "label": "CapabilitiesProvider", + "description": [ + "\nSee {@link CapabilitiesSetup}" + ], + "signature": [ + "() => Partial<", + "Capabilities", + ">" + ], + "path": "packages/core/capabilities/core-capabilities-server/src/capabilities.ts", + "deprecated": false, + "returnComment": [], + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesSwitcher", + "type": "Type", + "tags": [], + "label": "CapabilitiesSwitcher", + "description": [ + "\nSee {@link CapabilitiesSetup}" + ], + "signature": [ + "(request: ", + "KibanaRequest", + ", uiCapabilities: ", + "Capabilities", + ", useDefaultCapabilities: boolean) => ", + "MaybePromise", + ">" + ], + "path": "packages/core/capabilities/core-capabilities-server/src/capabilities.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesSwitcher.$1", + "type": "Object", + "tags": [], + "label": "request", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "packages/core/capabilities/core-capabilities-server/src/capabilities.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesSwitcher.$2", + "type": "Object", + "tags": [], + "label": "uiCapabilities", + "description": [], + "signature": [ + "Capabilities" + ], + "path": "packages/core/capabilities/core-capabilities-server/src/capabilities.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-capabilities-server", + "id": "def-server.CapabilitiesSwitcher.$3", + "type": "boolean", + "tags": [], + "label": "useDefaultCapabilities", + "description": [], + "path": "packages/core/capabilities/core-capabilities-server/src/capabilities.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_capabilities_server.mdx b/api_docs/kbn_core_capabilities_server.mdx new file mode 100644 index 0000000000000..0ef2fdedbf4f8 --- /dev/null +++ b/api_docs/kbn_core_capabilities_server.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnCoreCapabilitiesServerPluginApi +slug: /kibana-dev-docs/api/kbn-core-capabilities-server +title: "@kbn/core-capabilities-server" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-capabilities-server plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-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. +--- +import kbnCoreCapabilitiesServerObj from './kbn_core_capabilities_server.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 16 | 0 | 7 | 0 | + +## Server + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_capabilities_server_mocks.devdocs.json b/api_docs/kbn_core_capabilities_server_mocks.devdocs.json new file mode 100644 index 0000000000000..37811d92e9c94 --- /dev/null +++ b/api_docs/kbn_core_capabilities_server_mocks.devdocs.json @@ -0,0 +1,137 @@ +{ + "id": "@kbn/core-capabilities-server-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-capabilities-server-mocks", + "id": "def-server.CapabilitiesServiceContract", + "type": "Type", + "tags": [], + "label": "CapabilitiesServiceContract", + "description": [], + "signature": [ + "{ setup: (setupDeps: ", + "SetupDeps", + ") => ", + "CapabilitiesSetup", + "; start: () => ", + "CapabilitiesStart", + "; preboot: (prebootDeps: ", + "PrebootSetupDeps", + ") => void; }" + ], + "path": "packages/core/capabilities/core-capabilities-server-mocks/src/capabilities_service.mock.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [ + { + "parentPluginId": "@kbn/core-capabilities-server-mocks", + "id": "def-server.capabilitiesServiceMock", + "type": "Object", + "tags": [], + "label": "capabilitiesServiceMock", + "description": [], + "path": "packages/core/capabilities/core-capabilities-server-mocks/src/capabilities_service.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-capabilities-server-mocks", + "id": "def-server.capabilitiesServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => jest.Mocked<", + { + "pluginId": "@kbn/core-capabilities-server-mocks", + "scope": "server", + "docId": "kibKbnCoreCapabilitiesServerMocksPluginApi", + "section": "def-server.CapabilitiesServiceContract", + "text": "CapabilitiesServiceContract" + }, + ">" + ], + "path": "packages/core/capabilities/core-capabilities-server-mocks/src/capabilities_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-capabilities-server-mocks", + "id": "def-server.capabilitiesServiceMock.createSetupContract", + "type": "Function", + "tags": [], + "label": "createSetupContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "CapabilitiesSetup", + ">" + ], + "path": "packages/core/capabilities/core-capabilities-server-mocks/src/capabilities_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-capabilities-server-mocks", + "id": "def-server.capabilitiesServiceMock.createStartContract", + "type": "Function", + "tags": [], + "label": "createStartContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "CapabilitiesStart", + ">" + ], + "path": "packages/core/capabilities/core-capabilities-server-mocks/src/capabilities_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-capabilities-server-mocks", + "id": "def-server.capabilitiesServiceMock.createCapabilities", + "type": "Function", + "tags": [], + "label": "createCapabilities", + "description": [], + "signature": [ + "() => ", + "Capabilities" + ], + "path": "packages/core/capabilities/core-capabilities-server-mocks/src/capabilities_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_capabilities_server_mocks.mdx b/api_docs/kbn_core_capabilities_server_mocks.mdx new file mode 100644 index 0000000000000..438fb8a4198ad --- /dev/null +++ b/api_docs/kbn_core_capabilities_server_mocks.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnCoreCapabilitiesServerMocksPluginApi +slug: /kibana-dev-docs/api/kbn-core-capabilities-server-mocks +title: "@kbn/core-capabilities-server-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-capabilities-server-mocks plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-capabilities-server-mocks'] +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. +--- +import kbnCoreCapabilitiesServerMocksObj from './kbn_core_capabilities_server_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 6 | 0 | 6 | 0 | + +## Server + +### Objects + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_config_server_internal.mdx b/api_docs/kbn_core_config_server_internal.mdx index b3bef97d2a0b2..f1f63473f132b 100644 --- a/api_docs/kbn_core_config_server_internal.mdx +++ b/api_docs/kbn_core_config_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-config-server-internal title: "@kbn/core-config-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-config-server-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-config-server-internal'] 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. --- diff --git a/api_docs/kbn_core_deprecations_browser.mdx b/api_docs/kbn_core_deprecations_browser.mdx index a47eb8f892514..402a2673d31da 100644 --- a/api_docs/kbn_core_deprecations_browser.mdx +++ b/api_docs/kbn_core_deprecations_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser title: "@kbn/core-deprecations-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-deprecations-browser plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-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. --- diff --git a/api_docs/kbn_core_deprecations_browser_internal.mdx b/api_docs/kbn_core_deprecations_browser_internal.mdx index 6b70841c7c44f..d56ec1386375b 100644 --- a/api_docs/kbn_core_deprecations_browser_internal.mdx +++ b/api_docs/kbn_core_deprecations_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser-internal title: "@kbn/core-deprecations-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-deprecations-browser-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser-internal'] 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. --- diff --git a/api_docs/kbn_core_deprecations_browser_mocks.mdx b/api_docs/kbn_core_deprecations_browser_mocks.mdx index 12bcfdf0d9b0d..5cd088cda3565 100644 --- a/api_docs/kbn_core_deprecations_browser_mocks.mdx +++ b/api_docs/kbn_core_deprecations_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-browser-mocks title: "@kbn/core-deprecations-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-deprecations-browser-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-browser-mocks'] 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. --- diff --git a/api_docs/kbn_core_deprecations_common.mdx b/api_docs/kbn_core_deprecations_common.mdx index e6b4ba595ed11..8f875434ee3ee 100644 --- a/api_docs/kbn_core_deprecations_common.mdx +++ b/api_docs/kbn_core_deprecations_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-deprecations-common title: "@kbn/core-deprecations-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-deprecations-common plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-deprecations-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. --- diff --git a/api_docs/kbn_core_doc_links_browser.mdx b/api_docs/kbn_core_doc_links_browser.mdx index 0b432ea64e157..8135b6449d75a 100644 --- a/api_docs/kbn_core_doc_links_browser.mdx +++ b/api_docs/kbn_core_doc_links_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser title: "@kbn/core-doc-links-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-browser plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-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. --- diff --git a/api_docs/kbn_core_doc_links_browser_mocks.mdx b/api_docs/kbn_core_doc_links_browser_mocks.mdx index 58fc41442e071..6591ab3475132 100644 --- a/api_docs/kbn_core_doc_links_browser_mocks.mdx +++ b/api_docs/kbn_core_doc_links_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-browser-mocks title: "@kbn/core-doc-links-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-browser-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-browser-mocks'] 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. --- diff --git a/api_docs/kbn_core_doc_links_server.mdx b/api_docs/kbn_core_doc_links_server.mdx index c9473e051533a..5b3cf5ceb05c2 100644 --- a/api_docs/kbn_core_doc_links_server.mdx +++ b/api_docs/kbn_core_doc_links_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server title: "@kbn/core-doc-links-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-server plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-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. --- diff --git a/api_docs/kbn_core_doc_links_server_mocks.mdx b/api_docs/kbn_core_doc_links_server_mocks.mdx index 4bc5144dee9c5..270fae9a95975 100644 --- a/api_docs/kbn_core_doc_links_server_mocks.mdx +++ b/api_docs/kbn_core_doc_links_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-doc-links-server-mocks title: "@kbn/core-doc-links-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-doc-links-server-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-doc-links-server-mocks'] 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. --- diff --git a/api_docs/kbn_core_elasticsearch_client_server_internal.mdx b/api_docs/kbn_core_elasticsearch_client_server_internal.mdx index 436a19133c04d..872acc63d34c8 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_internal.mdx +++ b/api_docs/kbn_core_elasticsearch_client_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-client-server-internal title: "@kbn/core-elasticsearch-client-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-elasticsearch-client-server-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-client-server-internal'] 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. --- diff --git a/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json b/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json index 6c37dcaa78b83..e5f0d93daf2c9 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_client_server_mocks.devdocs.json @@ -323,22 +323,6 @@ "IndexRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; delete: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "server", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-server.ClientApiMockInstance", - "text": "ClientApiMockInstance" - }, - ", [params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptions", " | undefined]>; get: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -371,7 +355,7 @@ "UpdateRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; closePointInTime: ", + " | undefined]>; delete: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "server", @@ -380,11 +364,11 @@ "text": "ClientApiMockInstance" }, ", [params: ", - "ClosePointInTimeRequest", + "DeleteRequest", " | ", - "ClosePointInTimeRequest", + "DeleteRequest", ", options?: ", "TransportRequestOptions", " | undefined]>; [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: ", @@ -501,6 +485,22 @@ "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptions", + " | undefined]>; closePointInTime: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "server", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-server.ClientApiMockInstance", + "text": "ClientApiMockInstance" + }, + ", [params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptions", " | undefined]>; count: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -1431,22 +1431,6 @@ "IndexRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; delete: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "server", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-server.ClientApiMockInstance", - "text": "ClientApiMockInstance" - }, - ", [params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptions", " | undefined]>; get: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -1479,7 +1463,7 @@ "UpdateRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; closePointInTime: ", + " | undefined]>; delete: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "server", @@ -1488,11 +1472,11 @@ "text": "ClientApiMockInstance" }, ", [params: ", - "ClosePointInTimeRequest", + "DeleteRequest", " | ", - "ClosePointInTimeRequest", + "DeleteRequest", ", options?: ", "TransportRequestOptions", " | undefined]>; [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: ", @@ -1609,6 +1593,22 @@ "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptions", + " | undefined]>; closePointInTime: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "server", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-server.ClientApiMockInstance", + "text": "ClientApiMockInstance" + }, + ", [params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptions", " | undefined]>; count: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -2495,22 +2495,6 @@ "IndexRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; delete: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "server", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-server.ClientApiMockInstance", - "text": "ClientApiMockInstance" - }, - ", [params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptions", " | undefined]>; get: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -2543,7 +2527,7 @@ "UpdateRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; closePointInTime: ", + " | undefined]>; delete: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "server", @@ -2552,11 +2536,11 @@ "text": "ClientApiMockInstance" }, ", [params: ", - "ClosePointInTimeRequest", + "DeleteRequest", " | ", - "ClosePointInTimeRequest", + "DeleteRequest", ", options?: ", "TransportRequestOptions", " | undefined]>; [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: ", @@ -2673,6 +2657,22 @@ "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptions", + " | undefined]>; closePointInTime: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "server", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-server.ClientApiMockInstance", + "text": "ClientApiMockInstance" + }, + ", [params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptions", " | undefined]>; count: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -3624,22 +3624,6 @@ "IndexRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; delete: ", - { - "pluginId": "@kbn/core-elasticsearch-client-server-mocks", - "scope": "server", - "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", - "section": "def-server.ClientApiMockInstance", - "text": "ClientApiMockInstance" - }, - ", [params: ", - "DeleteRequest", - " | ", - "DeleteRequest", - ", options?: ", - "TransportRequestOptions", " | undefined]>; get: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", @@ -3672,7 +3656,7 @@ "UpdateRequest", ", options?: ", "TransportRequestOptions", - " | undefined]>; closePointInTime: ", + " | undefined]>; delete: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", "scope": "server", @@ -3681,11 +3665,11 @@ "text": "ClientApiMockInstance" }, ", [params: ", - "ClosePointInTimeRequest", + "DeleteRequest", " | ", - "ClosePointInTimeRequest", + "DeleteRequest", ", options?: ", "TransportRequestOptions", " | undefined]>; [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: ", @@ -3802,6 +3786,22 @@ "ClearScrollRequest", " | undefined, options?: ", "TransportRequestOptions", + " | undefined]>; closePointInTime: ", + { + "pluginId": "@kbn/core-elasticsearch-client-server-mocks", + "scope": "server", + "docId": "kibKbnCoreElasticsearchClientServerMocksPluginApi", + "section": "def-server.ClientApiMockInstance", + "text": "ClientApiMockInstance" + }, + ", [params: ", + "ClosePointInTimeRequest", + " | ", + "ClosePointInTimeRequest", + ", options?: ", + "TransportRequestOptions", " | undefined]>; count: ", { "pluginId": "@kbn/core-elasticsearch-client-server-mocks", diff --git a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx index 3f8bdb1ccc5e7..03e1d07deb05d 100644 --- a/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx +++ b/api_docs/kbn_core_elasticsearch_client_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-client-server-mocks title: "@kbn/core-elasticsearch-client-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-elasticsearch-client-server-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-client-server-mocks'] 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. --- diff --git a/api_docs/kbn_core_elasticsearch_server.devdocs.json b/api_docs/kbn_core_elasticsearch_server.devdocs.json index c15c677a756a6..331ea6389ce5d 100644 --- a/api_docs/kbn_core_elasticsearch_server.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_server.devdocs.json @@ -800,7 +800,7 @@ "Headers used for authentication against Elasticsearch" ], "signature": [ - "{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; connection?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "packages/core/elasticsearch/core-elasticsearch-server/src/client/scopeable_request.ts", "deprecated": false @@ -924,32 +924,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: { (this: That, params: ", "GetRequest", " | ", @@ -1002,32 +976,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -1098,6 +1072,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", " | ", @@ -2515,32 +2515,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: { (this: That, params: ", "GetRequest", " | ", @@ -2593,32 +2567,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -2689,6 +2663,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", " | ", @@ -3718,32 +3718,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: { (this: That, params: ", "GetRequest", " | ", @@ -3796,32 +3770,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -3892,6 +3866,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", " | ", @@ -5155,32 +5155,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: { (this: That, params: ", "GetRequest", " | ", @@ -5233,32 +5207,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -5329,6 +5303,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", " | ", diff --git a/api_docs/kbn_core_elasticsearch_server.mdx b/api_docs/kbn_core_elasticsearch_server.mdx index 38c2f52355da8..2f2c3281f04bd 100644 --- a/api_docs/kbn_core_elasticsearch_server.mdx +++ b/api_docs/kbn_core_elasticsearch_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server title: "@kbn/core-elasticsearch-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-elasticsearch-server plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-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. --- diff --git a/api_docs/kbn_core_elasticsearch_server_internal.devdocs.json b/api_docs/kbn_core_elasticsearch_server_internal.devdocs.json index 5575c998117a1..ba4100d6fd35d 100644 --- a/api_docs/kbn_core_elasticsearch_server_internal.devdocs.json +++ b/api_docs/kbn_core_elasticsearch_server_internal.devdocs.json @@ -138,32 +138,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: { (this: That, params: ", "GetRequest", " | ", @@ -216,32 +190,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -312,6 +286,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", " | ", @@ -1697,32 +1697,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: { (this: That, params: ", "GetRequest", " | ", @@ -1775,32 +1749,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -1871,6 +1845,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", " | ", diff --git a/api_docs/kbn_core_elasticsearch_server_internal.mdx b/api_docs/kbn_core_elasticsearch_server_internal.mdx index 8a67fafb0847a..32aa28f037034 100644 --- a/api_docs/kbn_core_elasticsearch_server_internal.mdx +++ b/api_docs/kbn_core_elasticsearch_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server-internal title: "@kbn/core-elasticsearch-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-elasticsearch-server-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server-internal'] 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. --- diff --git a/api_docs/kbn_core_elasticsearch_server_mocks.mdx b/api_docs/kbn_core_elasticsearch_server_mocks.mdx index d9330e1d085b9..e1305231fd86f 100644 --- a/api_docs/kbn_core_elasticsearch_server_mocks.mdx +++ b/api_docs/kbn_core_elasticsearch_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-elasticsearch-server-mocks title: "@kbn/core-elasticsearch-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-elasticsearch-server-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-elasticsearch-server-mocks'] 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. --- diff --git a/api_docs/kbn_core_environment_server_internal.mdx b/api_docs/kbn_core_environment_server_internal.mdx index c58cc1053a9e9..5f3b3dedba8b1 100644 --- a/api_docs/kbn_core_environment_server_internal.mdx +++ b/api_docs/kbn_core_environment_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-internal title: "@kbn/core-environment-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-environment-server-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-internal'] 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. --- diff --git a/api_docs/kbn_core_environment_server_mocks.mdx b/api_docs/kbn_core_environment_server_mocks.mdx index ba32b3a98898d..c18857d678c54 100644 --- a/api_docs/kbn_core_environment_server_mocks.mdx +++ b/api_docs/kbn_core_environment_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-environment-server-mocks title: "@kbn/core-environment-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-environment-server-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-environment-server-mocks'] 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. --- diff --git a/api_docs/kbn_core_execution_context_browser.mdx b/api_docs/kbn_core_execution_context_browser.mdx index 4b716b687e5d6..1234f34f818c0 100644 --- a/api_docs/kbn_core_execution_context_browser.mdx +++ b/api_docs/kbn_core_execution_context_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser title: "@kbn/core-execution-context-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-browser plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-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. --- diff --git a/api_docs/kbn_core_execution_context_browser_internal.devdocs.json b/api_docs/kbn_core_execution_context_browser_internal.devdocs.json index 7bc848490a036..72626e343b23a 100644 --- a/api_docs/kbn_core_execution_context_browser_internal.devdocs.json +++ b/api_docs/kbn_core_execution_context_browser_internal.devdocs.json @@ -47,7 +47,7 @@ "label": "#context", "description": [], "signature": [ - "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; readonly child?: ", + "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; readonly meta?: { [key: string]: string | number | boolean | undefined; } | undefined; readonly child?: ", "KibanaExecutionContext", " | undefined; }" ], diff --git a/api_docs/kbn_core_execution_context_browser_internal.mdx b/api_docs/kbn_core_execution_context_browser_internal.mdx index f98309a462f02..f6382eecb79bf 100644 --- a/api_docs/kbn_core_execution_context_browser_internal.mdx +++ b/api_docs/kbn_core_execution_context_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-internal title: "@kbn/core-execution-context-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-browser-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-internal'] 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. --- diff --git a/api_docs/kbn_core_execution_context_browser_mocks.mdx b/api_docs/kbn_core_execution_context_browser_mocks.mdx index 57bbe5df972d0..ead5c20f09ad7 100644 --- a/api_docs/kbn_core_execution_context_browser_mocks.mdx +++ b/api_docs/kbn_core_execution_context_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-browser-mocks title: "@kbn/core-execution-context-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-browser-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-browser-mocks'] 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. --- diff --git a/api_docs/kbn_core_execution_context_common.devdocs.json b/api_docs/kbn_core_execution_context_common.devdocs.json index 0eeebd595e2d2..f36622e9e38f5 100644 --- a/api_docs/kbn_core_execution_context_common.devdocs.json +++ b/api_docs/kbn_core_execution_context_common.devdocs.json @@ -30,7 +30,7 @@ "label": "KibanaExecutionContext", "description": [], "signature": [ - "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; child?: ", + "{ readonly type?: string | undefined; readonly name?: string | undefined; readonly page?: string | undefined; readonly id?: string | undefined; readonly description?: string | undefined; readonly url?: string | undefined; readonly meta?: { [key: string]: string | number | boolean | undefined; } | undefined; child?: ", { "pluginId": "@kbn/core-execution-context-common", "scope": "common", diff --git a/api_docs/kbn_core_execution_context_common.mdx b/api_docs/kbn_core_execution_context_common.mdx index 6e01ae5e7e51c..321e8af9e7f31 100644 --- a/api_docs/kbn_core_execution_context_common.mdx +++ b/api_docs/kbn_core_execution_context_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-common title: "@kbn/core-execution-context-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-common plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-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. --- diff --git a/api_docs/kbn_core_execution_context_server.mdx b/api_docs/kbn_core_execution_context_server.mdx index 95f6819b84693..150daf6cbbd96 100644 --- a/api_docs/kbn_core_execution_context_server.mdx +++ b/api_docs/kbn_core_execution_context_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server title: "@kbn/core-execution-context-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-server plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-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. --- diff --git a/api_docs/kbn_core_execution_context_server_internal.mdx b/api_docs/kbn_core_execution_context_server_internal.mdx index 97bb66d9bc69d..0b81f8c66a22f 100644 --- a/api_docs/kbn_core_execution_context_server_internal.mdx +++ b/api_docs/kbn_core_execution_context_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-internal title: "@kbn/core-execution-context-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-server-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-internal'] 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. --- diff --git a/api_docs/kbn_core_execution_context_server_mocks.mdx b/api_docs/kbn_core_execution_context_server_mocks.mdx index c2cc546cb0054..ad072f7120db1 100644 --- a/api_docs/kbn_core_execution_context_server_mocks.mdx +++ b/api_docs/kbn_core_execution_context_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-execution-context-server-mocks title: "@kbn/core-execution-context-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-execution-context-server-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-execution-context-server-mocks'] 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. --- diff --git a/api_docs/kbn_core_fatal_errors_browser.mdx b/api_docs/kbn_core_fatal_errors_browser.mdx index 468fc9c786f5a..c91efd06903ca 100644 --- a/api_docs/kbn_core_fatal_errors_browser.mdx +++ b/api_docs/kbn_core_fatal_errors_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser title: "@kbn/core-fatal-errors-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-fatal-errors-browser plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-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. --- diff --git a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx index 34ecaaf215d48..b2c2bf1fa59d9 100644 --- a/api_docs/kbn_core_fatal_errors_browser_mocks.mdx +++ b/api_docs/kbn_core_fatal_errors_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-fatal-errors-browser-mocks title: "@kbn/core-fatal-errors-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-fatal-errors-browser-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-fatal-errors-browser-mocks'] 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. --- diff --git a/api_docs/kbn_core_http_browser.mdx b/api_docs/kbn_core_http_browser.mdx index f09b679fd8875..1330e5b1b8536 100644 --- a/api_docs/kbn_core_http_browser.mdx +++ b/api_docs/kbn_core_http_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser title: "@kbn/core-http-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-http-browser plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-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. --- diff --git a/api_docs/kbn_core_http_browser_internal.mdx b/api_docs/kbn_core_http_browser_internal.mdx index 14c498bf34609..17e727209a675 100644 --- a/api_docs/kbn_core_http_browser_internal.mdx +++ b/api_docs/kbn_core_http_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser-internal title: "@kbn/core-http-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-http-browser-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-internal'] 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. --- diff --git a/api_docs/kbn_core_http_browser_mocks.mdx b/api_docs/kbn_core_http_browser_mocks.mdx index e258b08d0246a..f8714cc556e16 100644 --- a/api_docs/kbn_core_http_browser_mocks.mdx +++ b/api_docs/kbn_core_http_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-browser-mocks title: "@kbn/core-http-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-http-browser-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-browser-mocks'] 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. --- diff --git a/api_docs/kbn_core_http_common.mdx b/api_docs/kbn_core_http_common.mdx index 8686433f0f5eb..ab962f7e6d5f1 100644 --- a/api_docs/kbn_core_http_common.mdx +++ b/api_docs/kbn_core_http_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-common title: "@kbn/core-http-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-http-common plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-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. --- diff --git a/api_docs/kbn_core_http_context_server_mocks.mdx b/api_docs/kbn_core_http_context_server_mocks.mdx index 1ca4e94e9e68f..0b8deb3341f79 100644 --- a/api_docs/kbn_core_http_context_server_mocks.mdx +++ b/api_docs/kbn_core_http_context_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-context-server-mocks title: "@kbn/core-http-context-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-http-context-server-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-context-server-mocks'] 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. --- diff --git a/api_docs/kbn_core_http_router_server_internal.mdx b/api_docs/kbn_core_http_router_server_internal.mdx index aed723b666999..c053d1b9479bb 100644 --- a/api_docs/kbn_core_http_router_server_internal.mdx +++ b/api_docs/kbn_core_http_router_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-router-server-internal title: "@kbn/core-http-router-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-http-router-server-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-router-server-internal'] 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. --- diff --git a/api_docs/kbn_core_http_router_server_mocks.mdx b/api_docs/kbn_core_http_router_server_mocks.mdx index 410841cb60b0e..1ac3604e56fae 100644 --- a/api_docs/kbn_core_http_router_server_mocks.mdx +++ b/api_docs/kbn_core_http_router_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-router-server-mocks title: "@kbn/core-http-router-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-http-router-server-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-router-server-mocks'] 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. --- diff --git a/api_docs/kbn_core_http_server.devdocs.json b/api_docs/kbn_core_http_server.devdocs.json index b0aada7f2e20b..97a0dd3ec3e50 100644 --- a/api_docs/kbn_core_http_server.devdocs.json +++ b/api_docs/kbn_core_http_server.devdocs.json @@ -4073,7 +4073,7 @@ "\nReadonly copy of incoming request headers." ], "signature": [ - "{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; connection?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "packages/core/http/core-http-server/src/router/request.ts", "deprecated": false @@ -6764,7 +6764,7 @@ "\nHttp request headers to read." ], "signature": [ - "{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; connection?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" + "{ from?: string | string[] | undefined; origin?: string | string[] | undefined; warning?: string | string[] | undefined; location?: string | string[] | undefined; date?: string | string[] | undefined; expires?: string | string[] | undefined; range?: string | string[] | undefined; allow?: string | string[] | undefined; accept?: string | string[] | undefined; host?: string | string[] | undefined; etag?: string | string[] | undefined; authorization?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; expect?: string | string[] | undefined; forwarded?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }" ], "path": "packages/core/http/core-http-server/src/router/headers.ts", "deprecated": false, @@ -7029,7 +7029,7 @@ "\nSet of well-known HTTP headers." ], "signature": [ - "\"from\" | \"origin\" | \"warning\" | \"location\" | \"date\" | \"expires\" | \"range\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"connection\" | \"authorization\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" + "\"from\" | \"origin\" | \"warning\" | \"location\" | \"date\" | \"expires\" | \"range\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\"" ], "path": "packages/core/http/core-http-server/src/router/headers.ts", "deprecated": false, @@ -8075,7 +8075,7 @@ "\nHttp response headers to set." ], "signature": [ - "Record<\"from\" | \"origin\" | \"warning\" | \"location\" | \"date\" | \"expires\" | \"range\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"connection\" | \"authorization\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" + "Record<\"from\" | \"origin\" | \"warning\" | \"location\" | \"date\" | \"expires\" | \"range\" | \"allow\" | \"accept\" | \"host\" | \"etag\" | \"authorization\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"alt-svc\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"expect\" | \"forwarded\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"www-authenticate\", string | string[]> | Record" ], "path": "packages/core/http/core-http-server/src/router/headers.ts", "deprecated": false, diff --git a/api_docs/kbn_core_http_server.mdx b/api_docs/kbn_core_http_server.mdx index c379244d786c1..1703c0d7e1186 100644 --- a/api_docs/kbn_core_http_server.mdx +++ b/api_docs/kbn_core_http_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server title: "@kbn/core-http-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-http-server plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-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. --- diff --git a/api_docs/kbn_core_http_server_internal.mdx b/api_docs/kbn_core_http_server_internal.mdx index 95b48e48c4159..01d774a72bcd6 100644 --- a/api_docs/kbn_core_http_server_internal.mdx +++ b/api_docs/kbn_core_http_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server-internal title: "@kbn/core-http-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-http-server-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server-internal'] 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. --- diff --git a/api_docs/kbn_core_http_server_mocks.devdocs.json b/api_docs/kbn_core_http_server_mocks.devdocs.json index bdbc8ce677929..6dbdb8ddceb1f 100644 --- a/api_docs/kbn_core_http_server_mocks.devdocs.json +++ b/api_docs/kbn_core_http_server_mocks.devdocs.json @@ -125,7 +125,13 @@ "signature": [ "{ csp: ", "ICspConfig", - "; createCookieSessionStorageFactory: jest.MockInstance, provider: ", + "IContextProvider", + ">]>; getServerInfo: jest.MockInstance<", + "HttpServerInfo", + ", []>; createCookieSessionStorageFactory: jest.MockInstance>, [cookieOptions: ", "SessionStorageCookieOptions", @@ -139,13 +145,7 @@ "OnPostAuthHandler", "]>; registerOnPreResponse: jest.MockInstance; getServerInfo: jest.MockInstance<", - "HttpServerInfo", - ", []>; registerRouteHandlerContext: jest.MockInstance<", - "IContextContainer", - ", [contextName: Exclude, provider: ", - "IContextProvider", - ">]>; } & Omit<", + "]>; } & Omit<", "HttpServiceSetup", ", \"basePath\" | \"createRouter\"> & { basePath: BasePathMocked; createRouter: jest.MockedFunction<() => ", "RouterMock", @@ -193,13 +193,13 @@ "ExternalUrlConfig", "; csp: ", "ICspConfig", - "; registerStaticDir: jest.MockInstance; getServerInfo: jest.MockInstance<", - "HttpServerInfo", - ", []>; registerRouteHandlerContext: jest.MockInstance; registerRouteHandlerContext: jest.MockInstance]>; registerRoutes: jest.MockInstance]>; getServerInfo: jest.MockInstance<", + "HttpServerInfo", + ", []>; registerRoutes: jest.MockInstance; registerRouteHandlerContext: jest.MockInstance]>; registerStaticDir: jest.MockInstance; createCookieSessionStorageFactory: jest.MockInstance]>; getServerInfo: jest.MockInstance<", + "HttpServerInfo", + ", []>; createCookieSessionStorageFactory: jest.MockInstance>, [cookieOptions: ", "SessionStorageCookieOptions", @@ -243,19 +245,17 @@ "OnPostAuthHandler", "]>; registerOnPreResponse: jest.MockInstance; getServerInfo: jest.MockInstance<", - "HttpServerInfo", - ", []>; registerRouteHandlerContext: jest.MockInstance; registerRouterAfterListening: jest.MockInstance]>; registerPrebootRoutes: jest.MockInstance]>; registerPrebootRoutes: jest.MockInstance) => void]>; } & Omit<", "InternalHttpServiceSetup", - ", \"basePath\" | \"auth\" | \"authRequestHeaders\" | \"createRouter\"> & { auth: AuthMocked; basePath: BasePathMocked; createRouter: jest.MockedFunction<(path: string) => ", + ", \"basePath\" | \"auth\" | \"createRouter\" | \"authRequestHeaders\"> & { auth: AuthMocked; basePath: BasePathMocked; createRouter: jest.MockedFunction<(path: string) => ", "RouterMock", ">; authRequestHeaders: jest.Mocked<", "IAuthHeadersStorage", diff --git a/api_docs/kbn_core_http_server_mocks.mdx b/api_docs/kbn_core_http_server_mocks.mdx index c14b440bd5756..21fd073c2f7b8 100644 --- a/api_docs/kbn_core_http_server_mocks.mdx +++ b/api_docs/kbn_core_http_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-http-server-mocks title: "@kbn/core-http-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-http-server-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-http-server-mocks'] 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. --- diff --git a/api_docs/kbn_core_i18n_browser.mdx b/api_docs/kbn_core_i18n_browser.mdx index fac0f7abc9f2e..4ecee243d3b28 100644 --- a/api_docs/kbn_core_i18n_browser.mdx +++ b/api_docs/kbn_core_i18n_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser title: "@kbn/core-i18n-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-i18n-browser plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-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. --- diff --git a/api_docs/kbn_core_i18n_browser_mocks.mdx b/api_docs/kbn_core_i18n_browser_mocks.mdx index d8c92a67a846a..f3eae8adaf4bc 100644 --- a/api_docs/kbn_core_i18n_browser_mocks.mdx +++ b/api_docs/kbn_core_i18n_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-i18n-browser-mocks title: "@kbn/core-i18n-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-i18n-browser-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-i18n-browser-mocks'] 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. --- diff --git a/api_docs/kbn_core_injected_metadata_browser.mdx b/api_docs/kbn_core_injected_metadata_browser.mdx index d0d1c3bf2b36e..5bd122f200aaa 100644 --- a/api_docs/kbn_core_injected_metadata_browser.mdx +++ b/api_docs/kbn_core_injected_metadata_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser title: "@kbn/core-injected-metadata-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-injected-metadata-browser plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-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. --- diff --git a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx index 1dae921f02232..4f14d0ee725e1 100644 --- a/api_docs/kbn_core_injected_metadata_browser_mocks.mdx +++ b/api_docs/kbn_core_injected_metadata_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-injected-metadata-browser-mocks title: "@kbn/core-injected-metadata-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-injected-metadata-browser-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-injected-metadata-browser-mocks'] 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. --- diff --git a/api_docs/kbn_core_integrations_browser_internal.mdx b/api_docs/kbn_core_integrations_browser_internal.mdx index 0bf09bb15b09f..3c06aa70442bf 100644 --- a/api_docs/kbn_core_integrations_browser_internal.mdx +++ b/api_docs/kbn_core_integrations_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-integrations-browser-internal title: "@kbn/core-integrations-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-integrations-browser-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-integrations-browser-internal'] 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. --- diff --git a/api_docs/kbn_core_integrations_browser_mocks.mdx b/api_docs/kbn_core_integrations_browser_mocks.mdx index 803a0bc51525e..30b455e352ce0 100644 --- a/api_docs/kbn_core_integrations_browser_mocks.mdx +++ b/api_docs/kbn_core_integrations_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-integrations-browser-mocks title: "@kbn/core-integrations-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-integrations-browser-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-integrations-browser-mocks'] 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. --- diff --git a/api_docs/kbn_core_logging_server.mdx b/api_docs/kbn_core_logging_server.mdx index d5e90ad7448cb..59e59032dc434 100644 --- a/api_docs/kbn_core_logging_server.mdx +++ b/api_docs/kbn_core_logging_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server title: "@kbn/core-logging-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-logging-server plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-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. --- diff --git a/api_docs/kbn_core_logging_server_internal.mdx b/api_docs/kbn_core_logging_server_internal.mdx index bc3703794a115..147cac4aae4be 100644 --- a/api_docs/kbn_core_logging_server_internal.mdx +++ b/api_docs/kbn_core_logging_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-internal title: "@kbn/core-logging-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-logging-server-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-internal'] 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. --- diff --git a/api_docs/kbn_core_logging_server_mocks.mdx b/api_docs/kbn_core_logging_server_mocks.mdx index e70c8136502ef..644777382ef52 100644 --- a/api_docs/kbn_core_logging_server_mocks.mdx +++ b/api_docs/kbn_core_logging_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-logging-server-mocks title: "@kbn/core-logging-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-logging-server-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-logging-server-mocks'] 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. --- diff --git a/api_docs/kbn_core_metrics_collectors_server_internal.devdocs.json b/api_docs/kbn_core_metrics_collectors_server_internal.devdocs.json new file mode 100644 index 0000000000000..e22f71676bf31 --- /dev/null +++ b/api_docs/kbn_core_metrics_collectors_server_internal.devdocs.json @@ -0,0 +1,455 @@ +{ + "id": "@kbn/core-metrics-collectors-server-internal", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.EventLoopDelaysMonitor", + "type": "Class", + "tags": [], + "label": "EventLoopDelaysMonitor", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-metrics-collectors-server-internal", + "scope": "server", + "docId": "kibKbnCoreMetricsCollectorsServerInternalPluginApi", + "section": "def-server.EventLoopDelaysMonitor", + "text": "EventLoopDelaysMonitor" + }, + " implements ", + "IEventLoopDelaysMonitor", + "<", + "IntervalHistogram", + ">" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/event_loop_delays_monitor.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.EventLoopDelaysMonitor.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [ + "\nCreating a new instance from EventLoopDelaysMonitor will\nautomatically start tracking event loop delays." + ], + "signature": [ + "any" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/event_loop_delays_monitor.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.EventLoopDelaysMonitor.collect", + "type": "Function", + "tags": [], + "label": "collect", + "description": [ + "\nCollect gathers event loop delays metrics from nodejs perf_hooks.monitorEventLoopDelay\nthe histogram calculations start from the last time `reset` was called or this\nEventLoopDelaysMonitor instance was created.\n\nReturns metrics in milliseconds." + ], + "signature": [ + "() => ", + "IntervalHistogram" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/event_loop_delays_monitor.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.EventLoopDelaysMonitor.reset", + "type": "Function", + "tags": [], + "label": "reset", + "description": [ + "\nResets the collected histogram data." + ], + "signature": [ + "() => void" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/event_loop_delays_monitor.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.EventLoopDelaysMonitor.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [ + "\nDisables updating the interval timer for collecting new data points." + ], + "signature": [ + "() => void" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/event_loop_delays_monitor.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.OsMetricsCollector", + "type": "Class", + "tags": [], + "label": "OsMetricsCollector", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-metrics-collectors-server-internal", + "scope": "server", + "docId": "kibKbnCoreMetricsCollectorsServerInternalPluginApi", + "section": "def-server.OsMetricsCollector", + "text": "OsMetricsCollector" + }, + " implements ", + "MetricsCollector", + "<", + "OpsOsMetrics", + ">" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/os.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.OsMetricsCollector.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/os.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.OsMetricsCollector.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-metrics-collectors-server-internal", + "scope": "server", + "docId": "kibKbnCoreMetricsCollectorsServerInternalPluginApi", + "section": "def-server.OpsMetricsCollectorOptions", + "text": "OpsMetricsCollectorOptions" + } + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/os.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.OsMetricsCollector.collect", + "type": "Function", + "tags": [], + "label": "collect", + "description": [], + "signature": [ + "() => Promise<", + "OpsOsMetrics", + ">" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/os.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.OsMetricsCollector.reset", + "type": "Function", + "tags": [], + "label": "reset", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/os.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.ProcessMetricsCollector", + "type": "Class", + "tags": [], + "label": "ProcessMetricsCollector", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-metrics-collectors-server-internal", + "scope": "server", + "docId": "kibKbnCoreMetricsCollectorsServerInternalPluginApi", + "section": "def-server.ProcessMetricsCollector", + "text": "ProcessMetricsCollector" + }, + " implements ", + "MetricsCollector", + "<", + "OpsProcessMetrics", + "[]>" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/process.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.ProcessMetricsCollector.getMainThreadMetrics", + "type": "Function", + "tags": [], + "label": "getMainThreadMetrics", + "description": [], + "signature": [ + "(processes: ", + "OpsProcessMetrics", + "[]) => ", + "OpsProcessMetrics", + " | undefined" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/process.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.ProcessMetricsCollector.getMainThreadMetrics.$1", + "type": "Array", + "tags": [], + "label": "processes", + "description": [], + "signature": [ + "OpsProcessMetrics", + "[]" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/process.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.ProcessMetricsCollector.collect", + "type": "Function", + "tags": [], + "label": "collect", + "description": [], + "signature": [ + "() => ", + "OpsProcessMetrics", + "[]" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/process.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.ProcessMetricsCollector.reset", + "type": "Function", + "tags": [], + "label": "reset", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/process.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.ServerMetricsCollector", + "type": "Class", + "tags": [], + "label": "ServerMetricsCollector", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-metrics-collectors-server-internal", + "scope": "server", + "docId": "kibKbnCoreMetricsCollectorsServerInternalPluginApi", + "section": "def-server.ServerMetricsCollector", + "text": "ServerMetricsCollector" + }, + " implements ", + "MetricsCollector", + "<", + "OpsServerMetrics", + ">" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/server.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.ServerMetricsCollector.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/server.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.ServerMetricsCollector.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "server", + "description": [], + "signature": [ + "Server" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/server.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.ServerMetricsCollector.collect", + "type": "Function", + "tags": [], + "label": "collect", + "description": [], + "signature": [ + "() => Promise<", + "OpsServerMetrics", + ">" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/server.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.ServerMetricsCollector.reset", + "type": "Function", + "tags": [], + "label": "reset", + "description": [], + "signature": [ + "() => void" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/server.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.OpsMetricsCollectorOptions", + "type": "Interface", + "tags": [], + "label": "OpsMetricsCollectorOptions", + "description": [], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/os.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.OpsMetricsCollectorOptions.logger", + "type": "Object", + "tags": [], + "label": "logger", + "description": [], + "signature": [ + "Logger" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/os.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.OpsMetricsCollectorOptions.cpuPath", + "type": "string", + "tags": [], + "label": "cpuPath", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/os.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-internal", + "id": "def-server.OpsMetricsCollectorOptions.cpuAcctPath", + "type": "string", + "tags": [], + "label": "cpuAcctPath", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-internal/src/os.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_metrics_collectors_server_internal.mdx b/api_docs/kbn_core_metrics_collectors_server_internal.mdx new file mode 100644 index 0000000000000..1481a0f9900b0 --- /dev/null +++ b/api_docs/kbn_core_metrics_collectors_server_internal.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnCoreMetricsCollectorsServerInternalPluginApi +slug: /kibana-dev-docs/api/kbn-core-metrics-collectors-server-internal +title: "@kbn/core-metrics-collectors-server-internal" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-metrics-collectors-server-internal plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-collectors-server-internal'] +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. +--- +import kbnCoreMetricsCollectorsServerInternalObj from './kbn_core_metrics_collectors_server_internal.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 24 | 0 | 20 | 0 | + +## Server + +### Classes + + +### Interfaces + + diff --git a/api_docs/kbn_core_metrics_collectors_server_mocks.devdocs.json b/api_docs/kbn_core_metrics_collectors_server_mocks.devdocs.json new file mode 100644 index 0000000000000..e38bef1494054 --- /dev/null +++ b/api_docs/kbn_core_metrics_collectors_server_mocks.devdocs.json @@ -0,0 +1,197 @@ +{ + "id": "@kbn/core-metrics-collectors-server-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-mocks", + "id": "def-server.createMockOpsProcessMetrics", + "type": "Function", + "tags": [], + "label": "createMockOpsProcessMetrics", + "description": [], + "signature": [ + "() => ", + "OpsProcessMetrics" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-mocks/src/process.mocks.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-mocks", + "id": "def-server.collectorMock", + "type": "Object", + "tags": [], + "label": "collectorMock", + "description": [], + "path": "packages/core/metrics/core-metrics-collectors-server-mocks/src/mocks.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-mocks", + "id": "def-server.collectorMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => jest.Mocked<", + "MetricsCollector", + ">" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-mocks/src/mocks.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-mocks", + "id": "def-server.collectorMock.createOpsProcessMetrics", + "type": "Function", + "tags": [], + "label": "createOpsProcessMetrics", + "description": [], + "signature": [ + "() => ", + "OpsProcessMetrics" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-mocks/src/mocks.ts", + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-mocks", + "id": "def-server.metricsCollectorMock", + "type": "Object", + "tags": [], + "label": "metricsCollectorMock", + "description": [], + "path": "packages/core/metrics/core-metrics-collectors-server-mocks/src/collector.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-mocks", + "id": "def-server.metricsCollectorMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "(collectReturnValue?: any) => jest.Mocked<", + "MetricsCollector", + ">" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-mocks/src/collector.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-mocks", + "id": "def-server.metricsCollectorMock.create.$1", + "type": "Any", + "tags": [], + "label": "collectReturnValue", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-mocks/src/collector.mock.ts", + "deprecated": false + } + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-mocks", + "id": "def-server.mocked", + "type": "Object", + "tags": [], + "label": "mocked", + "description": [], + "path": "packages/core/metrics/core-metrics-collectors-server-mocks/src/event_loop_delays_monitor.mocks.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-mocks", + "id": "def-server.mocked.createHistogram", + "type": "Function", + "tags": [], + "label": "createHistogram", + "description": [], + "signature": [ + "(overwrites?: Partial<", + "IntervalHistogram", + ">) => ", + "IntervalHistogram" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-mocks/src/event_loop_delays_monitor.mocks.ts", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/core-metrics-collectors-server-mocks", + "id": "def-server.mocked.createHistogram.$1", + "type": "Object", + "tags": [], + "label": "overwrites", + "description": [], + "signature": [ + "{ fromTimestamp?: string | undefined; lastUpdatedAt?: string | undefined; min?: number | undefined; max?: number | undefined; mean?: number | undefined; exceeds?: number | undefined; stddev?: number | undefined; percentiles?: { 50: number; 75: number; 95: number; 99: number; } | undefined; }" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-mocks/src/event_loop_delays_monitor.mocks.ts", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/core-metrics-collectors-server-mocks", + "id": "def-server.mocked.createEventLoopDelaysMonitor", + "type": "Function", + "tags": [], + "label": "createEventLoopDelaysMonitor", + "description": [], + "signature": [ + "() => ", + "EventLoopDelaysMonitor" + ], + "path": "packages/core/metrics/core-metrics-collectors-server-mocks/src/event_loop_delays_monitor.mocks.ts", + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_metrics_collectors_server_mocks.mdx b/api_docs/kbn_core_metrics_collectors_server_mocks.mdx new file mode 100644 index 0000000000000..fbf45aab331b7 --- /dev/null +++ b/api_docs/kbn_core_metrics_collectors_server_mocks.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnCoreMetricsCollectorsServerMocksPluginApi +slug: /kibana-dev-docs/api/kbn-core-metrics-collectors-server-mocks +title: "@kbn/core-metrics-collectors-server-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-metrics-collectors-server-mocks plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-collectors-server-mocks'] +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. +--- +import kbnCoreMetricsCollectorsServerMocksObj from './kbn_core_metrics_collectors_server_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 11 | 1 | 11 | 0 | + +## Server + +### Objects + + +### Functions + + diff --git a/api_docs/kbn_core_metrics_server.devdocs.json b/api_docs/kbn_core_metrics_server.devdocs.json new file mode 100644 index 0000000000000..2f49db00dc608 --- /dev/null +++ b/api_docs/kbn_core_metrics_server.devdocs.json @@ -0,0 +1,768 @@ +{ + "id": "@kbn/core-metrics-server", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.IEventLoopDelaysMonitor", + "type": "Interface", + "tags": [], + "label": "IEventLoopDelaysMonitor", + "description": [ + "\nCreating a new instance from EventLoopDelaysMonitor will\nautomatically start tracking event loop delays.\nSee {@link IntervalHistogram}" + ], + "signature": [ + { + "pluginId": "@kbn/core-metrics-server", + "scope": "server", + "docId": "kibKbnCoreMetricsServerPluginApi", + "section": "def-server.IEventLoopDelaysMonitor", + "text": "IEventLoopDelaysMonitor" + }, + "" + ], + "path": "packages/core/metrics/core-metrics-server/src/collectors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.IEventLoopDelaysMonitor.collect", + "type": "Function", + "tags": [], + "label": "collect", + "description": [ + "\nCollect gathers event loop delays metrics from nodejs perf_hooks.monitorEventLoopDelay\nthe histogram calculations start from the last time `reset` was called or this\nEventLoopDelaysMonitor instance was created.\n\nReturns metrics in milliseconds." + ], + "signature": [ + "() => T" + ], + "path": "packages/core/metrics/core-metrics-server/src/collectors.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.IEventLoopDelaysMonitor.reset", + "type": "Function", + "tags": [], + "label": "reset", + "description": [ + "\nResets the collected histogram data." + ], + "signature": [ + "() => void" + ], + "path": "packages/core/metrics/core-metrics-server/src/collectors.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.IEventLoopDelaysMonitor.stop", + "type": "Function", + "tags": [], + "label": "stop", + "description": [ + "\nDisables updating the interval timer for collecting new data points." + ], + "signature": [ + "() => void" + ], + "path": "packages/core/metrics/core-metrics-server/src/collectors.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.IntervalHistogram", + "type": "Interface", + "tags": [], + "label": "IntervalHistogram", + "description": [ + "\nan IntervalHistogram object that samples and reports the event loop delay over time.\nThe delays will be reported in milliseconds.\n" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.IntervalHistogram.fromTimestamp", + "type": "string", + "tags": [], + "label": "fromTimestamp", + "description": [], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.IntervalHistogram.lastUpdatedAt", + "type": "string", + "tags": [], + "label": "lastUpdatedAt", + "description": [], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.IntervalHistogram.min", + "type": "number", + "tags": [], + "label": "min", + "description": [], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.IntervalHistogram.max", + "type": "number", + "tags": [], + "label": "max", + "description": [], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.IntervalHistogram.mean", + "type": "number", + "tags": [], + "label": "mean", + "description": [], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.IntervalHistogram.exceeds", + "type": "number", + "tags": [], + "label": "exceeds", + "description": [], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.IntervalHistogram.stddev", + "type": "number", + "tags": [], + "label": "stddev", + "description": [], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.IntervalHistogram.percentiles", + "type": "Object", + "tags": [], + "label": "percentiles", + "description": [], + "signature": [ + "{ 50: number; 75: number; 95: number; 99: number; }" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.MetricsCollector", + "type": "Interface", + "tags": [], + "label": "MetricsCollector", + "description": [ + "Base interface for all metrics gatherers" + ], + "signature": [ + { + "pluginId": "@kbn/core-metrics-server", + "scope": "server", + "docId": "kibKbnCoreMetricsServerPluginApi", + "section": "def-server.MetricsCollector", + "text": "MetricsCollector" + }, + "" + ], + "path": "packages/core/metrics/core-metrics-server/src/collectors.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.MetricsCollector.collect", + "type": "Function", + "tags": [], + "label": "collect", + "description": [ + "collect the data currently gathered by the collector" + ], + "signature": [ + "() => ", + "MaybePromise", + "" + ], + "path": "packages/core/metrics/core-metrics-server/src/collectors.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.MetricsCollector.reset", + "type": "Function", + "tags": [], + "label": "reset", + "description": [ + "reset the internal state of the collector" + ], + "signature": [ + "() => void" + ], + "path": "packages/core/metrics/core-metrics-server/src/collectors.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.MetricsServiceSetup", + "type": "Interface", + "tags": [], + "label": "MetricsServiceSetup", + "description": [ + "\nAPIs to retrieves metrics gathered and exposed by the core platform.\n" + ], + "path": "packages/core/metrics/core-metrics-server/src/contracts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.MetricsServiceSetup.collectionInterval", + "type": "number", + "tags": [], + "label": "collectionInterval", + "description": [ + "Interval metrics are collected in milliseconds" + ], + "path": "packages/core/metrics/core-metrics-server/src/contracts.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.MetricsServiceSetup.getOpsMetrics$", + "type": "Function", + "tags": [], + "label": "getOpsMetrics$", + "description": [ + "\nRetrieve an observable emitting the {@link OpsMetrics} gathered.\nThe observable will emit an initial value during core's `start` phase, and a new value every fixed interval of time,\nbased on the `opts.interval` configuration property.\n" + ], + "signature": [ + "() => ", + "Observable", + "<", + { + "pluginId": "@kbn/core-metrics-server", + "scope": "server", + "docId": "kibKbnCoreMetricsServerPluginApi", + "section": "def-server.OpsMetrics", + "text": "OpsMetrics" + }, + ">" + ], + "path": "packages/core/metrics/core-metrics-server/src/contracts.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsMetrics", + "type": "Interface", + "tags": [], + "label": "OpsMetrics", + "description": [ + "\nRegroups metrics gathered by all the collectors.\nThis contains metrics about the os/runtime, the kibana process and the http server.\n" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsMetrics.collected_at", + "type": "Object", + "tags": [], + "label": "collected_at", + "description": [ + "Time metrics were recorded at." + ], + "signature": [ + "Date" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsMetrics.process", + "type": "Object", + "tags": [ + "deprecated" + ], + "label": "process", + "description": [ + "\nProcess related metrics." + ], + "signature": [ + { + "pluginId": "@kbn/core-metrics-server", + "scope": "server", + "docId": "kibKbnCoreMetricsServerPluginApi", + "section": "def-server.OpsProcessMetrics", + "text": "OpsProcessMetrics" + } + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": true, + "removeBy": "8.8.0", + "references": [] + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsMetrics.processes", + "type": "Array", + "tags": [], + "label": "processes", + "description": [ + "Process related metrics. Reports an array of objects for each kibana pid." + ], + "signature": [ + { + "pluginId": "@kbn/core-metrics-server", + "scope": "server", + "docId": "kibKbnCoreMetricsServerPluginApi", + "section": "def-server.OpsProcessMetrics", + "text": "OpsProcessMetrics" + }, + "[]" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsMetrics.os", + "type": "Object", + "tags": [], + "label": "os", + "description": [ + "OS related metrics" + ], + "signature": [ + { + "pluginId": "@kbn/core-metrics-server", + "scope": "server", + "docId": "kibKbnCoreMetricsServerPluginApi", + "section": "def-server.OpsOsMetrics", + "text": "OpsOsMetrics" + } + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsMetrics.response_times", + "type": "Object", + "tags": [], + "label": "response_times", + "description": [ + "server response time stats" + ], + "signature": [ + "{ avg_in_millis: number; max_in_millis: number; }" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsMetrics.requests", + "type": "Object", + "tags": [], + "label": "requests", + "description": [ + "server requests stats" + ], + "signature": [ + "{ disconnects: number; total: number; statusCodes: Record; }" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsMetrics.concurrent_connections", + "type": "number", + "tags": [], + "label": "concurrent_connections", + "description": [ + "number of current concurrent connections to the server" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsOsMetrics", + "type": "Interface", + "tags": [], + "label": "OpsOsMetrics", + "description": [ + "\nOS related metrics" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsOsMetrics.platform", + "type": "CompoundType", + "tags": [], + "label": "platform", + "description": [ + "The os platform" + ], + "signature": [ + "\"linux\" | \"aix\" | \"android\" | \"darwin\" | \"freebsd\" | \"haiku\" | \"openbsd\" | \"sunos\" | \"win32\" | \"cygwin\" | \"netbsd\"" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsOsMetrics.platformRelease", + "type": "string", + "tags": [], + "label": "platformRelease", + "description": [ + "The os platform release, prefixed by the platform name" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsOsMetrics.distro", + "type": "string", + "tags": [], + "label": "distro", + "description": [ + "The os distrib. Only present for linux platforms" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsOsMetrics.distroRelease", + "type": "string", + "tags": [], + "label": "distroRelease", + "description": [ + "The os distrib release, prefixed by the os distrib. Only present for linux platforms" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsOsMetrics.load", + "type": "Object", + "tags": [], + "label": "load", + "description": [ + "cpu load metrics" + ], + "signature": [ + "{ '1m': number; '5m': number; '15m': number; }" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsOsMetrics.memory", + "type": "Object", + "tags": [], + "label": "memory", + "description": [ + "system memory usage metrics" + ], + "signature": [ + "{ total_in_bytes: number; free_in_bytes: number; used_in_bytes: number; }" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsOsMetrics.uptime_in_millis", + "type": "number", + "tags": [], + "label": "uptime_in_millis", + "description": [ + "the OS uptime" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsOsMetrics.cpuacct", + "type": "Object", + "tags": [], + "label": "cpuacct", + "description": [ + "cpu accounting metrics, undefined when not running in a cgroup" + ], + "signature": [ + "{ control_group: string; usage_nanos: number; } | undefined" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsOsMetrics.cpu", + "type": "Object", + "tags": [], + "label": "cpu", + "description": [ + "cpu cgroup metrics, undefined when not running in a cgroup" + ], + "signature": [ + "{ control_group: string; cfs_period_micros: number; cfs_quota_micros: number; stat: { number_of_elapsed_periods: number; number_of_times_throttled: number; time_throttled_nanos: number; }; } | undefined" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsProcessMetrics", + "type": "Interface", + "tags": [], + "label": "OpsProcessMetrics", + "description": [ + "\nProcess related metrics" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsProcessMetrics.pid", + "type": "number", + "tags": [], + "label": "pid", + "description": [ + "pid of the kibana process" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsProcessMetrics.memory", + "type": "Object", + "tags": [], + "label": "memory", + "description": [ + "process memory usage" + ], + "signature": [ + "{ heap: { total_in_bytes: number; used_in_bytes: number; size_limit: number; }; resident_set_size_in_bytes: number; }" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsProcessMetrics.event_loop_delay", + "type": "number", + "tags": [], + "label": "event_loop_delay", + "description": [ + "mean event loop delay since last collection" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsProcessMetrics.event_loop_delay_histogram", + "type": "Object", + "tags": [], + "label": "event_loop_delay_histogram", + "description": [ + "node event loop delay histogram since last collection" + ], + "signature": [ + { + "pluginId": "@kbn/core-metrics-server", + "scope": "server", + "docId": "kibKbnCoreMetricsServerPluginApi", + "section": "def-server.IntervalHistogram", + "text": "IntervalHistogram" + } + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsProcessMetrics.uptime_in_millis", + "type": "number", + "tags": [], + "label": "uptime_in_millis", + "description": [ + "uptime of the kibana process" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsServerMetrics", + "type": "Interface", + "tags": [], + "label": "OpsServerMetrics", + "description": [ + "\nserver related metrics" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsServerMetrics.response_times", + "type": "Object", + "tags": [], + "label": "response_times", + "description": [ + "server response time stats" + ], + "signature": [ + "{ avg_in_millis: number; max_in_millis: number; }" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsServerMetrics.requests", + "type": "Object", + "tags": [], + "label": "requests", + "description": [ + "server requests stats" + ], + "signature": [ + "{ disconnects: number; total: number; statusCodes: Record; }" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.OpsServerMetrics.concurrent_connections", + "type": "number", + "tags": [], + "label": "concurrent_connections", + "description": [ + "number of current concurrent connections to the server" + ], + "path": "packages/core/metrics/core-metrics-server/src/metrics.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-metrics-server", + "id": "def-server.MetricsServiceStart", + "type": "Type", + "tags": [], + "label": "MetricsServiceStart", + "description": [ + "\n{@inheritdoc MetricsServiceSetup}\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-metrics-server", + "scope": "server", + "docId": "kibKbnCoreMetricsServerPluginApi", + "section": "def-server.MetricsServiceSetup", + "text": "MetricsServiceSetup" + } + ], + "path": "packages/core/metrics/core-metrics-server/src/contracts.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_metrics_server.mdx b/api_docs/kbn_core_metrics_server.mdx new file mode 100644 index 0000000000000..76eb21345db3c --- /dev/null +++ b/api_docs/kbn_core_metrics_server.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnCoreMetricsServerPluginApi +slug: /kibana-dev-docs/api/kbn-core-metrics-server +title: "@kbn/core-metrics-server" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-metrics-server plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-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. +--- +import kbnCoreMetricsServerObj from './kbn_core_metrics_server.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 48 | 0 | 8 | 0 | + +## Server + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_metrics_server_internal.devdocs.json b/api_docs/kbn_core_metrics_server_internal.devdocs.json new file mode 100644 index 0000000000000..5f8ca28a506ae --- /dev/null +++ b/api_docs/kbn_core_metrics_server_internal.devdocs.json @@ -0,0 +1,103 @@ +{ + "id": "@kbn/core-metrics-server-internal", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-metrics-server-internal", + "id": "def-server.MetricsServiceSetupDeps", + "type": "Interface", + "tags": [], + "label": "MetricsServiceSetupDeps", + "description": [], + "path": "packages/core/metrics/core-metrics-server-internal/src/metrics_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-server-internal", + "id": "def-server.MetricsServiceSetupDeps.http", + "type": "Object", + "tags": [], + "label": "http", + "description": [], + "signature": [ + "InternalHttpServiceSetup" + ], + "path": "packages/core/metrics/core-metrics-server-internal/src/metrics_service.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/core-metrics-server-internal", + "id": "def-server.opsConfig", + "type": "Object", + "tags": [], + "label": "opsConfig", + "description": [], + "path": "packages/core/metrics/core-metrics-server-internal/src/ops_config.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-server-internal", + "id": "def-server.opsConfig.path", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "\"ops\"" + ], + "path": "packages/core/metrics/core-metrics-server-internal/src/ops_config.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-metrics-server-internal", + "id": "def-server.opsConfig.schema", + "type": "Object", + "tags": [], + "label": "schema", + "description": [], + "signature": [ + "ObjectType", + "<{ interval: ", + "Type", + "; cGroupOverrides: ", + "ObjectType", + "<{ cpuPath: ", + "Type", + "; cpuAcctPath: ", + "Type", + "; }>; }>" + ], + "path": "packages/core/metrics/core-metrics-server-internal/src/ops_config.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_metrics_server_internal.mdx b/api_docs/kbn_core_metrics_server_internal.mdx new file mode 100644 index 0000000000000..0ea480a354ba0 --- /dev/null +++ b/api_docs/kbn_core_metrics_server_internal.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnCoreMetricsServerInternalPluginApi +slug: /kibana-dev-docs/api/kbn-core-metrics-server-internal +title: "@kbn/core-metrics-server-internal" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-metrics-server-internal plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server-internal'] +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. +--- +import kbnCoreMetricsServerInternalObj from './kbn_core_metrics_server_internal.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 5 | 0 | 5 | 0 | + +## Server + +### Objects + + +### Interfaces + + diff --git a/api_docs/kbn_core_metrics_server_mocks.devdocs.json b/api_docs/kbn_core_metrics_server_mocks.devdocs.json new file mode 100644 index 0000000000000..19d5b213c2042 --- /dev/null +++ b/api_docs/kbn_core_metrics_server_mocks.devdocs.json @@ -0,0 +1,140 @@ +{ + "id": "@kbn/core-metrics-server-mocks", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [ + { + "parentPluginId": "@kbn/core-metrics-server-mocks", + "id": "def-server.metricsServiceMock", + "type": "Object", + "tags": [], + "label": "metricsServiceMock", + "description": [], + "path": "packages/core/metrics/core-metrics-server-mocks/src/metrics_service.mock.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-metrics-server-mocks", + "id": "def-server.metricsServiceMock.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [], + "signature": [ + "() => jest.Mocked" + ], + "path": "packages/core/metrics/core-metrics-server-mocks/src/metrics_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-metrics-server-mocks", + "id": "def-server.metricsServiceMock.createSetupContract", + "type": "Function", + "tags": [], + "label": "createSetupContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "MetricsServiceSetup", + ">" + ], + "path": "packages/core/metrics/core-metrics-server-mocks/src/metrics_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-metrics-server-mocks", + "id": "def-server.metricsServiceMock.createStartContract", + "type": "Function", + "tags": [], + "label": "createStartContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "MetricsServiceSetup", + ">" + ], + "path": "packages/core/metrics/core-metrics-server-mocks/src/metrics_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-metrics-server-mocks", + "id": "def-server.metricsServiceMock.createInternalSetupContract", + "type": "Function", + "tags": [], + "label": "createInternalSetupContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "MetricsServiceSetup", + ">" + ], + "path": "packages/core/metrics/core-metrics-server-mocks/src/metrics_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-metrics-server-mocks", + "id": "def-server.metricsServiceMock.createInternalStartContract", + "type": "Function", + "tags": [], + "label": "createInternalStartContract", + "description": [], + "signature": [ + "() => jest.Mocked<", + "MetricsServiceSetup", + ">" + ], + "path": "packages/core/metrics/core-metrics-server-mocks/src/metrics_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + }, + { + "parentPluginId": "@kbn/core-metrics-server-mocks", + "id": "def-server.metricsServiceMock.createEventLoopDelaysMonitor", + "type": "Function", + "tags": [], + "label": "createEventLoopDelaysMonitor", + "description": [], + "signature": [ + "() => ", + "EventLoopDelaysMonitor" + ], + "path": "packages/core/metrics/core-metrics-server-mocks/src/metrics_service.mock.ts", + "deprecated": false, + "returnComment": [], + "children": [] + } + ], + "initialIsOpen": false + } + ] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_metrics_server_mocks.mdx b/api_docs/kbn_core_metrics_server_mocks.mdx new file mode 100644 index 0000000000000..551aeeaaba4e3 --- /dev/null +++ b/api_docs/kbn_core_metrics_server_mocks.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnCoreMetricsServerMocksPluginApi +slug: /kibana-dev-docs/api/kbn-core-metrics-server-mocks +title: "@kbn/core-metrics-server-mocks" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-metrics-server-mocks plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-metrics-server-mocks'] +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. +--- +import kbnCoreMetricsServerMocksObj from './kbn_core_metrics_server_mocks.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 7 | 0 | 7 | 0 | + +## Server + +### Objects + + diff --git a/api_docs/kbn_core_node_server.mdx b/api_docs/kbn_core_node_server.mdx index 771481a9866a8..8d99026e2d7f6 100644 --- a/api_docs/kbn_core_node_server.mdx +++ b/api_docs/kbn_core_node_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server title: "@kbn/core-node-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-node-server plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-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. --- diff --git a/api_docs/kbn_core_node_server_internal.mdx b/api_docs/kbn_core_node_server_internal.mdx index 6e3209cdf3691..f6330366dac71 100644 --- a/api_docs/kbn_core_node_server_internal.mdx +++ b/api_docs/kbn_core_node_server_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-internal title: "@kbn/core-node-server-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-node-server-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-internal'] 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. --- diff --git a/api_docs/kbn_core_node_server_mocks.mdx b/api_docs/kbn_core_node_server_mocks.mdx index e941782524d93..3736aac44fa34 100644 --- a/api_docs/kbn_core_node_server_mocks.mdx +++ b/api_docs/kbn_core_node_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-node-server-mocks title: "@kbn/core-node-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-node-server-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-node-server-mocks'] 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. --- diff --git a/api_docs/kbn_core_preboot_server.mdx b/api_docs/kbn_core_preboot_server.mdx index 4f7f5321339a2..5e63287d702ea 100644 --- a/api_docs/kbn_core_preboot_server.mdx +++ b/api_docs/kbn_core_preboot_server.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-preboot-server title: "@kbn/core-preboot-server" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-preboot-server plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-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. --- diff --git a/api_docs/kbn_core_preboot_server_mocks.mdx b/api_docs/kbn_core_preboot_server_mocks.mdx index e66f371cdd47e..4533c3bc4c4d7 100644 --- a/api_docs/kbn_core_preboot_server_mocks.mdx +++ b/api_docs/kbn_core_preboot_server_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-preboot-server-mocks title: "@kbn/core-preboot-server-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-preboot-server-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-preboot-server-mocks'] 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. --- diff --git a/api_docs/kbn_core_saved_objects_api_browser.devdocs.json b/api_docs/kbn_core_saved_objects_api_browser.devdocs.json new file mode 100644 index 0000000000000..84e904ed0d0aa --- /dev/null +++ b/api_docs/kbn_core_saved_objects_api_browser.devdocs.json @@ -0,0 +1,1693 @@ +{ + "id": "@kbn/core-saved-objects-api-browser", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.ResolvedSimpleSavedObject", + "type": "Interface", + "tags": [], + "label": "ResolvedSimpleSavedObject", + "description": [ + "\nThis interface is a very simple wrapper for SavedObjects resolved from the server\nwith the {@link SavedObjectsClientContract}.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.ResolvedSimpleSavedObject", + "text": "ResolvedSimpleSavedObject" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/resolve.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.ResolvedSimpleSavedObject.saved_object", + "type": "Object", + "tags": [], + "label": "saved_object", + "description": [ + "\nThe saved object that was found." + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/resolve.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.ResolvedSimpleSavedObject.outcome", + "type": "CompoundType", + "tags": [], + "label": "outcome", + "description": [ + "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." + ], + "signature": [ + "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/resolve.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.ResolvedSimpleSavedObject.alias_target_id", + "type": "string", + "tags": [], + "label": "alias_target_id", + "description": [ + "\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/resolve.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.ResolvedSimpleSavedObject.alias_purpose", + "type": "CompoundType", + "tags": [], + "label": "alias_purpose", + "description": [ + "\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + ], + "signature": [ + "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/resolve.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBatchResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBatchResponse", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/base.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBatchResponse.savedObjects", + "type": "Array", + "tags": [], + "label": "savedObjects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/base.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkCreateObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkCreateObject", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_create.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkCreateObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkCreateObject.attributes", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_create.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkCreateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkCreateOptions", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_create.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkCreateOptions.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [ + "If a document with the given `id` already exists, overwrite it's contents (default=false)." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_create.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkResolveResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkResolveResponse", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_resolve.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkResolveResponse.resolved_objects", + "type": "Array", + "tags": [], + "label": "resolved_objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.ResolvedSimpleSavedObject", + "text": "ResolvedSimpleSavedObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_resolve.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkUpdateObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkUpdateObject", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_update.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkUpdateObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkUpdateObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkUpdateObject.attributes", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkUpdateObject.version", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkUpdateObject.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_update.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkUpdateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkUpdateOptions", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_update.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsBulkUpdateOptions.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_update.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract", + "type": "Interface", + "tags": [], + "label": "SavedObjectsClientContract", + "description": [ + "\nThe client-side SavedObjectsClient is a thin convenience library around the SavedObjects\nHTTP API for interacting with Saved Objects.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [ + "\nPersists an object" + ], + "signature": [ + "(type: string, attributes: T, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.create.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.create.$2", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.create.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.bulkCreate", + "type": "Function", + "tags": [], + "label": "bulkCreate", + "description": [ + "\nCreates multiple documents at once" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBulkCreateOptions", + "text": "SavedObjectsBulkCreateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.bulkCreate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.bulkCreate.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBulkCreateOptions", + "text": "SavedObjectsBulkCreateOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "The result of the create operation containing created saved objects." + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "\nDeletes an object" + ], + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + " | undefined) => Promise<{}>" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.delete.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.delete.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.delete.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.find", + "type": "Function", + "tags": [ + "property", + "property", + "property", + "property", + "property", + "property", + "property" + ], + "label": "find", + "description": [ + "\nSearch for objects\n" + ], + "signature": [ + "(options: ", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.find.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "A find result with objects matching the specified search." + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nFetches a single object\n" + ], + "signature": [ + "(type: string, id: string) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.get.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.get.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The saved object for the given type and id." + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.bulkGet", + "type": "Function", + "tags": [], + "label": "bulkGet", + "description": [ + "\nReturns an array of objects by id\n" + ], + "signature": [ + "(objects: ", + "SavedObjectTypeIdTuple", + "[]) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.bulkGet.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array ids, or an array of objects containing id and optionally type" + ], + "signature": [ + "SavedObjectTypeIdTuple", + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The saved objects with the given type and ids requested" + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.resolve", + "type": "Function", + "tags": [ + "note" + ], + "label": "resolve", + "description": [ + "\nResolves a single object\n" + ], + "signature": [ + "(type: string, id: string) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.ResolvedSimpleSavedObject", + "text": "ResolvedSimpleSavedObject" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.resolve.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.resolve.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The resolve result for the saved object for the given type and id." + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.bulkResolve", + "type": "Function", + "tags": [ + "note" + ], + "label": "bulkResolve", + "description": [ + "\nResolves an array of objects by id, using any legacy URL aliases if they exist\n" + ], + "signature": [ + "(objects: ", + "SavedObjectTypeIdTuple", + "[]) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.bulkResolve.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array of objects containing id, type" + ], + "signature": [ + "SavedObjectTypeIdTuple", + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The bulk resolve result for the saved objects for the given types and ids." + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.update", + "type": "Function", + "tags": [ + "prop", + "prop" + ], + "label": "update", + "description": [ + "\nUpdates an object\n" + ], + "signature": [ + "(type: string, id: string, attributes: T, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.update.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.update.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.update.$3", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.update.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.bulkUpdate", + "type": "Function", + "tags": [], + "label": "bulkUpdate", + "description": [ + "\nUpdate multiple documents at once\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsClientContract.bulkUpdate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- [{ type, id, attributes, options: { version, references } }]" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "The result of the update operation containing both failed and updated saved objects." + ] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsCreateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCreateOptions", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/create.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsCreateOptions.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\n(Not recommended) Specify an id instead of having the saved objects service generate one for you." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsCreateOptions.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [ + "If a document with the given `id` already exists, overwrite it's contents (default=false)." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsCreateOptions.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [ + "{@inheritDoc SavedObjectsMigrationVersion}" + ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsCreateOptions.coreMigrationVersion", + "type": "string", + "tags": [], + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsCreateOptions.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/create.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsDeleteOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsDeleteOptions", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/delete.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsDeleteOptions.force", + "type": "CompoundType", + "tags": [], + "label": "force", + "description": [ + "Force deletion of an object that exists in multiple namespaces" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/delete.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsFindOptionsReference", + "type": "Interface", + "tags": [], + "label": "SavedObjectsFindOptionsReference", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/find.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsFindOptionsReference.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsFindOptionsReference.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/find.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsFindResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsFindResponse", + "description": [ + "\nReturn type of the Saved Objects `find()` method.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsBatchResponse", + "text": "SavedObjectsBatchResponse" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/find.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsFindResponse.aggregations", + "type": "Uncategorized", + "tags": [], + "label": "aggregations", + "description": [], + "signature": [ + "A | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsFindResponse.total", + "type": "number", + "tags": [], + "label": "total", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsFindResponse.perPage", + "type": "number", + "tags": [], + "label": "perPage", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsFindResponse.page", + "type": "number", + "tags": [], + "label": "page", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/find.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsUpdateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateOptions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/update.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsUpdateOptions.version", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsUpdateOptions.upsert", + "type": "Uncategorized", + "tags": [], + "label": "upsert", + "description": [], + "signature": [ + "Attributes | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsUpdateOptions.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/update.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject", + "type": "Interface", + "tags": [], + "label": "SimpleSavedObject", + "description": [ + "\nVery simple wrapper for SavedObjects loaded from the server\nwith the {@link SavedObjectsClientContract}.\n\nIt provides basic functionality for creating/saving/deleting saved objects,\nbut doesn't include any type-specific implementations.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.attributes", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject._version", + "type": "string", + "tags": [], + "label": "_version", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.coreMigrationVersion", + "type": "string", + "tags": [], + "label": "coreMigrationVersion", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + "SavedObjectError", + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.updatedAt", + "type": "string", + "tags": [], + "label": "updatedAt", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [], + "signature": [ + "(key: string) => any" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.get.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.set", + "type": "Function", + "tags": [], + "label": "set", + "description": [], + "signature": [ + "(key: string, value: any) => T" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.set.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.set.$2", + "type": "Any", + "tags": [], + "label": "value", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.has", + "type": "Function", + "tags": [], + "label": "has", + "description": [], + "signature": [ + "(key: string) => boolean" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.has.$1", + "type": "string", + "tags": [], + "label": "key", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.save", + "type": "Function", + "tags": [], + "label": "save", + "description": [], + "signature": [ + "() => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-browser", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsApiBrowserPluginApi", + "section": "def-common.SimpleSavedObject", + "text": "SimpleSavedObject" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SimpleSavedObject.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [], + "signature": [ + "() => Promise<{}>" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-browser", + "id": "def-common.SavedObjectsFindOptions", + "type": "Type", + "tags": [], + "label": "SavedObjectsFindOptions", + "description": [], + "signature": [ + "{ type: string | string[]; filter?: any; search?: string | undefined; page?: number | undefined; aggs?: Record | undefined; fields?: string[] | undefined; perPage?: number | undefined; sortField?: string | undefined; searchFields?: string[] | undefined; hasReference?: ", + "SavedObjectsFindOptionsReference", + " | ", + "SavedObjectsFindOptionsReference", + "[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; preference?: string | undefined; }" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-browser/src/apis/find.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_saved_objects_api_browser.mdx b/api_docs/kbn_core_saved_objects_api_browser.mdx new file mode 100644 index 0000000000000..d6475fc74f74c --- /dev/null +++ b/api_docs/kbn_core_saved_objects_api_browser.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnCoreSavedObjectsApiBrowserPluginApi +slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-browser +title: "@kbn/core-saved-objects-api-browser" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-saved-objects-api-browser plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-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. +--- +import kbnCoreSavedObjectsApiBrowserObj from './kbn_core_saved_objects_api_browser.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 94 | 1 | 66 | 0 | + +## Common + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_saved_objects_api_server.devdocs.json b/api_docs/kbn_core_saved_objects_api_server.devdocs.json new file mode 100644 index 0000000000000..09880a311173a --- /dev/null +++ b/api_docs/kbn_core_saved_objects_api_server.devdocs.json @@ -0,0 +1,5793 @@ +{ + "id": "@kbn/core-saved-objects-api-server", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsPointInTimeFinder", + "type": "Interface", + "tags": [], + "label": "ISavedObjectsPointInTimeFinder", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.ISavedObjectsPointInTimeFinder", + "text": "ISavedObjectsPointInTimeFinder" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create_point_in_time_finder.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsPointInTimeFinder.find", + "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nAn async generator which wraps calls to `savedObjectsClient.find` and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a set\nof results is received that's smaller than the designated `perPage` size." + ], + "signature": [ + "() => AsyncGenerator<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ", any, unknown>" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create_point_in_time_finder.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsPointInTimeFinder.close", + "type": "Function", + "tags": [], + "label": "close", + "description": [ + "\nCloses the Point-In-Time associated with this finder instance.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason." + ], + "signature": [ + "() => Promise" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create_point_in_time_finder.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository", + "type": "Interface", + "tags": [], + "label": "ISavedObjectsRepository", + "description": [ + "\nThe savedObjects repository contract.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.create", + "type": "Function", + "tags": [ + "property", + "property", + "property", + "property", + "property" + ], + "label": "create", + "description": [ + "\nPersists an object\n" + ], + "signature": [ + "(type: string, attributes: T, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + "SavedObject", + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.create.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.create.$2", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.create.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { id, type, version, attributes }" + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.bulkCreate", + "type": "Function", + "tags": [ + "property", + "property" + ], + "label": "bulkCreate", + "description": [ + "\nCreates multiple documents at once\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.bulkCreate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- [{ type, id, attributes, references, migrationVersion }]" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.bulkCreate.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.checkConflicts", + "type": "Function", + "tags": [], + "label": "checkConflicts", + "description": [ + "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten." + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCheckConflictsResponse", + "text": "SavedObjectsCheckConflictsResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.checkConflicts.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.checkConflicts.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.delete", + "type": "Function", + "tags": [ + "property" + ], + "label": "delete", + "description": [ + "\nDeletes an object\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + " | undefined) => Promise<{}>" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.delete.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.delete.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.delete.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.deleteByNamespace", + "type": "Function", + "tags": [], + "label": "deleteByNamespace", + "description": [ + "\nDeletes all objects from the provided namespace.\n" + ], + "signature": [ + "(namespace: string, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" + }, + " | undefined) => Promise" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.deleteByNamespace.$1", + "type": "string", + "tags": [], + "label": "namespace", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.deleteByNamespace.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures }" + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.find", + "type": "Function", + "tags": [ + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property", + "property" + ], + "label": "find", + "description": [], + "signature": [ + "(options: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.find.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [ + "- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }" + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.bulkGet", + "type": "Function", + "tags": [ + "property" + ], + "label": "bulkGet", + "description": [ + "\nReturns an array of objects by id\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.bulkGet.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array of objects containing id, type and optionally fields" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.bulkGet.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { saved_objects: [{ id, type, version, attributes }] }" + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.bulkResolve", + "type": "Function", + "tags": [ + "property" + ], + "label": "bulkResolve", + "description": [ + "\nResolves an array of objects by id, using any legacy URL aliases if they exist\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkResolveObject", + "text": "SavedObjectsBulkResolveObject" + }, + "[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.bulkResolve.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array of objects containing id, type" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkResolveObject", + "text": "SavedObjectsBulkResolveObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.bulkResolve.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { resolved_objects: [{ saved_object, outcome }] }" + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.get", + "type": "Function", + "tags": [ + "property" + ], + "label": "get", + "description": [ + "\nGets a single object\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + "SavedObject", + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.get.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.get.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.get.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { id, type, version, attributes }" + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.resolve", + "type": "Function", + "tags": [ + "property" + ], + "label": "resolve", + "description": [ + "\nResolves a single object, using any legacy URL alias if it exists\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.resolve.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.resolve.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.resolve.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { saved_object, outcome }" + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.update", + "type": "Function", + "tags": [ + "property", + "property", + "property" + ], + "label": "update", + "description": [ + "\nUpdates an object\n" + ], + "signature": [ + "(type: string, id: string, attributes: Partial, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.update.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.update.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.update.$3", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "Partial" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.update.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.collectMultiNamespaceReferences", + "type": "Function", + "tags": [], + "label": "collectMultiNamespaceReferences", + "description": [ + "\nGets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace\ntype.\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + }, + "[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.collectMultiNamespaceReferences.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "The objects to get the references for." + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.collectMultiNamespaceReferences.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.updateObjectsSpaces", + "type": "Function", + "tags": [], + "label": "updateObjectsSpaces", + "description": [ + "\nUpdates one or more objects to add and/or remove them from specified spaces.\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" + }, + "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "text": "SavedObjectsUpdateObjectsSpacesResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.updateObjectsSpaces.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.updateObjectsSpaces.$2", + "type": "Array", + "tags": [], + "label": "spacesToAdd", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.updateObjectsSpaces.$3", + "type": "Array", + "tags": [], + "label": "spacesToRemove", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.updateObjectsSpaces.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.bulkUpdate", + "type": "Function", + "tags": [ + "property", + "property" + ], + "label": "bulkUpdate", + "description": [ + "\nUpdates multiple objects in bulk\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.bulkUpdate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- [{ type, id, attributes, options: { version, namespace } references }]" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.bulkUpdate.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}" + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.removeReferencesTo", + "type": "Function", + "tags": [], + "label": "removeReferencesTo", + "description": [ + "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.removeReferencesTo.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.removeReferencesTo.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.removeReferencesTo.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.incrementCounter", + "type": "Function", + "tags": [], + "label": "incrementCounter", + "description": [ + "\nIncrements all the specified counter fields (by one by default). Creates the document\nif one doesn't exist for the given id.\n" + ], + "signature": [ + "(type: string, id: string, counterFields: (string | ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsIncrementCounterField", + "text": "SavedObjectsIncrementCounterField" + }, + ")[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsIncrementCounterOptions", + "text": "SavedObjectsIncrementCounterOptions" + }, + " | undefined) => Promise<", + "SavedObject", + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.incrementCounter.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- The type of saved object whose fields should be incremented" + ], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.incrementCounter.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- The id of the document whose fields should be incremented" + ], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.incrementCounter.$3", + "type": "Array", + "tags": [], + "label": "counterFields", + "description": [ + "- An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField }" + ], + "signature": [ + "(string | ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsIncrementCounterField", + "text": "SavedObjectsIncrementCounterField" + }, + ")[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.incrementCounter.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link SavedObjectsIncrementCounterOptions }" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsIncrementCounterOptions", + "text": "SavedObjectsIncrementCounterOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "The saved object after the specified fields were incremented" + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.openPointInTimeForType", + "type": "Function", + "tags": [ + "property", + "property" + ], + "label": "openPointInTimeForType", + "description": [ + "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to `SavedObjects.find` to search against that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" + ], + "signature": [ + "(type: string | string[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.openPointInTimeForType.$1", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | string[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.openPointInTimeForType.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link SavedObjectsOpenPointInTimeOptions }" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- { id: string }" + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.closePointInTime", + "type": "Function", + "tags": [], + "label": "closePointInTime", + "description": [ + "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES\nvia the Elasticsearch client, and is included in the Saved Objects Client\nas a convenience for consumers who are using `openPointInTimeForType`.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsRepository.createPointInTimeFinder} method.\n" + ], + "signature": [ + "(id: string, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.closePointInTime.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.closePointInTime.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [ + "- {@link SavedObjectsClosePointInTimeOptions }" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [ + "- {@link SavedObjectsClosePointInTimeResponse }" + ] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.createPointInTimeFinder", + "type": "Function", + "tags": [], + "label": "createPointInTimeFinder", + "description": [ + "\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThis generator wraps calls to {@link SavedObjectsRepository.find} and\niterates over multiple pages of results using `_pit` and `search_after`.\nThis will open a new Point-In-Time (PIT), and continue paging until a\nset of results is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n" + ], + "signature": [ + "(findOptions: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "text": "SavedObjectsCreatePointInTimeFinderOptions" + }, + ", dependencies?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.ISavedObjectsPointInTimeFinder", + "text": "ISavedObjectsPointInTimeFinder" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.createPointInTimeFinder.$1", + "type": "Object", + "tags": [], + "label": "findOptions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "text": "SavedObjectsCreatePointInTimeFinderOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.ISavedObjectsRepository.createPointInTimeFinder.$2", + "type": "Object", + "tags": [], + "label": "dependencies", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectReferenceWithContext", + "type": "Interface", + "tags": [], + "label": "SavedObjectReferenceWithContext", + "description": [ + "\nA returned input object or one of its references, with additional context.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectReferenceWithContext.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "The type of the referenced object" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectReferenceWithContext.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of the referenced object" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectReferenceWithContext.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "The origin ID of the referenced object (if it has one)" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectReferenceWithContext.spaces", + "type": "Array", + "tags": [], + "label": "spaces", + "description": [ + "The space(s) that the referenced object exists in" + ], + "signature": [ + "string[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectReferenceWithContext.inboundReferences", + "type": "Array", + "tags": [], + "label": "inboundReferences", + "description": [ + "\nReferences to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains\ninbound references for the scope of this operation" + ], + "signature": [ + "{ type: string; id: string; name: string; }[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectReferenceWithContext.isMissing", + "type": "CompoundType", + "tags": [], + "label": "isMissing", + "description": [ + "Whether or not this object or reference is missing" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectReferenceWithContext.spacesWithMatchingAliases", + "type": "Array", + "tags": [], + "label": "spacesWithMatchingAliases", + "description": [ + "The space(s) that legacy URL aliases matching this type/id exist in" + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectReferenceWithContext.spacesWithMatchingOrigins", + "type": "Array", + "tags": [], + "label": "spacesWithMatchingOrigins", + "description": [ + "The space(s) that objects matching this origin exist in (including this one)" + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBaseOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBaseOptions", + "description": [ + "\nBase options used by most of the savedObject APIs." + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/base.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBaseOptions.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [ + "Specify the namespace for this operation" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/base.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkCreateObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkCreateObject", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_create.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkCreateObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkCreateObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkCreateObject.attributes", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkCreateObject.version", + "type": "string", + "tags": [], + "label": "version", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkCreateObject.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkCreateObject.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [ + "{@inheritDoc SavedObjectsMigrationVersion}" + ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkCreateObject.coreMigrationVersion", + "type": "string", + "tags": [], + "label": "coreMigrationVersion", + "description": [ + "\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkCreateObject.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "Optional ID of the original saved object, if this object's `id` was regenerated" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkCreateObject.initialNamespaces", + "type": "Array", + "tags": [], + "label": "initialNamespaces", + "description": [ + "\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used." + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_create.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkGetObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkGetObject", + "description": [ + "\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_get.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkGetObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_get.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkGetObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_get.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkGetObject.fields", + "type": "Array", + "tags": [], + "label": "fields", + "description": [ + "SavedObject fields to include in the response" + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_get.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkGetObject.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nOptional namespace(s) for the object to be retrieved in. If this is defined, it will supersede the namespace ID that is in the\ntop-level options.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used." + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_get.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkResolveObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkResolveObject", + "description": [ + "\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_resolve.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkResolveObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_resolve.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkResolveObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_resolve.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkResolveResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkResolveResponse", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_resolve.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkResolveResponse.resolved_objects", + "type": "Array", + "tags": [], + "label": "resolved_objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_resolve.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkResponse", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/base.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkResponse.saved_objects", + "type": "Array", + "tags": [], + "label": "saved_objects", + "description": [], + "signature": [ + "SavedObject", + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/base.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkUpdateObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkUpdateObject", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + " extends Pick<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + ", \"version\" | \"references\">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkUpdateObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkUpdateObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + " The type of this Saved Object. Each plugin can define it's own custom Saved Object types." + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkUpdateObject.attributes", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [ + "{@inheritdoc SavedObjectAttributes}" + ], + "signature": [ + "{ [P in keyof T]?: T[P] | undefined; }" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkUpdateObject.namespace", + "type": "string", + "tags": [], + "label": "namespace", + "description": [ + "\nOptional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsBulkUpdateOptions}.\n\nNote: the default namespace's string representation is `'default'`, and its ID representation is `undefined`." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkUpdateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkUpdateOptions", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkUpdateOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.MutatingOperationRefreshSetting", + "text": "MutatingOperationRefreshSetting" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkUpdateResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsBulkUpdateResponse", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsBulkUpdateResponse.saved_objects", + "type": "Array", + "tags": [], + "label": "saved_objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCheckConflictsObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCheckConflictsObject", + "description": [ + "\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/check_conflicts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCheckConflictsObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/check_conflicts.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCheckConflictsObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/check_conflicts.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCheckConflictsResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCheckConflictsResponse", + "description": [ + "\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/check_conflicts.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCheckConflictsResponse.errors", + "type": "Array", + "tags": [], + "label": "errors", + "description": [], + "signature": [ + "{ id: string; type: string; error: ", + "SavedObjectError", + "; }[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/check_conflicts.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract", + "type": "Interface", + "tags": [], + "label": "SavedObjectsClientContract", + "description": [ + "\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state.\n\n## SavedObjectsClient errors\n\nSince the SavedObjectsClient has its hands in everything we\nare a little paranoid about the way we present errors back to\nto application code. Ideally, all errors will be either:\n\n 1. Caused by bad implementation (ie. undefined is not a function) and\n as such unpredictable\n 2. An error that has been classified and decorated appropriately\n by the decorators in {@link SavedObjectsErrorHelpers}\n\nType 1 errors are inevitable, but since all expected/handle-able errors\nshould be Type 2 the `isXYZError()` helpers exposed at\n`SavedObjectsErrorHelpers` should be used to understand and manage error\nresponses from the `SavedObjectsClient`.\n\nType 2 errors are decorated versions of the source error, so if\nthe elasticsearch client threw an error it will be decorated based\non its type. That means that rather than looking for `error.body.error.type` or\ndoing substring checks on `error.body.error.reason`, just use the helpers to\nunderstand the meaning of the error:\n\n ```js\n if (SavedObjectsErrorHelpers.isNotFoundError(error)) {\n // handle 404\n }\n\n if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) {\n // 401 handling should be automatic, but in case you wanted to know\n }\n\n // always rethrow the error unless you handle it\n throw error;\n ```\n\n### 404s from missing index\n\nFrom the perspective of application code and APIs the SavedObjectsClient is\na black box that persists objects. One of the internal details that users have\nno control over is that we use an elasticsearch index for persistence and that\nindex might be missing.\n\nAt the time of writing we are in the process of transitioning away from the\noperating assumption that the SavedObjects index is always available. Part of\nthis transition is handling errors resulting from an index missing. These used\nto trigger a 500 error in most cases, and in others cause 404s with different\nerror messages.\n\nFrom my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The\nobject the request/call was targeting could not be found. This is why #14141\ntakes special care to ensure that 404 errors are generic and don't distinguish\nbetween index missing or document missing.\n\nSee {@link SavedObjectsClient}\nSee {@link SavedObjectsErrorHelpers}\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.create", + "type": "Function", + "tags": [], + "label": "create", + "description": [ + "\nPersists a SavedObject\n" + ], + "signature": [ + "(type: string, attributes: T, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + "SavedObject", + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.create.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.create.$2", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "T" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.create.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.bulkCreate", + "type": "Function", + "tags": [], + "label": "bulkCreate", + "description": [ + "\nPersists multiple documents batched together as a single request\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.bulkCreate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkCreateObject", + "text": "SavedObjectsBulkCreateObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.bulkCreate.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.checkConflicts", + "type": "Function", + "tags": [], + "label": "checkConflicts", + "description": [ + "\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten.\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCheckConflictsResponse", + "text": "SavedObjectsCheckConflictsResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.checkConflicts.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCheckConflictsObject", + "text": "SavedObjectsCheckConflictsObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.checkConflicts.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.delete", + "type": "Function", + "tags": [], + "label": "delete", + "description": [ + "\nDeletes a SavedObject\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + " | undefined) => Promise<{}>" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.delete.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.delete.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.delete.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.find", + "type": "Function", + "tags": [], + "label": "find", + "description": [ + "\nFind all SavedObjects matching the search query\n" + ], + "signature": [ + "(options: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.find.$1", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.bulkGet", + "type": "Function", + "tags": [], + "label": "bulkGet", + "description": [ + "\nReturns an array of objects by id\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkResponse", + "text": "SavedObjectsBulkResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.bulkGet.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array of ids, or an array of objects containing id, type and optionally fields" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkGetObject", + "text": "SavedObjectsBulkGetObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.bulkGet.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.get", + "type": "Function", + "tags": [], + "label": "get", + "description": [ + "\nRetrieves a single object\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + "SavedObject", + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.get.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- The type of SavedObject to retrieve" + ], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.get.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- The ID of the SavedObject to retrieve" + ], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.get.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.bulkResolve", + "type": "Function", + "tags": [ + "note" + ], + "label": "bulkResolve", + "description": [ + "\nResolves an array of objects by id, using any legacy URL aliases if they exist\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkResolveObject", + "text": "SavedObjectsBulkResolveObject" + }, + "[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkResolveResponse", + "text": "SavedObjectsBulkResolveResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.bulkResolve.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [ + "- an array of objects containing id, type" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkResolveObject", + "text": "SavedObjectsBulkResolveObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.bulkResolve.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.resolve", + "type": "Function", + "tags": [], + "label": "resolve", + "description": [ + "\nResolves a single object, using any legacy URL alias if it exists\n" + ], + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.resolve.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "- The type of SavedObject to retrieve" + ], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.resolve.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "- The ID of the SavedObject to retrieve" + ], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.resolve.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.update", + "type": "Function", + "tags": [], + "label": "update", + "description": [ + "\nUpdates an SavedObject\n" + ], + "signature": [ + "(type: string, id: string, attributes: Partial, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.update.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.update.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.update.$3", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "Partial" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.update.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.bulkUpdate", + "type": "Function", + "tags": [], + "label": "bulkUpdate", + "description": [ + "\nBulk Updates multiple SavedObject at once\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkUpdateResponse", + "text": "SavedObjectsBulkUpdateResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.bulkUpdate.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkUpdateObject", + "text": "SavedObjectsBulkUpdateObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.bulkUpdate.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBulkUpdateOptions", + "text": "SavedObjectsBulkUpdateOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.removeReferencesTo", + "type": "Function", + "tags": [], + "label": "removeReferencesTo", + "description": [ + "\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference." + ], + "signature": [ + "(type: string, id: string, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.removeReferencesTo.$1", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.removeReferencesTo.$2", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.removeReferencesTo.$3", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.openPointInTimeForType", + "type": "Function", + "tags": [], + "label": "openPointInTimeForType", + "description": [ + "\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to {@link SavedObjectsClient.find} to search\nagainst that PIT.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method." + ], + "signature": [ + "(type: string | string[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.openPointInTimeForType.$1", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | string[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.openPointInTimeForType.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.closePointInTime", + "type": "Function", + "tags": [], + "label": "closePointInTime", + "description": [ + "\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES via the\nElasticsearch client, and is included in the Saved Objects Client as a convenience\nfor consumers who are using {@link SavedObjectsClient.openPointInTimeForType}.\n\nOnly use this API if you have an advanced use case that's not solved by the\n{@link SavedObjectsClient.createPointInTimeFinder} method." + ], + "signature": [ + "(id: string, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.closePointInTime.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.closePointInTime.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.createPointInTimeFinder", + "type": "Function", + "tags": [], + "label": "createPointInTimeFinder", + "description": [ + "\nReturns a {@link ISavedObjectsPointInTimeFinder} to help page through\nlarge sets of saved objects. We strongly recommend using this API for\nany `find` queries that might return more than 1000 saved objects,\nhowever this API is only intended for use in server-side \"batch\"\nprocessing of objects where you are collecting all objects in memory\nor streaming them back to the client.\n\nDo NOT use this API in a route handler to facilitate paging through\nsaved objects on the client-side unless you are streaming all of the\nresults back to the client at once. Because the returned generator is\nstateful, you cannot rely on subsequent http requests retrieving new\npages from the same Kibana server in multi-instance deployments.\n\nThe generator wraps calls to {@link SavedObjectsClient.find} and iterates\nover multiple pages of results using `_pit` and `search_after`. This will\nopen a new Point-In-Time (PIT), and continue paging until a set of\nresults is received that's smaller than the designated `perPage`.\n\nOnce you have retrieved all of the results you need, it is recommended\nto call `close()` to clean up the PIT and prevent Elasticsearch from\nconsuming resources unnecessarily. This is only required if you are\ndone iterating and have not yet paged through all of the results: the\nPIT will automatically be closed for you once you reach the last page\nof results, or if the underlying call to `find` fails for any reason.\n" + ], + "signature": [ + "(findOptions: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "text": "SavedObjectsCreatePointInTimeFinderOptions" + }, + ", dependencies?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" + }, + " | undefined) => ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.ISavedObjectsPointInTimeFinder", + "text": "ISavedObjectsPointInTimeFinder" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.createPointInTimeFinder.$1", + "type": "Object", + "tags": [], + "label": "findOptions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "text": "SavedObjectsCreatePointInTimeFinderOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.createPointInTimeFinder.$2", + "type": "Object", + "tags": [], + "label": "dependencies", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "text": "SavedObjectsCreatePointInTimeFinderDependencies" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.collectMultiNamespaceReferences", + "type": "Function", + "tags": [], + "label": "collectMultiNamespaceReferences", + "description": [ + "\nGets all references and transitive references of the listed objects. Ignores any object that is not a multi-namespace type.\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + }, + "[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.collectMultiNamespaceReferences.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "text": "SavedObjectsCollectMultiNamespaceReferencesObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.collectMultiNamespaceReferences.$2", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.updateObjectsSpaces", + "type": "Function", + "tags": [], + "label": "updateObjectsSpaces", + "description": [ + "\nUpdates one or more objects to add and/or remove them from specified spaces.\n" + ], + "signature": [ + "(objects: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" + }, + "[], spacesToAdd: string[], spacesToRemove: string[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "text": "SavedObjectsUpdateObjectsSpacesResponse" + }, + ">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.updateObjectsSpaces.$1", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "text": "SavedObjectsUpdateObjectsSpacesObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.updateObjectsSpaces.$2", + "type": "Array", + "tags": [], + "label": "spacesToAdd", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.updateObjectsSpaces.$3", + "type": "Array", + "tags": [], + "label": "spacesToRemove", + "description": [], + "signature": [ + "string[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClientContract.updateObjectsSpaces.$4", + "type": "Object", + "tags": [], + "label": "options", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClosePointInTimeResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsClosePointInTimeResponse", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/close_point_in_time.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClosePointInTimeResponse.succeeded", + "type": "boolean", + "tags": [], + "label": "succeeded", + "description": [ + "\nIf true, all search contexts associated with the PIT id are\nsuccessfully closed." + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/close_point_in_time.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClosePointInTimeResponse.num_freed", + "type": "number", + "tags": [], + "label": "num_freed", + "description": [ + "\nThe number of search contexts that have been successfully closed." + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/close_point_in_time.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCollectMultiNamespaceReferencesObject", + "description": [ + "\nAn object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the\n`namespaceType: 'multiple'` or `namespaceType: 'multiple-isolated'` option).\n\nNote: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with\nthe `namespaceType: 'multiple'`).\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCollectMultiNamespaceReferencesOptions", + "description": [ + "\nOptions for collecting references.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions", + "text": "SavedObjectsCollectMultiNamespaceReferencesOptions" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesOptions.purpose", + "type": "CompoundType", + "tags": [], + "label": "purpose", + "description": [ + "Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences'" + ], + "signature": [ + "\"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCollectMultiNamespaceReferencesResponse", + "description": [ + "\nThe response when object references are collected.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse.objects", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectReferenceWithContext", + "text": "SavedObjectReferenceWithContext" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCreateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCreateOptions", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsCreateOptions", + "text": "SavedObjectsCreateOptions" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCreateOptions.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "(not recommended) Specify an id for the document" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCreateOptions.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [ + "Overwrite existing documents (defaults to false)" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCreateOptions.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nAn opaque version number which changes on each successful write operation.\nCan be used in conjunction with `overwrite` for implementing optimistic concurrency control." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCreateOptions.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [ + "{@inheritDoc SavedObjectsMigrationVersion}" + ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCreateOptions.coreMigrationVersion", + "type": "string", + "tags": [], + "label": "coreMigrationVersion", + "description": [ + "\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCreateOptions.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCreateOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.MutatingOperationRefreshSetting", + "text": "MutatingOperationRefreshSetting" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCreateOptions.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "Optional ID of the original saved object, if this object's `id` was regenerated" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCreateOptions.initialNamespaces", + "type": "Array", + "tags": [], + "label": "initialNamespaces", + "description": [ + "\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\n* For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces,\n including the \"All spaces\" identifier (`'*'`).\n* For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only\n be used to specify a single space, and the \"All spaces\" identifier (`'*'`) is not allowed.\n* For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used." + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies", + "type": "Interface", + "tags": [], + "label": "SavedObjectsCreatePointInTimeFinderDependencies", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create_point_in_time_finder.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCreatePointInTimeFinderDependencies.client", + "type": "Object", + "tags": [], + "label": "client", + "description": [], + "signature": [ + "{ find: (options: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindOptions", + "text": "SavedObjectsFindOptions" + }, + ") => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + ">; closePointInTime: (id: string, options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsClosePointInTimeResponse", + "text": "SavedObjectsClosePointInTimeResponse" + }, + ">; openPointInTimeForType: (type: string | string[], options?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeOptions", + "text": "SavedObjectsOpenPointInTimeOptions" + }, + " | undefined) => Promise<", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsOpenPointInTimeResponse", + "text": "SavedObjectsOpenPointInTimeResponse" + }, + ">; }" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create_point_in_time_finder.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsDeleteByNamespaceOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsDeleteByNamespaceOptions", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsDeleteByNamespaceOptions", + "text": "SavedObjectsDeleteByNamespaceOptions" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/delete_by_namespace.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsDeleteByNamespaceOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch supports only boolean flag for this operation" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/delete_by_namespace.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsDeleteOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsDeleteOptions", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsDeleteOptions", + "text": "SavedObjectsDeleteOptions" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/delete.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsDeleteOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.MutatingOperationRefreshSetting", + "text": "MutatingOperationRefreshSetting" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/delete.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsDeleteOptions.force", + "type": "CompoundType", + "tags": [], + "label": "force", + "description": [ + "Force deletion of an object that exists in multiple namespaces" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/delete.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsFindOptions", + "description": [ + "\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "string | string[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.page", + "type": "number", + "tags": [], + "label": "page", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.perPage", + "type": "number", + "tags": [], + "label": "perPage", + "description": [], + "signature": [ + "number | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.sortField", + "type": "string", + "tags": [], + "label": "sortField", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.sortOrder", + "type": "CompoundType", + "tags": [], + "label": "sortOrder", + "description": [], + "signature": [ + "SortOrder", + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.fields", + "type": "Array", + "tags": [], + "label": "fields", + "description": [ + "\nAn array of fields to include in the results" + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.search", + "type": "string", + "tags": [], + "label": "search", + "description": [ + "Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.searchFields", + "type": "Array", + "tags": [], + "label": "searchFields", + "description": [ + "The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information" + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.searchAfter", + "type": "Array", + "tags": [], + "label": "searchAfter", + "description": [ + "\nUse the sort values from the previous page to retrieve the next page of results." + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.rootSearchFields", + "type": "Array", + "tags": [], + "label": "rootSearchFields", + "description": [ + "\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together." + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.hasReference", + "type": "CompoundType", + "tags": [], + "label": "hasReference", + "description": [ + "\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references." + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + " | ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + "[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.hasReferenceOperator", + "type": "CompoundType", + "tags": [], + "label": "hasReferenceOperator", + "description": [ + "\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`" + ], + "signature": [ + "\"AND\" | \"OR\" | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.defaultSearchOperator", + "type": "CompoundType", + "tags": [], + "label": "defaultSearchOperator", + "description": [ + "\nThe search operator to use with the provided filter. Defaults to `OR`" + ], + "signature": [ + "\"AND\" | \"OR\" | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.filter", + "type": "Any", + "tags": [], + "label": "filter", + "description": [], + "signature": [ + "any" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.aggs", + "type": "Object", + "tags": [ + "alpha" + ], + "label": "aggs", + "description": [ + "\nA record of aggregations to perform.\nThe API currently only supports a limited set of metrics and bucket aggregation types.\nAdditional aggregation types can be contributed to Core.\n" + ], + "signature": [ + "Record | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.typeToNamespacesMap", + "type": "Object", + "tags": [], + "label": "typeToNamespacesMap", + "description": [ + "\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace." + ], + "signature": [ + "Map | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.preference", + "type": "string", + "tags": [], + "label": "preference", + "description": [ + "An optional ES preference value to be used for the query" + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptions.pit", + "type": "Object", + "tags": [], + "label": "pit", + "description": [ + "\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}." + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsPitParams", + "text": "SavedObjectsPitParams" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptionsReference", + "type": "Interface", + "tags": [], + "label": "SavedObjectsFindOptionsReference", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptionsReference.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindOptionsReference.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsFindResponse", + "description": [ + "\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindResponse", + "text": "SavedObjectsFindResponse" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindResponse.aggregations", + "type": "Uncategorized", + "tags": [], + "label": "aggregations", + "description": [], + "signature": [ + "A | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindResponse.saved_objects", + "type": "Array", + "tags": [], + "label": "saved_objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindResult", + "text": "SavedObjectsFindResult" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindResponse.total", + "type": "number", + "tags": [], + "label": "total", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindResponse.per_page", + "type": "number", + "tags": [], + "label": "per_page", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindResponse.page", + "type": "number", + "tags": [], + "label": "page", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindResponse.pit_id", + "type": "string", + "tags": [], + "label": "pit_id", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindResult", + "type": "Interface", + "tags": [], + "label": "SavedObjectsFindResult", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindResult", + "text": "SavedObjectsFindResult" + }, + " extends ", + "SavedObject", + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindResult.score", + "type": "number", + "tags": [], + "label": "score", + "description": [ + "\nThe Elasticsearch `_score` of this result." + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsFindResult.sort", + "type": "Array", + "tags": [], + "label": "sort", + "description": [ + "\nThe Elasticsearch `sort` value of this result.\n" + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsIncrementCounterField", + "type": "Interface", + "tags": [], + "label": "SavedObjectsIncrementCounterField", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/increment_counter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsIncrementCounterField.fieldName", + "type": "string", + "tags": [], + "label": "fieldName", + "description": [ + "The field name to increment the counter by." + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/increment_counter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsIncrementCounterField.incrementBy", + "type": "number", + "tags": [], + "label": "incrementBy", + "description": [ + "The number to increment the field by (defaults to 1)." + ], + "signature": [ + "number | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/increment_counter.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsIncrementCounterOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsIncrementCounterOptions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsIncrementCounterOptions", + "text": "SavedObjectsIncrementCounterOptions" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/increment_counter.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsIncrementCounterOptions.initialize", + "type": "CompoundType", + "tags": [], + "label": "initialize", + "description": [ + "\n(default=false) If true, sets all the counter fields to 0 if they don't\nalready exist. Existing fields will be left as-is and won't be incremented." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/increment_counter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsIncrementCounterOptions.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [ + "{@link SavedObjectsMigrationVersion}" + ], + "signature": [ + "SavedObjectsMigrationVersion", + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/increment_counter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsIncrementCounterOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "\n(default='wait_for') The Elasticsearch refresh setting for this\noperation. See {@link MutatingOperationRefreshSetting}" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.MutatingOperationRefreshSetting", + "text": "MutatingOperationRefreshSetting" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/increment_counter.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsIncrementCounterOptions.upsertAttributes", + "type": "Uncategorized", + "tags": [], + "label": "upsertAttributes", + "description": [ + "\nAttributes to use when upserting the document if it doesn't exist." + ], + "signature": [ + "Attributes | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/increment_counter.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsOpenPointInTimeOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsOpenPointInTimeOptions", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/open_point_in_time_for_type.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsOpenPointInTimeOptions.keepAlive", + "type": "string", + "tags": [], + "label": "keepAlive", + "description": [ + "\nOptionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/open_point_in_time_for_type.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsOpenPointInTimeOptions.preference", + "type": "string", + "tags": [], + "label": "preference", + "description": [ + "\nAn optional ES preference value to be used for the query." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/open_point_in_time_for_type.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsOpenPointInTimeOptions.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nAn optional list of namespaces to be used when opening the PIT.\n\nWhen the spaces plugin is enabled:\n - this will default to the user's current space (as determined by the URL)\n - if specified, the user's current space will be ignored\n - `['*']` will search across all available spaces" + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/open_point_in_time_for_type.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsOpenPointInTimeResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsOpenPointInTimeResponse", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/open_point_in_time_for_type.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsOpenPointInTimeResponse.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "\nPIT ID returned from ES." + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/open_point_in_time_for_type.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsPitParams", + "type": "Interface", + "tags": [], + "label": "SavedObjectsPitParams", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsPitParams.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsPitParams.keepAlive", + "type": "string", + "tags": [], + "label": "keepAlive", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsRemoveReferencesToOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsRemoveReferencesToOptions", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToOptions", + "text": "SavedObjectsRemoveReferencesToOptions" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/remove_references_to.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsRemoveReferencesToOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation. Defaults to `true`" + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/remove_references_to.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsRemoveReferencesToResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsRemoveReferencesToResponse", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsRemoveReferencesToResponse", + "text": "SavedObjectsRemoveReferencesToResponse" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/remove_references_to.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsRemoveReferencesToResponse.updated", + "type": "number", + "tags": [], + "label": "updated", + "description": [ + "The number of objects that have been updated by this operation" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/remove_references_to.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsResolveResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsResolveResponse", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsResolveResponse", + "text": "SavedObjectsResolveResponse" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/resolve.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsResolveResponse.saved_object", + "type": "Object", + "tags": [], + "label": "saved_object", + "description": [ + "\nThe saved object that was found." + ], + "signature": [ + "SavedObject", + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/resolve.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsResolveResponse.outcome", + "type": "CompoundType", + "tags": [], + "label": "outcome", + "description": [ + "\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID." + ], + "signature": [ + "\"exactMatch\" | \"aliasMatch\" | \"conflict\"" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/resolve.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsResolveResponse.alias_target_id", + "type": "string", + "tags": [], + "label": "alias_target_id", + "description": [ + "\nThe ID of the object that the legacy URL alias points to.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/resolve.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsResolveResponse.alias_purpose", + "type": "CompoundType", + "tags": [], + "label": "alias_purpose", + "description": [ + "\nThe reason this alias was created.\n\nCurrently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias\nwas created because of saved object conversion, then we will display a toast telling the user that the object has a new URL.\n\n**Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`)." + ], + "signature": [ + "\"savedObjectConversion\" | \"savedObjectImport\" | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/resolve.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateObjectsSpacesObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateObjectsSpacesObject", + "description": [ + "\nAn object that should have its spaces updated.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateObjectsSpacesObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The type of the object to update" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateObjectsSpacesObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "The ID of the object to update" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateObjectsSpacesOptions", + "description": [ + "\nOptions for the update operation.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesOptions", + "text": "SavedObjectsUpdateObjectsSpacesOptions" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateObjectsSpacesOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.MutatingOperationRefreshSetting", + "text": "MutatingOperationRefreshSetting" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateObjectsSpacesResponse", + "description": [ + "\nThe response when objects' spaces are updated.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponse.objects", + "type": "Array", + "tags": [], + "label": "objects", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject", + "text": "SavedObjectsUpdateObjectsSpacesResponseObject" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateObjectsSpacesResponseObject", + "description": [ + "\nDetails about a specific object's update result.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "The type of the referenced object" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of the referenced object" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.spaces", + "type": "Array", + "tags": [], + "label": "spaces", + "description": [ + "The space(s) that the referenced object exists in" + ], + "signature": [ + "string[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateObjectsSpacesResponseObject.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [ + "Included if there was an error updating this object's spaces" + ], + "signature": [ + "SavedObjectError", + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateOptions", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateOptions", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateOptions", + "text": "SavedObjectsUpdateOptions" + }, + " extends ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateOptions.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "\nAn opaque version number which changes on each successful write operation.\nCan be used for implementing optimistic concurrency control." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateOptions.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [ + "{@inheritdoc SavedObjectReference}" + ], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateOptions.refresh", + "type": "CompoundType", + "tags": [], + "label": "refresh", + "description": [ + "The Elasticsearch Refresh setting for this operation" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.MutatingOperationRefreshSetting", + "text": "MutatingOperationRefreshSetting" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateOptions.upsert", + "type": "Uncategorized", + "tags": [], + "label": "upsert", + "description": [ + "If specified, will be used to perform an upsert if the document doesn't exist" + ], + "signature": [ + "Attributes | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateOptions.retryOnConflict", + "type": "number", + "tags": [], + "label": "retryOnConflict", + "description": [ + "\nThe Elasticsearch `retry_on_conflict` setting for this operation.\nDefaults to `0` when `version` is provided, `3` otherwise." + ], + "signature": [ + "number | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsUpdateResponse", + "description": [ + "\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsUpdateResponse", + "text": "SavedObjectsUpdateResponse" + }, + " extends Omit<", + "SavedObject", + ", \"attributes\" | \"references\">" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateResponse.attributes", + "type": "Object", + "tags": [], + "label": "attributes", + "description": [], + "signature": [ + "{ [P in keyof T]?: T[P] | undefined; }" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsUpdateResponse.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "SavedObjectReference", + "[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/update.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.MutatingOperationRefreshSetting", + "type": "Type", + "tags": [], + "label": "MutatingOperationRefreshSetting", + "description": [ + "\nElasticsearch Refresh setting for mutating operation" + ], + "signature": [ + "boolean | \"wait_for\"" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/base.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsClosePointInTimeOptions", + "type": "Type", + "tags": [], + "label": "SavedObjectsClosePointInTimeOptions", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsBaseOptions", + "text": "SavedObjectsBaseOptions" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/close_point_in_time.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-api-server", + "id": "def-server.SavedObjectsCreatePointInTimeFinderOptions", + "type": "Type", + "tags": [], + "label": "SavedObjectsCreatePointInTimeFinderOptions", + "description": [], + "signature": [ + "{ type: string | string[]; filter?: any; search?: string | undefined; aggs?: Record | undefined; fields?: string[] | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: ", + "SortOrder", + " | undefined; searchFields?: string[] | undefined; rootSearchFields?: string[] | undefined; hasReference?: ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + " | ", + { + "pluginId": "@kbn/core-saved-objects-api-server", + "scope": "server", + "docId": "kibKbnCoreSavedObjectsApiServerPluginApi", + "section": "def-server.SavedObjectsFindOptionsReference", + "text": "SavedObjectsFindOptionsReference" + }, + "[] | undefined; hasReferenceOperator?: \"AND\" | \"OR\" | undefined; defaultSearchOperator?: \"AND\" | \"OR\" | undefined; namespaces?: string[] | undefined; typeToNamespacesMap?: Map | undefined; preference?: string | undefined; }" + ], + "path": "packages/core/saved-objects/core-saved-objects-api-server/src/apis/create_point_in_time_finder.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_saved_objects_api_server.mdx b/api_docs/kbn_core_saved_objects_api_server.mdx new file mode 100644 index 0000000000000..173475235e173 --- /dev/null +++ b/api_docs/kbn_core_saved_objects_api_server.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnCoreSavedObjectsApiServerPluginApi +slug: /kibana-dev-docs/api/kbn-core-saved-objects-api-server +title: "@kbn/core-saved-objects-api-server" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-saved-objects-api-server plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-api-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. +--- +import kbnCoreSavedObjectsApiServerObj from './kbn_core_saved_objects_api_server.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 288 | 1 | 125 | 0 | + +## Server + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_saved_objects_common.devdocs.json b/api_docs/kbn_core_saved_objects_common.devdocs.json new file mode 100644 index 0000000000000..603b00a1c52b0 --- /dev/null +++ b/api_docs/kbn_core_saved_objects_common.devdocs.json @@ -0,0 +1,1246 @@ +{ + "id": "@kbn/core-saved-objects-common", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObject", + "type": "Interface", + "tags": [], + "label": "SavedObject", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObject", + "text": "SavedObject" + }, + "" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObject.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObject.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + " The type of Saved Object. Each plugin can define it's own custom Saved Object types." + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObject.version", + "type": "string", + "tags": [], + "label": "version", + "description": [ + "An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObject.updated_at", + "type": "string", + "tags": [], + "label": "updated_at", + "description": [ + "Timestamp of the last time this document had been updated." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObject.error", + "type": "Object", + "tags": [], + "label": "error", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectError", + "text": "SavedObjectError" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObject.attributes", + "type": "Uncategorized", + "tags": [], + "label": "attributes", + "description": [ + "{@inheritdoc SavedObjectAttributes}" + ], + "signature": [ + "T" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObject.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [ + "{@inheritdoc SavedObjectReference}" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectReference", + "text": "SavedObjectReference" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObject.migrationVersion", + "type": "Object", + "tags": [], + "label": "migrationVersion", + "description": [ + "{@inheritdoc SavedObjectsMigrationVersion}" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectsMigrationVersion", + "text": "SavedObjectsMigrationVersion" + }, + " | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObject.coreMigrationVersion", + "type": "string", + "tags": [], + "label": "coreMigrationVersion", + "description": [ + "A semver value that is used when upgrading objects between Kibana versions." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObject.namespaces", + "type": "Array", + "tags": [], + "label": "namespaces", + "description": [ + "\nSpace(s) that this saved object exists in. This attribute is not used for \"global\" saved object types which are registered with\n`namespaceType: 'agnostic'`." + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObject.originId", + "type": "string", + "tags": [], + "label": "originId", + "description": [ + "\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectAttributes", + "type": "Interface", + "tags": [], + "label": "SavedObjectAttributes", + "description": [ + "\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectAttributes.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[key: string]: SavedObjectAttribute", + "description": [], + "signature": [ + "[key: string]: ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttribute", + "text": "SavedObjectAttribute" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectError", + "type": "Interface", + "tags": [], + "label": "SavedObjectError", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectError.error", + "type": "string", + "tags": [], + "label": "error", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectError.message", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectError.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectError.metadata", + "type": "Object", + "tags": [], + "label": "metadata", + "description": [], + "signature": [ + "Record | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectReference", + "type": "Interface", + "tags": [], + "label": "SavedObjectReference", + "description": [ + "\nA reference to another saved object.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectReference.name", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectReference.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectReference.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportActionRequiredWarning", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportActionRequiredWarning", + "description": [ + "\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportActionRequiredWarning.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"action_required\"" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportActionRequiredWarning.message", + "type": "string", + "tags": [], + "label": "message", + "description": [ + "The translated message to display to the user." + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportActionRequiredWarning.actionPath", + "type": "string", + "tags": [], + "label": "actionPath", + "description": [ + "The path (without the basePath) that the user should be redirect to address this warning." + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportActionRequiredWarning.buttonLabel", + "type": "string", + "tags": [], + "label": "buttonLabel", + "description": [ + "An optional label to use for the link button. If unspecified, a default label will be used." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportAmbiguousConflictError", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportAmbiguousConflictError", + "description": [ + "\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite." + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportAmbiguousConflictError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"ambiguous_conflict\"" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportAmbiguousConflictError.destinations", + "type": "Array", + "tags": [], + "label": "destinations", + "description": [], + "signature": [ + "{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportConflictError", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportConflictError", + "description": [ + "\nRepresents a failure to import due to a conflict." + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportConflictError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"conflict\"" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportConflictError.destinationId", + "type": "string", + "tags": [], + "label": "destinationId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportFailure", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportFailure", + "description": [ + "\nRepresents a failure to import." + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportFailure.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportFailure.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportFailure.meta", + "type": "Object", + "tags": [], + "label": "meta", + "description": [], + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportFailure.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [ + "\nIf `overwrite` is specified, an attempt was made to overwrite an existing object." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportFailure.error", + "type": "CompoundType", + "tags": [], + "label": "error", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectsImportConflictError", + "text": "SavedObjectsImportConflictError" + }, + " | ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectsImportAmbiguousConflictError", + "text": "SavedObjectsImportAmbiguousConflictError" + }, + " | ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectsImportUnsupportedTypeError", + "text": "SavedObjectsImportUnsupportedTypeError" + }, + " | ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectsImportMissingReferencesError", + "text": "SavedObjectsImportMissingReferencesError" + }, + " | ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectsImportUnknownError", + "text": "SavedObjectsImportUnknownError" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportMissingReferencesError", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportMissingReferencesError", + "description": [ + "\nRepresents a failure to import due to missing references." + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportMissingReferencesError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"missing_references\"" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportMissingReferencesError.references", + "type": "Array", + "tags": [], + "label": "references", + "description": [], + "signature": [ + "{ type: string; id: string; }[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportResponse", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportResponse", + "description": [ + "\nThe response describing the result of an import." + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportResponse.success", + "type": "boolean", + "tags": [], + "label": "success", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportResponse.successCount", + "type": "number", + "tags": [], + "label": "successCount", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportResponse.successResults", + "type": "Array", + "tags": [], + "label": "successResults", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectsImportSuccess", + "text": "SavedObjectsImportSuccess" + }, + "[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportResponse.warnings", + "type": "Array", + "tags": [], + "label": "warnings", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectsImportWarning", + "text": "SavedObjectsImportWarning" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportResponse.errors", + "type": "Array", + "tags": [], + "label": "errors", + "description": [], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectsImportFailure", + "text": "SavedObjectsImportFailure" + }, + "[] | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportRetry", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportRetry", + "description": [ + "\nDescribes a retry operation for importing a saved object." + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportRetry.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportRetry.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportRetry.overwrite", + "type": "boolean", + "tags": [], + "label": "overwrite", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportRetry.destinationId", + "type": "string", + "tags": [], + "label": "destinationId", + "description": [ + "\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportRetry.replaceReferences", + "type": "Array", + "tags": [], + "label": "replaceReferences", + "description": [], + "signature": [ + "{ type: string; from: string; to: string; }[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportRetry.createNewCopy", + "type": "CompoundType", + "tags": [], + "label": "createNewCopy", + "description": [ + "\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportRetry.ignoreMissingReferences", + "type": "CompoundType", + "tags": [], + "label": "ignoreMissingReferences", + "description": [ + "\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportSimpleWarning", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportSimpleWarning", + "description": [ + "\nA simple informative warning that will be displayed to the user.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportSimpleWarning.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"simple\"" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportSimpleWarning.message", + "type": "string", + "tags": [], + "label": "message", + "description": [ + "The translated message to display to the user" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportSuccess", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportSuccess", + "description": [ + "\nRepresents a successful import." + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportSuccess.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportSuccess.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportSuccess.destinationId", + "type": "string", + "tags": [], + "label": "destinationId", + "description": [ + "\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportSuccess.createNewCopy", + "type": "CompoundType", + "tags": [ + "deprecated" + ], + "label": "createNewCopy", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": true, + "references": [] + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportSuccess.meta", + "type": "Object", + "tags": [], + "label": "meta", + "description": [], + "signature": [ + "{ title?: string | undefined; icon?: string | undefined; }" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportSuccess.overwrite", + "type": "CompoundType", + "tags": [], + "label": "overwrite", + "description": [ + "\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)." + ], + "signature": [ + "boolean | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportUnknownError", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportUnknownError", + "description": [ + "\nRepresents a failure to import due to an unknown reason." + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportUnknownError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"unknown\"" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportUnknownError.message", + "type": "string", + "tags": [], + "label": "message", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportUnknownError.statusCode", + "type": "number", + "tags": [], + "label": "statusCode", + "description": [], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportUnsupportedTypeError", + "type": "Interface", + "tags": [], + "label": "SavedObjectsImportUnsupportedTypeError", + "description": [ + "\nRepresents a failure to import due to having an unsupported saved object type." + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportUnsupportedTypeError.type", + "type": "string", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"unsupported_type\"" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsMigrationVersion", + "type": "Interface", + "tags": [], + "label": "SavedObjectsMigrationVersion", + "description": [ + "\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsMigrationVersion.Unnamed", + "type": "IndexSignature", + "tags": [], + "label": "[pluginName: string]: string", + "description": [], + "signature": [ + "[pluginName: string]: string" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectTypeIdTuple", + "type": "Interface", + "tags": [], + "label": "SavedObjectTypeIdTuple", + "description": [ + "\nAn identifier for a saved object within a space.\n" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectTypeIdTuple.id", + "type": "string", + "tags": [], + "label": "id", + "description": [ + "The id of the saved object" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/types.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectTypeIdTuple.type", + "type": "string", + "tags": [], + "label": "type", + "description": [ + "The type of the saved object" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/types.ts", + "deprecated": false + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectAttribute", + "type": "Type", + "tags": [], + "label": "SavedObjectAttribute", + "description": [ + "\nType definition for a Saved Object attribute value\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributeSingle", + "text": "SavedObjectAttributeSingle" + }, + " | ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributeSingle", + "text": "SavedObjectAttributeSingle" + }, + "[]" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectAttributeSingle", + "type": "Type", + "tags": [], + "label": "SavedObjectAttributeSingle", + "description": [ + "\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n" + ], + "signature": [ + "string | number | boolean | ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectAttributes", + "text": "SavedObjectAttributes" + }, + " | null | undefined" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsImportWarning", + "type": "Type", + "tags": [], + "label": "SavedObjectsImportWarning", + "description": [ + "\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n" + ], + "signature": [ + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectsImportSimpleWarning", + "text": "SavedObjectsImportSimpleWarning" + }, + " | ", + { + "pluginId": "@kbn/core-saved-objects-common", + "scope": "common", + "docId": "kibKbnCoreSavedObjectsCommonPluginApi", + "section": "def-common.SavedObjectsImportActionRequiredWarning", + "text": "SavedObjectsImportActionRequiredWarning" + } + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/core-saved-objects-common", + "id": "def-common.SavedObjectsNamespaceType", + "type": "Type", + "tags": [], + "label": "SavedObjectsNamespaceType", + "description": [ + "\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n" + ], + "signature": [ + "\"single\" | \"multiple\" | \"multiple-isolated\" | \"agnostic\"" + ], + "path": "packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_core_saved_objects_common.mdx b/api_docs/kbn_core_saved_objects_common.mdx new file mode 100644 index 0000000000000..ac95052af68fb --- /dev/null +++ b/api_docs/kbn_core_saved_objects_common.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnCoreSavedObjectsCommonPluginApi +slug: /kibana-dev-docs/api/kbn-core-saved-objects-common +title: "@kbn/core-saved-objects-common" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/core-saved-objects-common plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-saved-objects-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. +--- +import kbnCoreSavedObjectsCommonObj from './kbn_core_saved_objects_common.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 82 | 0 | 41 | 0 | + +## Common + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_core_test_helpers_http_setup_browser.mdx b/api_docs/kbn_core_test_helpers_http_setup_browser.mdx index bfc04759fd1af..3e3c86f6e01a1 100644 --- a/api_docs/kbn_core_test_helpers_http_setup_browser.mdx +++ b/api_docs/kbn_core_test_helpers_http_setup_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-test-helpers-http-setup-browser title: "@kbn/core-test-helpers-http-setup-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-test-helpers-http-setup-browser plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-test-helpers-http-setup-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. --- diff --git a/api_docs/kbn_core_theme_browser.mdx b/api_docs/kbn_core_theme_browser.mdx index 4079008bc27fe..22935daf1d7ef 100644 --- a/api_docs/kbn_core_theme_browser.mdx +++ b/api_docs/kbn_core_theme_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser title: "@kbn/core-theme-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-theme-browser plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-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. --- diff --git a/api_docs/kbn_core_theme_browser_internal.mdx b/api_docs/kbn_core_theme_browser_internal.mdx index 65fdd07253d6c..c210af9335daa 100644 --- a/api_docs/kbn_core_theme_browser_internal.mdx +++ b/api_docs/kbn_core_theme_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-internal title: "@kbn/core-theme-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-theme-browser-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-internal'] 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. --- diff --git a/api_docs/kbn_core_theme_browser_mocks.mdx b/api_docs/kbn_core_theme_browser_mocks.mdx index 87bba69eee64c..0d22f2877fbb9 100644 --- a/api_docs/kbn_core_theme_browser_mocks.mdx +++ b/api_docs/kbn_core_theme_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-theme-browser-mocks title: "@kbn/core-theme-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-theme-browser-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-theme-browser-mocks'] 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. --- diff --git a/api_docs/kbn_core_ui_settings_browser.mdx b/api_docs/kbn_core_ui_settings_browser.mdx index abbf5fcc84603..19dc9b0944cfd 100644 --- a/api_docs/kbn_core_ui_settings_browser.mdx +++ b/api_docs/kbn_core_ui_settings_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser title: "@kbn/core-ui-settings-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-ui-settings-browser plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-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. --- diff --git a/api_docs/kbn_core_ui_settings_browser_internal.mdx b/api_docs/kbn_core_ui_settings_browser_internal.mdx index 447c772e42006..9253e80de7e90 100644 --- a/api_docs/kbn_core_ui_settings_browser_internal.mdx +++ b/api_docs/kbn_core_ui_settings_browser_internal.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser-internal title: "@kbn/core-ui-settings-browser-internal" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-ui-settings-browser-internal plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser-internal'] 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. --- diff --git a/api_docs/kbn_core_ui_settings_browser_mocks.mdx b/api_docs/kbn_core_ui_settings_browser_mocks.mdx index 35d3dfb6d9491..0220f3febde5d 100644 --- a/api_docs/kbn_core_ui_settings_browser_mocks.mdx +++ b/api_docs/kbn_core_ui_settings_browser_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-browser-mocks title: "@kbn/core-ui-settings-browser-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-ui-settings-browser-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-browser-mocks'] 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. --- diff --git a/api_docs/kbn_core_ui_settings_common.mdx b/api_docs/kbn_core_ui_settings_common.mdx index 726cfe303bb15..7356251b31fea 100644 --- a/api_docs/kbn_core_ui_settings_common.mdx +++ b/api_docs/kbn_core_ui_settings_common.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-core-ui-settings-common title: "@kbn/core-ui-settings-common" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/core-ui-settings-common plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/core-ui-settings-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. --- diff --git a/api_docs/kbn_crypto.mdx b/api_docs/kbn_crypto.mdx index 5790208158059..b6a047195ce1d 100644 --- a/api_docs/kbn_crypto.mdx +++ b/api_docs/kbn_crypto.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-crypto title: "@kbn/crypto" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/crypto plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto'] 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. --- diff --git a/api_docs/kbn_crypto_browser.mdx b/api_docs/kbn_crypto_browser.mdx index ea37452a297d8..a4bae66a8f720 100644 --- a/api_docs/kbn_crypto_browser.mdx +++ b/api_docs/kbn_crypto_browser.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-crypto-browser title: "@kbn/crypto-browser" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/crypto-browser plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/crypto-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. --- diff --git a/api_docs/kbn_datemath.mdx b/api_docs/kbn_datemath.mdx index a63ad54dc1990..25f549f8016e2 100644 --- a/api_docs/kbn_datemath.mdx +++ b/api_docs/kbn_datemath.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-datemath title: "@kbn/datemath" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/datemath plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/datemath'] 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. --- diff --git a/api_docs/kbn_dev_cli_errors.mdx b/api_docs/kbn_dev_cli_errors.mdx index 441415f638b09..25d3411219036 100644 --- a/api_docs/kbn_dev_cli_errors.mdx +++ b/api_docs/kbn_dev_cli_errors.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-errors title: "@kbn/dev-cli-errors" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-cli-errors plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-errors'] 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. --- diff --git a/api_docs/kbn_dev_cli_runner.mdx b/api_docs/kbn_dev_cli_runner.mdx index 6eb94c110fc6c..28be2d7cf8936 100644 --- a/api_docs/kbn_dev_cli_runner.mdx +++ b/api_docs/kbn_dev_cli_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-cli-runner title: "@kbn/dev-cli-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-cli-runner plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-cli-runner'] 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. --- diff --git a/api_docs/kbn_dev_proc_runner.mdx b/api_docs/kbn_dev_proc_runner.mdx index 6da72300a846f..e7845b9779020 100644 --- a/api_docs/kbn_dev_proc_runner.mdx +++ b/api_docs/kbn_dev_proc_runner.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-proc-runner title: "@kbn/dev-proc-runner" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-proc-runner plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-proc-runner'] 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. --- diff --git a/api_docs/kbn_dev_utils.mdx b/api_docs/kbn_dev_utils.mdx index a2291b31698d8..920868038a2c1 100644 --- a/api_docs/kbn_dev_utils.mdx +++ b/api_docs/kbn_dev_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-dev-utils title: "@kbn/dev-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/dev-utils plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/dev-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. --- diff --git a/api_docs/kbn_doc_links.devdocs.json b/api_docs/kbn_doc_links.devdocs.json index 75ecd04cd953b..79827ba5d0529 100644 --- a/api_docs/kbn_doc_links.devdocs.json +++ b/api_docs/kbn_doc_links.devdocs.json @@ -282,7 +282,7 @@ "label": "enterpriseSearch", "description": [], "signature": [ - "{ readonly configuration: string; readonly licenseManagement: string; readonly mailService: string; readonly troubleshootSetup: string; readonly usersAccess: string; }" + "{ readonly bulkApi: string; readonly configuration: string; readonly crawlerGettingStarted: string; readonly crawlerManaging: string; readonly crawlerOverview: string; readonly languageAnalyzers: string; readonly licenseManagement: string; readonly mailService: string; readonly troubleshootSetup: string; readonly usersAccess: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false @@ -510,7 +510,7 @@ "label": "securitySolution", "description": [], "signature": [ - "{ readonly trustedApps: string; readonly eventFilters: string; readonly blocklist: string; readonly policyResponseTroubleshooting: { full_disk_access: string; macos_system_ext: string; }; }" + "{ readonly trustedApps: string; readonly eventFilters: string; readonly blocklist: string; readonly policyResponseTroubleshooting: { full_disk_access: string; macos_system_ext: string; linux_deadlock: string; }; readonly threatIntelInt: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false @@ -770,7 +770,7 @@ "label": "fleet", "description": [], "signature": [ - "{ readonly beatsAgentComparison: string; readonly guide: string; readonly fleetServer: string; readonly fleetServerAddFleetServer: string; readonly settings: string; readonly settingsFleetServerHostSettings: string; readonly settingsFleetServerProxySettings: string; readonly troubleshooting: string; readonly elasticAgent: string; readonly datastreams: string; readonly datastreamsILM: string; readonly datastreamsNamingScheme: string; readonly installElasticAgent: string; readonly installElasticAgentStandalone: string; readonly upgradeElasticAgent: string; readonly learnMoreBlog: string; readonly apiKeysLearnMore: string; readonly onPremRegistry: string; readonly secureLogstash: string; readonly agentPolicy: string; }" + "{ readonly beatsAgentComparison: string; readonly guide: string; readonly fleetServer: string; readonly fleetServerAddFleetServer: string; readonly settings: string; readonly settingsFleetServerHostSettings: string; readonly settingsFleetServerProxySettings: string; readonly troubleshooting: string; readonly elasticAgent: string; readonly datastreams: string; readonly datastreamsILM: string; readonly datastreamsNamingScheme: string; readonly installElasticAgent: string; readonly installElasticAgentStandalone: string; readonly packageSignatures: string; readonly upgradeElasticAgent: string; readonly learnMoreBlog: string; readonly apiKeysLearnMore: string; readonly onPremRegistry: string; readonly secureLogstash: string; readonly agentPolicy: string; }" ], "path": "packages/kbn-doc-links/src/types.ts", "deprecated": false diff --git a/api_docs/kbn_doc_links.mdx b/api_docs/kbn_doc_links.mdx index aa388e93b05ab..fd83ba202a921 100644 --- a/api_docs/kbn_doc_links.mdx +++ b/api_docs/kbn_doc_links.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-doc-links title: "@kbn/doc-links" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/doc-links plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/doc-links'] 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. --- diff --git a/api_docs/kbn_docs_utils.mdx b/api_docs/kbn_docs_utils.mdx index c3ea7e5bb066f..19e290788ef77 100644 --- a/api_docs/kbn_docs_utils.mdx +++ b/api_docs/kbn_docs_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-docs-utils title: "@kbn/docs-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/docs-utils plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/docs-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. --- diff --git a/api_docs/kbn_es_archiver.mdx b/api_docs/kbn_es_archiver.mdx index 37a042bd92260..84b10adbc2373 100644 --- a/api_docs/kbn_es_archiver.mdx +++ b/api_docs/kbn_es_archiver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-archiver title: "@kbn/es-archiver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-archiver plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-archiver'] 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. --- diff --git a/api_docs/kbn_es_errors.mdx b/api_docs/kbn_es_errors.mdx index 70341c11f5b06..a92ad78f151c6 100644 --- a/api_docs/kbn_es_errors.mdx +++ b/api_docs/kbn_es_errors.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-errors title: "@kbn/es-errors" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-errors plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-errors'] 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. --- diff --git a/api_docs/kbn_es_query.devdocs.json b/api_docs/kbn_es_query.devdocs.json index 4aad64c7da526..d7a24b8740064 100644 --- a/api_docs/kbn_es_query.devdocs.json +++ b/api_docs/kbn_es_query.devdocs.json @@ -293,23 +293,7 @@ "section": "def-common.DataViewBase", "text": "DataViewBase" }, - " | undefined, queries: ", - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.Query", - "text": "Query" - }, - " | ", - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.Query", - "text": "Query" - }, - "[], filters: ", + " | undefined, queries: AnyQuery | AnyQuery[], filters: ", { "pluginId": "@kbn/es-query", "scope": "common", @@ -377,22 +361,7 @@ "- a query object or array of query objects. Each query has a language property and a query property." ], "signature": [ - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.Query", - "text": "Query" - }, - " | ", - { - "pluginId": "@kbn/es-query", - "scope": "common", - "docId": "kibKbnEsQueryPluginApi", - "section": "def-common.Query", - "text": "Query" - }, - "[]" + "AnyQuery | AnyQuery[]" ], "path": "packages/kbn-es-query/src/es_query/build_es_query.ts", "deprecated": false, @@ -1964,6 +1933,51 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.getAggregateQueryMode", + "type": "Function", + "tags": [], + "label": "getAggregateQueryMode", + "description": [], + "signature": [ + "(query: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.AggregateQuery", + "text": "AggregateQuery" + }, + ") => never" + ], + "path": "packages/kbn-es-query/src/es_query/es_query_sql.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.getAggregateQueryMode.$1", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.AggregateQuery", + "text": "AggregateQuery" + } + ], + "path": "packages/kbn-es-query/src/es_query/es_query_sql.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/es-query", "id": "def-common.getDataViewFieldSubtypeMulti", @@ -2042,6 +2056,37 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.getIndexPatternFromSQLQuery", + "type": "Function", + "tags": [], + "label": "getIndexPatternFromSQLQuery", + "description": [], + "signature": [ + "(sqlQuery: string | undefined) => string" + ], + "path": "packages/kbn-es-query/src/es_query/es_query_sql.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.getIndexPatternFromSQLQuery.$1", + "type": "string", + "tags": [], + "label": "sqlQuery", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-es-query/src/es_query/es_query_sql.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/es-query", "id": "def-common.isDataViewFieldSubtypeMulti", @@ -2389,6 +2434,130 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.isOfAggregateQueryType", + "type": "Function", + "tags": [], + "label": "isOfAggregateQueryType", + "description": [], + "signature": [ + "(query: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.AggregateQuery", + "text": "AggregateQuery" + }, + " | { [key: string]: any; }) => boolean" + ], + "path": "packages/kbn-es-query/src/es_query/es_query_sql.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.isOfAggregateQueryType.$1", + "type": "CompoundType", + "tags": [], + "label": "query", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.AggregateQuery", + "text": "AggregateQuery" + }, + " | { [key: string]: any; }" + ], + "path": "packages/kbn-es-query/src/es_query/es_query_sql.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.isOfQueryType", + "type": "Function", + "tags": [], + "label": "isOfQueryType", + "description": [], + "signature": [ + "(arg: ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.AggregateQuery", + "text": "AggregateQuery" + }, + " | undefined) => boolean" + ], + "path": "packages/kbn-es-query/src/es_query/es_query_sql.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.isOfQueryType.$1", + "type": "CompoundType", + "tags": [], + "label": "arg", + "description": [], + "signature": [ + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.Query", + "text": "Query" + }, + " | ", + { + "pluginId": "@kbn/es-query", + "scope": "common", + "docId": "kibKbnEsQueryPluginApi", + "section": "def-common.AggregateQuery", + "text": "AggregateQuery" + }, + " | undefined" + ], + "path": "packages/kbn-es-query/src/es_query/es_query_sql.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/es-query", "id": "def-common.isPhraseFilter", @@ -3858,6 +4027,20 @@ } ], "misc": [ + { + "parentPluginId": "@kbn/es-query", + "id": "def-common.AggregateQuery", + "type": "Type", + "tags": [], + "label": "AggregateQuery", + "description": [], + "signature": [ + "{ sql: string; } | { esql: string; }" + ], + "path": "packages/kbn-es-query/src/filters/build_filters/types.ts", + "deprecated": false, + "initialIsOpen": false + }, { "parentPluginId": "@kbn/es-query", "id": "def-common.CustomFilter", diff --git a/api_docs/kbn_es_query.mdx b/api_docs/kbn_es_query.mdx index f026f2aaffe96..0c31b6e2a5f3e 100644 --- a/api_docs/kbn_es_query.mdx +++ b/api_docs/kbn_es_query.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-es-query title: "@kbn/es-query" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/es-query plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/es-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 [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 213 | 1 | 159 | 12 | +| 222 | 1 | 168 | 12 | ## Common diff --git a/api_docs/kbn_eslint_plugin_imports.mdx b/api_docs/kbn_eslint_plugin_imports.mdx index 3a0976af09b77..097bbe8664678 100644 --- a/api_docs/kbn_eslint_plugin_imports.mdx +++ b/api_docs/kbn_eslint_plugin_imports.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-eslint-plugin-imports title: "@kbn/eslint-plugin-imports" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/eslint-plugin-imports plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/eslint-plugin-imports'] 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. --- diff --git a/api_docs/kbn_field_types.mdx b/api_docs/kbn_field_types.mdx index cfef42f78d2ca..a331e2064642b 100644 --- a/api_docs/kbn_field_types.mdx +++ b/api_docs/kbn_field_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-field-types title: "@kbn/field-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/field-types plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/field-types'] 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. --- diff --git a/api_docs/kbn_find_used_node_modules.mdx b/api_docs/kbn_find_used_node_modules.mdx index 215c427b5191f..6a1e2ca8b74ae 100644 --- a/api_docs/kbn_find_used_node_modules.mdx +++ b/api_docs/kbn_find_used_node_modules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-find-used-node-modules title: "@kbn/find-used-node-modules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/find-used-node-modules plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/find-used-node-modules'] 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. --- diff --git a/api_docs/kbn_generate.mdx b/api_docs/kbn_generate.mdx index e8b12b3e9b4af..e2d2f92ccb996 100644 --- a/api_docs/kbn_generate.mdx +++ b/api_docs/kbn_generate.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-generate title: "@kbn/generate" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/generate plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/generate'] 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. --- diff --git a/api_docs/kbn_get_repo_files.devdocs.json b/api_docs/kbn_get_repo_files.devdocs.json new file mode 100644 index 0000000000000..9eb2249f94ac6 --- /dev/null +++ b/api_docs/kbn_get_repo_files.devdocs.json @@ -0,0 +1,79 @@ +{ + "id": "@kbn/get-repo-files", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/get-repo-files", + "id": "def-server.getRepoFiles", + "type": "Function", + "tags": [], + "label": "getRepoFiles", + "description": [ + "\nList the files in the repo, only including files which are manged by version\ncontrol or \"untracked\" (new, not committed, and not ignored)." + ], + "signature": [ + "(include: string[] | undefined, exclude: string[] | undefined) => Promise>" + ], + "path": "packages/kbn-get-repo-files/src/get_repo_files.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/get-repo-files", + "id": "def-server.getRepoFiles.$1", + "type": "Array", + "tags": [], + "label": "include", + "description": [ + "limit the list to specfic absolute paths" + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/kbn-get-repo-files/src/get_repo_files.ts", + "deprecated": false, + "isRequired": false + }, + { + "parentPluginId": "@kbn/get-repo-files", + "id": "def-server.getRepoFiles.$2", + "type": "Array", + "tags": [], + "label": "exclude", + "description": [ + "exclude specific absolute paths" + ], + "signature": [ + "string[] | undefined" + ], + "path": "packages/kbn-get-repo-files/src/get_repo_files.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_get_repo_files.mdx b/api_docs/kbn_get_repo_files.mdx new file mode 100644 index 0000000000000..3d1a17c3db6fa --- /dev/null +++ b/api_docs/kbn_get_repo_files.mdx @@ -0,0 +1,27 @@ +--- +id: kibKbnGetRepoFilesPluginApi +slug: /kibana-dev-docs/api/kbn-get-repo-files +title: "@kbn/get-repo-files" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/get-repo-files plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/get-repo-files'] +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. +--- +import kbnGetRepoFilesObj from './kbn_get_repo_files.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 3 | 0 | 0 | 0 | + +## Server + +### Functions + + diff --git a/api_docs/kbn_handlebars.mdx b/api_docs/kbn_handlebars.mdx index e219c44e50f5e..89ffe62ce3795 100644 --- a/api_docs/kbn_handlebars.mdx +++ b/api_docs/kbn_handlebars.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-handlebars title: "@kbn/handlebars" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/handlebars plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/handlebars'] 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. --- diff --git a/api_docs/kbn_hapi_mocks.mdx b/api_docs/kbn_hapi_mocks.mdx index 1c34fb6d61d27..6084a1ed3f988 100644 --- a/api_docs/kbn_hapi_mocks.mdx +++ b/api_docs/kbn_hapi_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-hapi-mocks title: "@kbn/hapi-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/hapi-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/hapi-mocks'] 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. --- diff --git a/api_docs/kbn_home_sample_data_card.devdocs.json b/api_docs/kbn_home_sample_data_card.devdocs.json new file mode 100644 index 0000000000000..4297b7ded9eb5 --- /dev/null +++ b/api_docs/kbn_home_sample_data_card.devdocs.json @@ -0,0 +1,614 @@ +{ + "id": "@kbn/home-sample-data-card", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.getMockDataSet", + "type": "Function", + "tags": [], + "label": "getMockDataSet", + "description": [ + "\nCustomize the Sample Data Set mock." + ], + "signature": [ + "(params?: Partial<", + "SampleDataSet", + ">) => { appLinks: ", + "AppLink", + "[]; defaultIndex: string; description: string; id: string; name: string; overviewDashboard: string; previewImagePath: string; darkPreviewImagePath?: string | undefined; iconPath?: string | undefined; status?: ", + "InstalledStatus", + " | undefined; statusMsg?: string | undefined; }" + ], + "path": "packages/home/sample_data_card/src/mocks/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.getMockDataSet.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + "Partial<", + "SampleDataSet", + ">" + ], + "path": "packages/home/sample_data_card/src/mocks/index.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.getStoryArgTypes", + "type": "Function", + "tags": [], + "label": "getStoryArgTypes", + "description": [ + "\nReturns the Storybook arguments for `SampleDataCard`, for its stories and for\nconsuming component stories." + ], + "signature": [ + "() => { name: { control: { type: string; }; defaultValue: string; }; description: { control: { type: string; }; defaultValue: string; }; status: { options: (string | undefined)[]; control: { type: string; }; defaultValue: ", + "InstalledStatus", + " | undefined; }; includeAppLinks: { control: string; defaultValue: boolean; }; simulateErrors: { control: string; defaultValue: boolean; }; }" + ], + "path": "packages/home/sample_data_card/src/mocks/index.ts", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.getStoryServices", + "type": "Function", + "tags": [], + "label": "getStoryServices", + "description": [ + "\nReturns Storybook-compatible service abstractions for the `SampleDataCard` Provider." + ], + "signature": [ + "(params: ", + { + "pluginId": "@kbn/home-sample-data-card", + "scope": "common", + "docId": "kibKbnHomeSampleDataCardPluginApi", + "section": "def-common.Params", + "text": "Params" + }, + ") => ", + { + "pluginId": "@kbn/home-sample-data-card", + "scope": "common", + "docId": "kibKbnHomeSampleDataCardPluginApi", + "section": "def-common.Services", + "text": "Services" + } + ], + "path": "packages/home/sample_data_card/src/mocks/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.getStoryServices.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [], + "signature": [ + { + "pluginId": "@kbn/home-sample-data-card", + "scope": "common", + "docId": "kibKbnHomeSampleDataCardPluginApi", + "section": "def-common.Params", + "text": "Params" + } + ], + "path": "packages/home/sample_data_card/src/mocks/index.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.SampleDataCard", + "type": "Function", + "tags": [], + "label": "SampleDataCard", + "description": [ + "\nA card representing a Sample Data Set that can be installed. Uses Kibana services to\ndisplay and install the data set. Requires a `SampleDataCardProvider` to render and\nfunction." + ], + "signature": [ + "({ sampleDataSet, onStatusChange }: ", + { + "pluginId": "@kbn/home-sample-data-card", + "scope": "common", + "docId": "kibKbnHomeSampleDataCardPluginApi", + "section": "def-common.Props", + "text": "Props" + }, + ") => JSX.Element" + ], + "path": "packages/home/sample_data_card/src/sample_data_card.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.SampleDataCard.$1", + "type": "Object", + "tags": [], + "label": "{ sampleDataSet, onStatusChange }", + "description": [], + "signature": [ + { + "pluginId": "@kbn/home-sample-data-card", + "scope": "common", + "docId": "kibKbnHomeSampleDataCardPluginApi", + "section": "def-common.Props", + "text": "Props" + } + ], + "path": "packages/home/sample_data_card/src/sample_data_card.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.SampleDataCardKibanaProvider", + "type": "Function", + "tags": [], + "label": "SampleDataCardKibanaProvider", + "description": [ + "\nKibana-specific Provider that maps dependencies to services." + ], + "signature": [ + "({ children, ...dependencies }: React.PropsWithChildren<", + { + "pluginId": "@kbn/home-sample-data-card", + "scope": "common", + "docId": "kibKbnHomeSampleDataCardPluginApi", + "section": "def-common.KibanaDependencies", + "text": "KibanaDependencies" + }, + ">) => JSX.Element" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.SampleDataCardKibanaProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{\n children,\n ...dependencies\n}", + "description": [], + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "@kbn/home-sample-data-card", + "scope": "common", + "docId": "kibKbnHomeSampleDataCardPluginApi", + "section": "def-common.KibanaDependencies", + "text": "KibanaDependencies" + }, + ">" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.SampleDataCardProvider", + "type": "Function", + "tags": [], + "label": "SampleDataCardProvider", + "description": [ + "\nA Context Provider that provides services to the component and its dependencies." + ], + "signature": [ + "({ children, ...services }: React.PropsWithChildren<", + { + "pluginId": "@kbn/home-sample-data-card", + "scope": "common", + "docId": "kibKbnHomeSampleDataCardPluginApi", + "section": "def-common.Services", + "text": "Services" + }, + ">) => JSX.Element" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.SampleDataCardProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{ children, ...services }", + "description": [], + "signature": [ + "React.PropsWithChildren<", + { + "pluginId": "@kbn/home-sample-data-card", + "scope": "common", + "docId": "kibKbnHomeSampleDataCardPluginApi", + "section": "def-common.Services", + "text": "Services" + }, + ">" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.KibanaDependencies", + "type": "Interface", + "tags": [], + "label": "KibanaDependencies", + "description": [], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.KibanaDependencies.coreStart", + "type": "Object", + "tags": [], + "label": "coreStart", + "description": [], + "signature": [ + "{ application: { navigateToUrl: NavigateToUrl; }; http: { basePath: { prepend: (path: string) => string; }; delete: (path: string) => Promise; post: (path: string) => Promise; }; notifications: { toasts: { addDanger: NotifyFn; addSuccess: NotifyFn; }; }; uiSettings: { get: (key: string, defaultOverride?: any) => any; isDefault: (key: string) => boolean; set: (key: string, value: any) => Promise; }; }" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.KibanaDependencies.dataViews", + "type": "Object", + "tags": [], + "label": "dataViews", + "description": [], + "signature": [ + "{ clearCache: () => void; }" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Props", + "type": "Interface", + "tags": [], + "label": "Props", + "description": [ + "\nProps for the `SampleDataCard` component." + ], + "signature": [ + { + "pluginId": "@kbn/home-sample-data-card", + "scope": "common", + "docId": "kibKbnHomeSampleDataCardPluginApi", + "section": "def-common.Props", + "text": "Props" + }, + " extends Pick<", + { + "pluginId": "@kbn/home-sample-data-card", + "scope": "common", + "docId": "kibKbnHomeSampleDataCardPluginApi", + "section": "def-common.Props", + "text": "Props" + }, + ", \"onStatusChange\">" + ], + "path": "packages/home/sample_data_card/src/sample_data_card.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Props.sampleDataSet", + "type": "Object", + "tags": [], + "label": "sampleDataSet", + "description": [ + "A Sample Data Set to display." + ], + "signature": [ + "SampleDataSet" + ], + "path": "packages/home/sample_data_card/src/sample_data_card.tsx", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services", + "type": "Interface", + "tags": [], + "label": "Services", + "description": [ + "\nA list of services that are consumed by this component." + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.addBasePath", + "type": "Function", + "tags": [], + "label": "addBasePath", + "description": [], + "signature": [ + "(path: string) => string" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.addBasePath.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.getAppNavigationHandler", + "type": "Function", + "tags": [], + "label": "getAppNavigationHandler", + "description": [], + "signature": [ + "(path: string) => React.MouseEventHandler" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.getAppNavigationHandler.$1", + "type": "string", + "tags": [], + "label": "path", + "description": [], + "signature": [ + "string" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.installSampleDataSet", + "type": "Function", + "tags": [], + "label": "installSampleDataSet", + "description": [], + "signature": [ + "(id: string, defaultIndex: string) => Promise" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.installSampleDataSet.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.installSampleDataSet.$2", + "type": "string", + "tags": [], + "label": "defaultIndex", + "description": [], + "signature": [ + "string" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.notifyError", + "type": "Function", + "tags": [], + "label": "notifyError", + "description": [], + "signature": [ + "(notification: NotifyInput) => void" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.notifyError.$1", + "type": "CompoundType", + "tags": [], + "label": "notification", + "description": [], + "signature": [ + "string | NotifyInputFields" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.notifySuccess", + "type": "Function", + "tags": [], + "label": "notifySuccess", + "description": [], + "signature": [ + "(notification: NotifyInput) => void" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.notifySuccess.$1", + "type": "CompoundType", + "tags": [], + "label": "notification", + "description": [], + "signature": [ + "string | NotifyInputFields" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false + } + ] + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.removeSampleDataSet", + "type": "Function", + "tags": [], + "label": "removeSampleDataSet", + "description": [], + "signature": [ + "(id: string, defaultIndex: string) => Promise" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.removeSampleDataSet.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Services.removeSampleDataSet.$2", + "type": "string", + "tags": [], + "label": "defaultIndex", + "description": [], + "signature": [ + "string" + ], + "path": "packages/home/sample_data_card/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/home-sample-data-card", + "id": "def-common.Params", + "type": "Type", + "tags": [], + "label": "Params", + "description": [ + "\nParameters drawn from the Storybook arguments collection that customize a component story." + ], + "signature": [ + "{ status: any; name: any; description: any; includeAppLinks: any; simulateErrors: any; }" + ], + "path": "packages/home/sample_data_card/src/mocks/index.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_home_sample_data_card.mdx b/api_docs/kbn_home_sample_data_card.mdx new file mode 100644 index 0000000000000..c13fd783b8e58 --- /dev/null +++ b/api_docs/kbn_home_sample_data_card.mdx @@ -0,0 +1,33 @@ +--- +id: kibKbnHomeSampleDataCardPluginApi +slug: /kibana-dev-docs/api/kbn-home-sample-data-card +title: "@kbn/home-sample-data-card" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/home-sample-data-card plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/home-sample-data-card'] +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. +--- +import kbnHomeSampleDataCardObj from './kbn_home_sample_data_card.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 32 | 0 | 22 | 0 | + +## Common + +### Functions + + +### Interfaces + + +### Consts, variables and types + + diff --git a/api_docs/kbn_home_sample_data_cards.devdocs.json b/api_docs/kbn_home_sample_data_cards.devdocs.json deleted file mode 100644 index 63811e7574da2..0000000000000 --- a/api_docs/kbn_home_sample_data_cards.devdocs.json +++ /dev/null @@ -1,241 +0,0 @@ -{ - "id": "@kbn/home-sample-data-cards", - "client": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - }, - "server": { - "classes": [], - "functions": [], - "interfaces": [], - "enums": [], - "misc": [], - "objects": [] - }, - "common": { - "classes": [], - "functions": [ - { - "parentPluginId": "@kbn/home-sample-data-cards", - "id": "def-common.SampleDataCard", - "type": "Function", - "tags": [], - "label": "SampleDataCard", - "description": [ - "\nA card representing a Sample Data Set that can be installed. Uses Kibana services to\ndisplay and install the data set. Requires a `SampleDataCardsProvider` to render and\nfunction." - ], - "signature": [ - "({ sampleDataSet, onStatusChange }: ", - { - "pluginId": "@kbn/home-sample-data-cards", - "scope": "common", - "docId": "kibKbnHomeSampleDataCardsPluginApi", - "section": "def-common.Props", - "text": "Props" - }, - ") => JSX.Element" - ], - "path": "packages/home/sample_data_cards/src/sample_data_card.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/home-sample-data-cards", - "id": "def-common.SampleDataCard.$1", - "type": "Object", - "tags": [], - "label": "{ sampleDataSet, onStatusChange }", - "description": [], - "signature": [ - { - "pluginId": "@kbn/home-sample-data-cards", - "scope": "common", - "docId": "kibKbnHomeSampleDataCardsPluginApi", - "section": "def-common.Props", - "text": "Props" - } - ], - "path": "packages/home/sample_data_cards/src/sample_data_card.tsx", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/home-sample-data-cards", - "id": "def-common.SampleDataCards", - "type": "Function", - "tags": [], - "label": "SampleDataCards", - "description": [ - "\nFetches and displays a collection of Sample Data Sets in a grid." - ], - "signature": [ - "({ columns }: ", - { - "pluginId": "@kbn/home-sample-data-cards", - "scope": "common", - "docId": "kibKbnHomeSampleDataCardsPluginApi", - "section": "def-common.Props", - "text": "Props" - }, - ") => JSX.Element" - ], - "path": "packages/home/sample_data_cards/src/sample_data_cards.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/home-sample-data-cards", - "id": "def-common.SampleDataCards.$1", - "type": "Object", - "tags": [], - "label": "{ columns = 3 }", - "description": [], - "signature": [ - { - "pluginId": "@kbn/home-sample-data-cards", - "scope": "common", - "docId": "kibKbnHomeSampleDataCardsPluginApi", - "section": "def-common.Props", - "text": "Props" - } - ], - "path": "packages/home/sample_data_cards/src/sample_data_cards.tsx", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/home-sample-data-cards", - "id": "def-common.SampleDataCardsKibanaProvider", - "type": "Function", - "tags": [], - "label": "SampleDataCardsKibanaProvider", - "description": [ - "\nKibana-specific Provider that maps dependencies to services." - ], - "signature": [ - "({ children, ...dependencies }: React.PropsWithChildren) => JSX.Element" - ], - "path": "packages/home/sample_data_cards/src/services.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/home-sample-data-cards", - "id": "def-common.SampleDataCardsKibanaProvider.$1", - "type": "CompoundType", - "tags": [], - "label": "{\n children,\n ...dependencies\n}", - "description": [], - "signature": [ - "React.PropsWithChildren" - ], - "path": "packages/home/sample_data_cards/src/services.tsx", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - }, - { - "parentPluginId": "@kbn/home-sample-data-cards", - "id": "def-common.SampleDataCardsProvider", - "type": "Function", - "tags": [], - "label": "SampleDataCardsProvider", - "description": [ - "\nA Context Provider that provides services to the component and its dependencies." - ], - "signature": [ - "({ children, ...services }: React.PropsWithChildren<", - "Services", - ">) => JSX.Element" - ], - "path": "packages/home/sample_data_cards/src/services.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/home-sample-data-cards", - "id": "def-common.SampleDataCardsProvider.$1", - "type": "CompoundType", - "tags": [], - "label": "{ children, ...services }", - "description": [], - "signature": [ - "React.PropsWithChildren<", - "Services", - ">" - ], - "path": "packages/home/sample_data_cards/src/services.tsx", - "deprecated": false, - "isRequired": true - } - ], - "returnComment": [], - "initialIsOpen": false - } - ], - "interfaces": [ - { - "parentPluginId": "@kbn/home-sample-data-cards", - "id": "def-common.Props", - "type": "Interface", - "tags": [], - "label": "Props", - "description": [ - "\nProps for the `SampleDataCard` component." - ], - "signature": [ - { - "pluginId": "@kbn/home-sample-data-cards", - "scope": "common", - "docId": "kibKbnHomeSampleDataCardsPluginApi", - "section": "def-common.Props", - "text": "Props" - }, - " extends Pick<", - { - "pluginId": "@kbn/home-sample-data-cards", - "scope": "common", - "docId": "kibKbnHomeSampleDataCardsPluginApi", - "section": "def-common.Props", - "text": "Props" - }, - ", \"onStatusChange\">" - ], - "path": "packages/home/sample_data_cards/src/sample_data_card.tsx", - "deprecated": false, - "children": [ - { - "parentPluginId": "@kbn/home-sample-data-cards", - "id": "def-common.Props.sampleDataSet", - "type": "Object", - "tags": [], - "label": "sampleDataSet", - "description": [ - "A Sample Data Set to display." - ], - "signature": [ - "SampleDataSet" - ], - "path": "packages/home/sample_data_cards/src/sample_data_card.tsx", - "deprecated": false - } - ], - "initialIsOpen": false - } - ], - "enums": [], - "misc": [], - "objects": [] - } -} \ No newline at end of file diff --git a/api_docs/kbn_home_sample_data_tab.devdocs.json b/api_docs/kbn_home_sample_data_tab.devdocs.json new file mode 100644 index 0000000000000..1de6c1bec06e8 --- /dev/null +++ b/api_docs/kbn_home_sample_data_tab.devdocs.json @@ -0,0 +1,169 @@ +{ + "id": "@kbn/home-sample-data-tab", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [ + { + "parentPluginId": "@kbn/home-sample-data-tab", + "id": "def-common.SampleDataTab", + "type": "Function", + "tags": [], + "label": "SampleDataTab", + "description": [ + "\nThe content for the Sample Data Tab in the `home` plugin." + ], + "signature": [ + "() => JSX.Element" + ], + "path": "packages/home/sample_data_tab/src/sample_data_tab.tsx", + "deprecated": false, + "children": [], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/home-sample-data-tab", + "id": "def-common.SampleDataTabKibanaProvider", + "type": "Function", + "tags": [], + "label": "SampleDataTabKibanaProvider", + "description": [ + "\nKibana-specific Provider that maps dependencies to services." + ], + "signature": [ + "({ children, ...dependencies }: React.PropsWithChildren<", + "SampleDataTabKibanaDependencies", + ">) => JSX.Element" + ], + "path": "packages/home/sample_data_tab/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-tab", + "id": "def-common.SampleDataTabKibanaProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{\n children,\n ...dependencies\n}", + "description": [], + "signature": [ + "React.PropsWithChildren<", + "SampleDataTabKibanaDependencies", + ">" + ], + "path": "packages/home/sample_data_tab/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/home-sample-data-tab", + "id": "def-common.SampleDataTabProvider", + "type": "Function", + "tags": [], + "label": "SampleDataTabProvider", + "description": [ + "\nA Context Provider that provides services to the component and its dependencies." + ], + "signature": [ + "({ children, ...services }: React.PropsWithChildren<", + "SampleDataTabServices", + ">) => JSX.Element" + ], + "path": "packages/home/sample_data_tab/src/services.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/home-sample-data-tab", + "id": "def-common.SampleDataTabProvider.$1", + "type": "CompoundType", + "tags": [], + "label": "{ children, ...services }", + "description": [], + "signature": [ + "React.PropsWithChildren<", + "SampleDataTabServices", + ">" + ], + "path": "packages/home/sample_data_tab/src/services.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + } + ], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/home-sample-data-tab", + "id": "def-common.DATA_TEST_SUBJ_DEMO_ENV_BUTTON", + "type": "string", + "tags": [], + "label": "DATA_TEST_SUBJ_DEMO_ENV_BUTTON", + "description": [ + "\nTest Subject name for the Demo Environment button." + ], + "signature": [ + "\"goToDemoEnvButton\"" + ], + "path": "packages/home/sample_data_tab/src/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/home-sample-data-tab", + "id": "def-common.DATA_TEST_SUBJ_SHOW_SAMPLE_DATA_ACCORDION", + "type": "string", + "tags": [], + "label": "DATA_TEST_SUBJ_SHOW_SAMPLE_DATA_ACCORDION", + "description": [ + "\nTest Subject name for the sample data accordion button." + ], + "signature": [ + "\"showSampleDataAccordion\"" + ], + "path": "packages/home/sample_data_tab/src/constants.ts", + "deprecated": false, + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/home-sample-data-tab", + "id": "def-common.DATA_TEST_SUBJ_SHOW_SAMPLE_DATA_BUTTON", + "type": "string", + "tags": [], + "label": "DATA_TEST_SUBJ_SHOW_SAMPLE_DATA_BUTTON", + "description": [ + "\nTest Subject name for the sample data accordion button." + ], + "signature": [ + "\"showSampleDataButton\"" + ], + "path": "packages/home/sample_data_tab/src/constants.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_home_sample_data_cards.mdx b/api_docs/kbn_home_sample_data_tab.mdx similarity index 53% rename from api_docs/kbn_home_sample_data_cards.mdx rename to api_docs/kbn_home_sample_data_tab.mdx index 4d565fba08035..eb0355a7584b4 100644 --- a/api_docs/kbn_home_sample_data_cards.mdx +++ b/api_docs/kbn_home_sample_data_tab.mdx @@ -1,14 +1,14 @@ --- -id: kibKbnHomeSampleDataCardsPluginApi -slug: /kibana-dev-docs/api/kbn-home-sample-data-cards -title: "@kbn/home-sample-data-cards" +id: kibKbnHomeSampleDataTabPluginApi +slug: /kibana-dev-docs/api/kbn-home-sample-data-tab +title: "@kbn/home-sample-data-tab" image: https://source.unsplash.com/400x175/?github -summary: API docs for the @kbn/home-sample-data-cards plugin -date: 2022-07-25 -tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/home-sample-data-cards'] +summary: API docs for the @kbn/home-sample-data-tab plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/home-sample-data-tab'] 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. --- -import kbnHomeSampleDataCardsObj from './kbn_home_sample_data_cards.devdocs.json'; +import kbnHomeSampleDataTabObj from './kbn_home_sample_data_tab.devdocs.json'; @@ -18,13 +18,13 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 10 | 0 | 4 | 2 | +| 8 | 0 | 2 | 2 | ## Common ### Functions - + -### Interfaces - +### Consts, variables and types + diff --git a/api_docs/kbn_i18n.mdx b/api_docs/kbn_i18n.mdx index 653d86246a440..2342884e5db70 100644 --- a/api_docs/kbn_i18n.mdx +++ b/api_docs/kbn_i18n.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-i18n title: "@kbn/i18n" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/i18n plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/i18n'] 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. --- diff --git a/api_docs/kbn_import_resolver.mdx b/api_docs/kbn_import_resolver.mdx index 0d852067de75a..2684663385979 100644 --- a/api_docs/kbn_import_resolver.mdx +++ b/api_docs/kbn_import_resolver.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-import-resolver title: "@kbn/import-resolver" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/import-resolver plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/import-resolver'] 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. --- diff --git a/api_docs/kbn_interpreter.mdx b/api_docs/kbn_interpreter.mdx index 66eb6c3c402a0..e5948c4dc3556 100644 --- a/api_docs/kbn_interpreter.mdx +++ b/api_docs/kbn_interpreter.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-interpreter title: "@kbn/interpreter" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/interpreter plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/interpreter'] 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. --- diff --git a/api_docs/kbn_io_ts_utils.mdx b/api_docs/kbn_io_ts_utils.mdx index bf3b4104e2529..f560602008869 100644 --- a/api_docs/kbn_io_ts_utils.mdx +++ b/api_docs/kbn_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-io-ts-utils title: "@kbn/io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/io-ts-utils plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/io-ts-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. --- diff --git a/api_docs/kbn_jest_serializers.mdx b/api_docs/kbn_jest_serializers.mdx index 6d24376bd2802..35201db6a7d9d 100644 --- a/api_docs/kbn_jest_serializers.mdx +++ b/api_docs/kbn_jest_serializers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-jest-serializers title: "@kbn/jest-serializers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/jest-serializers plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/jest-serializers'] 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. --- diff --git a/api_docs/kbn_kibana_json_schema.mdx b/api_docs/kbn_kibana_json_schema.mdx index 66cfa32bf9d52..270fe5d1658f7 100644 --- a/api_docs/kbn_kibana_json_schema.mdx +++ b/api_docs/kbn_kibana_json_schema.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-kibana-json-schema title: "@kbn/kibana-json-schema" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/kibana-json-schema plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/kibana-json-schema'] 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. --- diff --git a/api_docs/kbn_logging.devdocs.json b/api_docs/kbn_logging.devdocs.json index 9f24e7a8d462e..48fbab71d99a6 100644 --- a/api_docs/kbn_logging.devdocs.json +++ b/api_docs/kbn_logging.devdocs.json @@ -556,6 +556,8 @@ "EcsError", " | undefined; event?: ", "EcsEvent", + " | undefined; faas?: ", + "EcsFaas", " | undefined; file?: ", "EcsFile", " | undefined; group?: ", @@ -616,7 +618,7 @@ "label": "EcsEventCategory", "description": [], "signature": [ - "\"database\" | \"package\" | \"network\" | \"web\" | \"file\" | \"host\" | \"session\" | \"registry\" | \"process\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" + "\"database\" | \"email\" | \"package\" | \"network\" | \"web\" | \"file\" | \"host\" | \"session\" | \"registry\" | \"process\" | \"authentication\" | \"configuration\" | \"driver\" | \"iam\" | \"intrusion_detection\" | \"malware\"" ], "path": "packages/kbn-logging/src/ecs/event.ts", "deprecated": false, @@ -658,7 +660,7 @@ "label": "EcsEventType", "description": [], "signature": [ - "\"start\" | \"error\" | \"end\" | \"group\" | \"user\" | \"info\" | \"admin\" | \"protocol\" | \"access\" | \"allowed\" | \"change\" | \"connection\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" + "\"start\" | \"error\" | \"end\" | \"group\" | \"user\" | \"info\" | \"admin\" | \"protocol\" | \"connection\" | \"access\" | \"allowed\" | \"change\" | \"creation\" | \"deletion\" | \"denied\" | \"installation\"" ], "path": "packages/kbn-logging/src/ecs/event.ts", "deprecated": false, diff --git a/api_docs/kbn_logging.mdx b/api_docs/kbn_logging.mdx index 387ccb0954458..c79e96c6d5bb7 100644 --- a/api_docs/kbn_logging.mdx +++ b/api_docs/kbn_logging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging title: "@kbn/logging" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging'] 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 [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 30 | 0 | 5 | 36 | +| 30 | 0 | 5 | 37 | ## Server diff --git a/api_docs/kbn_logging_mocks.mdx b/api_docs/kbn_logging_mocks.mdx index 651baf085e5a5..12dbb7ce77350 100644 --- a/api_docs/kbn_logging_mocks.mdx +++ b/api_docs/kbn_logging_mocks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-logging-mocks title: "@kbn/logging-mocks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/logging-mocks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/logging-mocks'] 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. --- diff --git a/api_docs/kbn_mapbox_gl.devdocs.json b/api_docs/kbn_mapbox_gl.devdocs.json index 29bcef9ca4e59..be7808b1047d2 100644 --- a/api_docs/kbn_mapbox_gl.devdocs.json +++ b/api_docs/kbn_mapbox_gl.devdocs.json @@ -6058,6 +6058,545 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource", + "type": "Class", + "tags": [], + "label": "RasterTileSource", + "description": [], + "signature": [ + "maplibregl.RasterTileSource extends maplibregl.Evented implements maplibregl.Source" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.type", + "type": "CompoundType", + "tags": [], + "label": "type", + "description": [], + "signature": [ + "\"raster\" | \"raster-dem\"" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.id", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.minzoom", + "type": "number", + "tags": [], + "label": "minzoom", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.maxzoom", + "type": "number", + "tags": [], + "label": "maxzoom", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.url", + "type": "string", + "tags": [], + "label": "url", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.scheme", + "type": "string", + "tags": [], + "label": "scheme", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.tileSize", + "type": "number", + "tags": [], + "label": "tileSize", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.bounds", + "type": "Object", + "tags": [], + "label": "bounds", + "description": [], + "signature": [ + "[number, number, number, number]" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.tileBounds", + "type": "Object", + "tags": [], + "label": "tileBounds", + "description": [], + "signature": [ + "maplibregl.TileBounds" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.roundZoom", + "type": "boolean", + "tags": [], + "label": "roundZoom", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.dispatcher", + "type": "Object", + "tags": [], + "label": "dispatcher", + "description": [], + "signature": [ + "maplibregl.Dispatcher" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.map", + "type": "Object", + "tags": [], + "label": "map", + "description": [], + "signature": [ + "maplibregl.Map" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.tiles", + "type": "Array", + "tags": [], + "label": "tiles", + "description": [], + "signature": [ + "string[]" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource._loaded", + "type": "boolean", + "tags": [], + "label": "_loaded", + "description": [], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource._options", + "type": "CompoundType", + "tags": [], + "label": "_options", + "description": [], + "signature": [ + "maplibregl.RasterSourceSpecification | maplibregl.RasterDEMSourceSpecification" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource._tileJSONRequest", + "type": "Object", + "tags": [], + "label": "_tileJSONRequest", + "description": [], + "signature": [ + "{ cancel: () => void; }" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.Unnamed.$1", + "type": "string", + "tags": [], + "label": "id", + "description": [], + "signature": [ + "string" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.Unnamed.$2", + "type": "CompoundType", + "tags": [], + "label": "options", + "description": [], + "signature": [ + "maplibregl.RasterSourceSpecification | maplibregl.RasterDEMSourceSpecification" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.Unnamed.$3", + "type": "Object", + "tags": [], + "label": "dispatcher", + "description": [], + "signature": [ + "maplibregl.Dispatcher" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.Unnamed.$4", + "type": "Object", + "tags": [], + "label": "eventedParent", + "description": [], + "signature": [ + "maplibregl.Evented" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.load", + "type": "Function", + "tags": [], + "label": "load", + "description": [], + "signature": [ + "() => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.loaded", + "type": "Function", + "tags": [], + "label": "loaded", + "description": [], + "signature": [ + "() => boolean" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.onAdd", + "type": "Function", + "tags": [], + "label": "onAdd", + "description": [], + "signature": [ + "(map: maplibregl.Map) => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.onAdd.$1", + "type": "Object", + "tags": [], + "label": "map", + "description": [], + "signature": [ + "maplibregl.Map" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.onRemove", + "type": "Function", + "tags": [], + "label": "onRemove", + "description": [], + "signature": [ + "() => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.serialize", + "type": "Function", + "tags": [], + "label": "serialize", + "description": [], + "signature": [ + "() => any" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.hasTile", + "type": "Function", + "tags": [], + "label": "hasTile", + "description": [], + "signature": [ + "(tileID: maplibregl.OverscaledTileID) => boolean" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.hasTile.$1", + "type": "Object", + "tags": [], + "label": "tileID", + "description": [], + "signature": [ + "maplibregl.OverscaledTileID" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.loadTile", + "type": "Function", + "tags": [], + "label": "loadTile", + "description": [], + "signature": [ + "(tile: maplibregl.Tile, callback: maplibregl.Callback) => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.loadTile.$1", + "type": "Object", + "tags": [], + "label": "tile", + "description": [], + "signature": [ + "maplibregl.Tile" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.loadTile.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [], + "signature": [ + "maplibregl.Callback" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.abortTile", + "type": "Function", + "tags": [], + "label": "abortTile", + "description": [], + "signature": [ + "(tile: maplibregl.Tile, callback: maplibregl.Callback) => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.abortTile.$1", + "type": "Object", + "tags": [], + "label": "tile", + "description": [], + "signature": [ + "maplibregl.Tile" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.abortTile.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [], + "signature": [ + "maplibregl.Callback" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.unloadTile", + "type": "Function", + "tags": [], + "label": "unloadTile", + "description": [], + "signature": [ + "(tile: maplibregl.Tile, callback: maplibregl.Callback) => void" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.unloadTile.$1", + "type": "Object", + "tags": [], + "label": "tile", + "description": [], + "signature": [ + "maplibregl.Tile" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.unloadTile.$2", + "type": "Function", + "tags": [], + "label": "callback", + "description": [], + "signature": [ + "maplibregl.Callback" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/mapbox-gl", + "id": "def-common.RasterTileSource.hasTransition", + "type": "Function", + "tags": [], + "label": "hasTransition", + "description": [], + "signature": [ + "() => boolean" + ], + "path": "node_modules/maplibre-gl/dist/maplibre-gl.d.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/mapbox-gl", "id": "def-common.VectorTileSource", diff --git a/api_docs/kbn_mapbox_gl.mdx b/api_docs/kbn_mapbox_gl.mdx index 4b7d0d093df24..8788c21f59dd4 100644 --- a/api_docs/kbn_mapbox_gl.mdx +++ b/api_docs/kbn_mapbox_gl.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-mapbox-gl title: "@kbn/mapbox-gl" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/mapbox-gl plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/mapbox-gl'] 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 [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 494 | 1 | 1 | 0 | +| 534 | 1 | 1 | 0 | ## Common diff --git a/api_docs/kbn_ml_agg_utils.mdx b/api_docs/kbn_ml_agg_utils.mdx index 6ccf92497cad3..4e0fc9169dc78 100644 --- a/api_docs/kbn_ml_agg_utils.mdx +++ b/api_docs/kbn_ml_agg_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ml-agg-utils title: "@kbn/ml-agg-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ml-agg-utils plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-agg-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. --- diff --git a/api_docs/kbn_ml_is_populated_object.mdx b/api_docs/kbn_ml_is_populated_object.mdx index 1daa5c7e0fa7d..c367e550a1507 100644 --- a/api_docs/kbn_ml_is_populated_object.mdx +++ b/api_docs/kbn_ml_is_populated_object.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ml-is-populated-object title: "@kbn/ml-is-populated-object" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ml-is-populated-object plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-is-populated-object'] 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. --- diff --git a/api_docs/kbn_ml_string_hash.mdx b/api_docs/kbn_ml_string_hash.mdx index e0aa28a449e9f..2cc25be63da16 100644 --- a/api_docs/kbn_ml_string_hash.mdx +++ b/api_docs/kbn_ml_string_hash.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ml-string-hash title: "@kbn/ml-string-hash" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ml-string-hash plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ml-string-hash'] 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. --- diff --git a/api_docs/kbn_monaco.mdx b/api_docs/kbn_monaco.mdx index 225c163f07976..1757c29f1d9ad 100644 --- a/api_docs/kbn_monaco.mdx +++ b/api_docs/kbn_monaco.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-monaco title: "@kbn/monaco" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/monaco plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/monaco'] 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. --- diff --git a/api_docs/kbn_optimizer.mdx b/api_docs/kbn_optimizer.mdx index 6ff2b8ab05a1f..1dee4c6812ca2 100644 --- a/api_docs/kbn_optimizer.mdx +++ b/api_docs/kbn_optimizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer title: "@kbn/optimizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/optimizer plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer'] 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. --- diff --git a/api_docs/kbn_optimizer_webpack_helpers.mdx b/api_docs/kbn_optimizer_webpack_helpers.mdx index 7fc2334b9c158..7eae3e479ef03 100644 --- a/api_docs/kbn_optimizer_webpack_helpers.mdx +++ b/api_docs/kbn_optimizer_webpack_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-optimizer-webpack-helpers title: "@kbn/optimizer-webpack-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/optimizer-webpack-helpers plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/optimizer-webpack-helpers'] 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. --- diff --git a/api_docs/kbn_performance_testing_dataset_extractor.mdx b/api_docs/kbn_performance_testing_dataset_extractor.mdx index 4a09a1853c4f5..ddbecc87479d1 100644 --- a/api_docs/kbn_performance_testing_dataset_extractor.mdx +++ b/api_docs/kbn_performance_testing_dataset_extractor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-performance-testing-dataset-extractor title: "@kbn/performance-testing-dataset-extractor" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/performance-testing-dataset-extractor plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/performance-testing-dataset-extractor'] 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. --- diff --git a/api_docs/kbn_plugin_generator.mdx b/api_docs/kbn_plugin_generator.mdx index a4b8f708dc36f..6e0b1b1c06b7d 100644 --- a/api_docs/kbn_plugin_generator.mdx +++ b/api_docs/kbn_plugin_generator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-generator title: "@kbn/plugin-generator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-generator plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-generator'] 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. --- diff --git a/api_docs/kbn_plugin_helpers.mdx b/api_docs/kbn_plugin_helpers.mdx index 2c86335dfaa5b..7e23520acdc03 100644 --- a/api_docs/kbn_plugin_helpers.mdx +++ b/api_docs/kbn_plugin_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-plugin-helpers title: "@kbn/plugin-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/plugin-helpers plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/plugin-helpers'] 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. --- diff --git a/api_docs/kbn_react_field.mdx b/api_docs/kbn_react_field.mdx index 051f0dc8cb55d..b4bfe1313ab37 100644 --- a/api_docs/kbn_react_field.mdx +++ b/api_docs/kbn_react_field.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-react-field title: "@kbn/react-field" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/react-field plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/react-field'] 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. --- diff --git a/api_docs/kbn_repo_source_classifier.devdocs.json b/api_docs/kbn_repo_source_classifier.devdocs.json new file mode 100644 index 0000000000000..060383fba7381 --- /dev/null +++ b/api_docs/kbn_repo_source_classifier.devdocs.json @@ -0,0 +1,117 @@ +{ + "id": "@kbn/repo-source-classifier", + "client": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [ + { + "parentPluginId": "@kbn/repo-source-classifier", + "id": "def-server.RepoSourceClassifier", + "type": "Class", + "tags": [], + "label": "RepoSourceClassifier", + "description": [], + "path": "packages/kbn-repo-source-classifier/src/repo_source_classifier.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/repo-source-classifier", + "id": "def-server.RepoSourceClassifier.Unnamed", + "type": "Function", + "tags": [], + "label": "Constructor", + "description": [], + "signature": [ + "any" + ], + "path": "packages/kbn-repo-source-classifier/src/repo_source_classifier.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/repo-source-classifier", + "id": "def-server.RepoSourceClassifier.Unnamed.$1", + "type": "Object", + "tags": [], + "label": "resolver", + "description": [], + "signature": [ + "ImportResolver" + ], + "path": "packages/kbn-repo-source-classifier/src/repo_source_classifier.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "@kbn/repo-source-classifier", + "id": "def-server.RepoSourceClassifier.classify", + "type": "Function", + "tags": [], + "label": "classify", + "description": [], + "signature": [ + "(absolute: string) => ", + "ModuleId" + ], + "path": "packages/kbn-repo-source-classifier/src/repo_source_classifier.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/repo-source-classifier", + "id": "def-server.RepoSourceClassifier.classify.$1", + "type": "string", + "tags": [], + "label": "absolute", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-repo-source-classifier/src/repo_source_classifier.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [ + { + "parentPluginId": "@kbn/repo-source-classifier", + "id": "def-server.ModuleType", + "type": "Type", + "tags": [], + "label": "ModuleType", + "description": [], + "signature": [ + "\"non-package\" | \"tests or mocks\" | \"static\" | \"tooling\" | \"server package\" | \"browser package\" | \"common package\"" + ], + "path": "packages/kbn-repo-source-classifier/src/module_type.ts", + "deprecated": false, + "initialIsOpen": false + } + ], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/kbn_repo_source_classifier.mdx b/api_docs/kbn_repo_source_classifier.mdx new file mode 100644 index 0000000000000..77b0db2f717f5 --- /dev/null +++ b/api_docs/kbn_repo_source_classifier.mdx @@ -0,0 +1,30 @@ +--- +id: kibKbnRepoSourceClassifierPluginApi +slug: /kibana-dev-docs/api/kbn-repo-source-classifier +title: "@kbn/repo-source-classifier" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the @kbn/repo-source-classifier plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/repo-source-classifier'] +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. +--- +import kbnRepoSourceClassifierObj from './kbn_repo_source_classifier.devdocs.json'; + + + +Contact [Owner missing] for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 6 | 0 | 6 | 1 | + +## Server + +### Classes + + +### Consts, variables and types + + diff --git a/api_docs/kbn_rule_data_utils.devdocs.json b/api_docs/kbn_rule_data_utils.devdocs.json index 613fa11df6755..1a62ca9200de1 100644 --- a/api_docs/kbn_rule_data_utils.devdocs.json +++ b/api_docs/kbn_rule_data_utils.devdocs.json @@ -855,7 +855,7 @@ "label": "AlertConsumers", "description": [], "signature": [ - "\"logs\" | \"apm\" | \"infrastructure\" | \"observability\" | \"uptime\" | \"siem\"" + "\"logs\" | \"apm\" | \"uptime\" | \"siem\" | \"infrastructure\" | \"observability\"" ], "path": "packages/kbn-rule-data-utils/src/alerts_as_data_rbac.ts", "deprecated": false, @@ -1037,7 +1037,7 @@ "label": "ValidFeatureId", "description": [], "signature": [ - "\"logs\" | \"apm\" | \"infrastructure\" | \"observability\" | \"uptime\" | \"siem\"" + "\"logs\" | \"apm\" | \"uptime\" | \"siem\" | \"infrastructure\" | \"observability\"" ], "path": "packages/kbn-rule-data-utils/src/alerts_as_data_rbac.ts", "deprecated": false, diff --git a/api_docs/kbn_rule_data_utils.mdx b/api_docs/kbn_rule_data_utils.mdx index d91c08a14958e..7f080a313fa50 100644 --- a/api_docs/kbn_rule_data_utils.mdx +++ b/api_docs/kbn_rule_data_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-rule-data-utils title: "@kbn/rule-data-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/rule-data-utils plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/rule-data-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. --- diff --git a/api_docs/kbn_scalability_simulation_generator.mdx b/api_docs/kbn_scalability_simulation_generator.mdx index cc6881d2c192b..c656c3ffa2369 100644 --- a/api_docs/kbn_scalability_simulation_generator.mdx +++ b/api_docs/kbn_scalability_simulation_generator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-scalability-simulation-generator title: "@kbn/scalability-simulation-generator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/scalability-simulation-generator plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/scalability-simulation-generator'] 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. --- diff --git a/api_docs/kbn_securitysolution_autocomplete.mdx b/api_docs/kbn_securitysolution_autocomplete.mdx index e8e8ccd1301b3..ddcf9707ae33e 100644 --- a/api_docs/kbn_securitysolution_autocomplete.mdx +++ b/api_docs/kbn_securitysolution_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-autocomplete title: "@kbn/securitysolution-autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-autocomplete plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-autocomplete'] 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. --- diff --git a/api_docs/kbn_securitysolution_es_utils.devdocs.json b/api_docs/kbn_securitysolution_es_utils.devdocs.json index 9a04e2bad87aa..6a4f5b028f3c4 100644 --- a/api_docs/kbn_securitysolution_es_utils.devdocs.json +++ b/api_docs/kbn_securitysolution_es_utils.devdocs.json @@ -173,6 +173,53 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-es-utils", + "id": "def-server.deleteIndexTemplate", + "type": "Function", + "tags": [], + "label": "deleteIndexTemplate", + "description": [], + "signature": [ + "(esClient: ", + "ElasticsearchClient", + ", name: string) => Promise" + ], + "path": "packages/kbn-securitysolution-es-utils/src/delete_index_template/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-es-utils", + "id": "def-server.deleteIndexTemplate.$1", + "type": "Object", + "tags": [], + "label": "esClient", + "description": [], + "signature": [ + "ElasticsearchClient" + ], + "path": "packages/kbn-securitysolution-es-utils/src/delete_index_template/index.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/securitysolution-es-utils", + "id": "def-server.deleteIndexTemplate.$2", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-securitysolution-es-utils/src/delete_index_template/index.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-es-utils", "id": "def-server.deletePolicy", @@ -482,32 +529,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: { (this: That, params: ", "GetRequest", " | ", @@ -560,32 +581,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -652,6 +673,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", " | ", @@ -1724,32 +1771,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: { (this: That, params: ", "GetRequest", " | ", @@ -1802,32 +1823,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -1894,6 +1915,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", " | ", @@ -2884,6 +2931,53 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-es-utils", + "id": "def-server.getIndexTemplateExists", + "type": "Function", + "tags": [], + "label": "getIndexTemplateExists", + "description": [], + "signature": [ + "(esClient: ", + "ElasticsearchClient", + ", template: string) => Promise" + ], + "path": "packages/kbn-securitysolution-es-utils/src/get_index_template_exists/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-es-utils", + "id": "def-server.getIndexTemplateExists.$1", + "type": "Object", + "tags": [], + "label": "esClient", + "description": [], + "signature": [ + "ElasticsearchClient" + ], + "path": "packages/kbn-securitysolution-es-utils/src/get_index_template_exists/index.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/securitysolution-es-utils", + "id": "def-server.getIndexTemplateExists.$2", + "type": "string", + "tags": [], + "label": "template", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-securitysolution-es-utils/src/get_index_template_exists/index.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-es-utils", "id": "def-server.getPolicyExists", @@ -3072,6 +3166,67 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-es-utils", + "id": "def-server.setIndexTemplate", + "type": "Function", + "tags": [], + "label": "setIndexTemplate", + "description": [], + "signature": [ + "(esClient: ", + "ElasticsearchClient", + ", name: string, body: Record) => Promise" + ], + "path": "packages/kbn-securitysolution-es-utils/src/set_index_template/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-es-utils", + "id": "def-server.setIndexTemplate.$1", + "type": "Object", + "tags": [], + "label": "esClient", + "description": [], + "signature": [ + "ElasticsearchClient" + ], + "path": "packages/kbn-securitysolution-es-utils/src/set_index_template/index.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/securitysolution-es-utils", + "id": "def-server.setIndexTemplate.$2", + "type": "string", + "tags": [], + "label": "name", + "description": [], + "signature": [ + "string" + ], + "path": "packages/kbn-securitysolution-es-utils/src/set_index_template/index.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/securitysolution-es-utils", + "id": "def-server.setIndexTemplate.$3", + "type": "Object", + "tags": [], + "label": "body", + "description": [], + "signature": [ + "Record" + ], + "path": "packages/kbn-securitysolution-es-utils/src/set_index_template/index.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-es-utils", "id": "def-server.setPolicy", diff --git a/api_docs/kbn_securitysolution_es_utils.mdx b/api_docs/kbn_securitysolution_es_utils.mdx index 065f69c227eae..02373d193791f 100644 --- a/api_docs/kbn_securitysolution_es_utils.mdx +++ b/api_docs/kbn_securitysolution_es_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-es-utils title: "@kbn/securitysolution-es-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-es-utils plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-es-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. --- @@ -18,7 +18,7 @@ Contact [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 57 | 0 | 51 | 1 | +| 67 | 0 | 61 | 1 | ## Server diff --git a/api_docs/kbn_securitysolution_hook_utils.mdx b/api_docs/kbn_securitysolution_hook_utils.mdx index 51f8061227ab2..e2deb20e6dec0 100644 --- a/api_docs/kbn_securitysolution_hook_utils.mdx +++ b/api_docs/kbn_securitysolution_hook_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-hook-utils title: "@kbn/securitysolution-hook-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-hook-utils plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-hook-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. --- diff --git a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx index 6ea3a8b36235a..37585ecdf2b1b 100644 --- a/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_alerting_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-alerting-types title: "@kbn/securitysolution-io-ts-alerting-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-alerting-types plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-alerting-types'] 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. --- diff --git a/api_docs/kbn_securitysolution_io_ts_list_types.mdx b/api_docs/kbn_securitysolution_io_ts_list_types.mdx index d7485fdede25d..509e735f86f2d 100644 --- a/api_docs/kbn_securitysolution_io_ts_list_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_list_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-list-types title: "@kbn/securitysolution-io-ts-list-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-list-types plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-list-types'] 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. --- diff --git a/api_docs/kbn_securitysolution_io_ts_types.devdocs.json b/api_docs/kbn_securitysolution_io_ts_types.devdocs.json index 0832cc7688b06..10257f2a0622a 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.devdocs.json +++ b/api_docs/kbn_securitysolution_io_ts_types.devdocs.json @@ -60,6 +60,134 @@ "returnComment": [], "initialIsOpen": false }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-types", + "id": "def-common.defaultCsvArray", + "type": "Function", + "tags": [], + "label": "defaultCsvArray", + "description": [ + "\nCreates a schema of an array that works in the following way:\n - If input is a CSV string, it will be parsed to an array which will be validated.\n - If input is an array, each item is validated to match `itemSchema`.\n - If input is a single string, it is validated to match `itemSchema`.\n - If input is not specified, the result will be set to [] (empty array):\n - null, undefined, empty string, empty array\n\nIn all cases when an input is valid, the resulting decoded value will be an array,\neither an empty one or containing valid items.\n" + ], + "signature": [ + "(itemSchema: ", + "Type", + ", name?: string | undefined) => ", + "Type", + "" + ], + "path": "packages/kbn-securitysolution-io-ts-types/src/default_csv_array/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-io-ts-types", + "id": "def-common.defaultCsvArray.$1", + "type": "Object", + "tags": [], + "label": "itemSchema", + "description": [ + "Schema of the array's items." + ], + "signature": [ + "Type", + "" + ], + "path": "packages/kbn-securitysolution-io-ts-types/src/default_csv_array/index.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-types", + "id": "def-common.defaultCsvArray.$2", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "(Optional) Name of the resulting schema." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-securitysolution-io-ts-types/src/default_csv_array/index.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-types", + "id": "def-common.defaultValue", + "type": "Function", + "tags": [], + "label": "defaultValue", + "description": [ + "\nCreates a schema that sets a default value if the input value is not specified.\n" + ], + "signature": [ + "(valueSchema: ", + "Type", + ", value: TValue, name?: string | undefined) => ", + "Type", + "" + ], + "path": "packages/kbn-securitysolution-io-ts-types/src/default_value/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "@kbn/securitysolution-io-ts-types", + "id": "def-common.defaultValue.$1", + "type": "Object", + "tags": [], + "label": "valueSchema", + "description": [ + "Base schema of a value." + ], + "signature": [ + "Type", + "" + ], + "path": "packages/kbn-securitysolution-io-ts-types/src/default_value/index.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-types", + "id": "def-common.defaultValue.$2", + "type": "Uncategorized", + "tags": [], + "label": "value", + "description": [ + "Default value to set." + ], + "signature": [ + "TValue" + ], + "path": "packages/kbn-securitysolution-io-ts-types/src/default_value/index.ts", + "deprecated": false, + "isRequired": true + }, + { + "parentPluginId": "@kbn/securitysolution-io-ts-types", + "id": "def-common.defaultValue.$3", + "type": "string", + "tags": [], + "label": "name", + "description": [ + "(Optional) Name of the resulting schema." + ], + "signature": [ + "string | undefined" + ], + "path": "packages/kbn-securitysolution-io-ts-types/src/default_value/index.ts", + "deprecated": false, + "isRequired": false + } + ], + "returnComment": [], + "initialIsOpen": false + }, { "parentPluginId": "@kbn/securitysolution-io-ts-types", "id": "def-common.enumeration", diff --git a/api_docs/kbn_securitysolution_io_ts_types.mdx b/api_docs/kbn_securitysolution_io_ts_types.mdx index aa470af6bd3be..21efc723376dd 100644 --- a/api_docs/kbn_securitysolution_io_ts_types.mdx +++ b/api_docs/kbn_securitysolution_io_ts_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-types title: "@kbn/securitysolution-io-ts-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-types plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-types'] 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 [Owner missing] for questions regarding this plugin. | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 54 | 0 | 32 | 0 | +| 61 | 0 | 32 | 0 | ## Common diff --git a/api_docs/kbn_securitysolution_io_ts_utils.mdx b/api_docs/kbn_securitysolution_io_ts_utils.mdx index 93f74333cd11e..2ec23c01b06ec 100644 --- a/api_docs/kbn_securitysolution_io_ts_utils.mdx +++ b/api_docs/kbn_securitysolution_io_ts_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-io-ts-utils title: "@kbn/securitysolution-io-ts-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-io-ts-utils plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-io-ts-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. --- diff --git a/api_docs/kbn_securitysolution_list_api.mdx b/api_docs/kbn_securitysolution_list_api.mdx index d2cb6b2348fc9..2d4df53864aa6 100644 --- a/api_docs/kbn_securitysolution_list_api.mdx +++ b/api_docs/kbn_securitysolution_list_api.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-api title: "@kbn/securitysolution-list-api" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-api plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-api'] 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. --- diff --git a/api_docs/kbn_securitysolution_list_constants.mdx b/api_docs/kbn_securitysolution_list_constants.mdx index c164641ad2374..abe95aab3b151 100644 --- a/api_docs/kbn_securitysolution_list_constants.mdx +++ b/api_docs/kbn_securitysolution_list_constants.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-constants title: "@kbn/securitysolution-list-constants" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-constants plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-constants'] 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. --- diff --git a/api_docs/kbn_securitysolution_list_hooks.mdx b/api_docs/kbn_securitysolution_list_hooks.mdx index 16f6e99c1fc92..541da764fa38b 100644 --- a/api_docs/kbn_securitysolution_list_hooks.mdx +++ b/api_docs/kbn_securitysolution_list_hooks.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-hooks title: "@kbn/securitysolution-list-hooks" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-hooks plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-hooks'] 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. --- diff --git a/api_docs/kbn_securitysolution_list_utils.mdx b/api_docs/kbn_securitysolution_list_utils.mdx index 7dd727ebc3b72..f55248c1f9f9b 100644 --- a/api_docs/kbn_securitysolution_list_utils.mdx +++ b/api_docs/kbn_securitysolution_list_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-list-utils title: "@kbn/securitysolution-list-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-list-utils plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-list-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. --- diff --git a/api_docs/kbn_securitysolution_rules.mdx b/api_docs/kbn_securitysolution_rules.mdx index 41b247d6c1adf..493117f1eb1b9 100644 --- a/api_docs/kbn_securitysolution_rules.mdx +++ b/api_docs/kbn_securitysolution_rules.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-rules title: "@kbn/securitysolution-rules" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-rules plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-rules'] 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. --- diff --git a/api_docs/kbn_securitysolution_t_grid.mdx b/api_docs/kbn_securitysolution_t_grid.mdx index c74c48629ded7..de16ba118dbf4 100644 --- a/api_docs/kbn_securitysolution_t_grid.mdx +++ b/api_docs/kbn_securitysolution_t_grid.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-t-grid title: "@kbn/securitysolution-t-grid" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-t-grid plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-t-grid'] 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. --- diff --git a/api_docs/kbn_securitysolution_utils.mdx b/api_docs/kbn_securitysolution_utils.mdx index 0b958c0fe05dd..1dae392d47a33 100644 --- a/api_docs/kbn_securitysolution_utils.mdx +++ b/api_docs/kbn_securitysolution_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-securitysolution-utils title: "@kbn/securitysolution-utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/securitysolution-utils plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/securitysolution-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. --- diff --git a/api_docs/kbn_server_http_tools.mdx b/api_docs/kbn_server_http_tools.mdx index 648f53e64da5c..a8dd7149f0f78 100644 --- a/api_docs/kbn_server_http_tools.mdx +++ b/api_docs/kbn_server_http_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-http-tools title: "@kbn/server-http-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-http-tools plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-http-tools'] 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. --- diff --git a/api_docs/kbn_server_route_repository.mdx b/api_docs/kbn_server_route_repository.mdx index 5256dfcf7be64..b30e0d67604aa 100644 --- a/api_docs/kbn_server_route_repository.mdx +++ b/api_docs/kbn_server_route_repository.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-server-route-repository title: "@kbn/server-route-repository" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/server-route-repository plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/server-route-repository'] 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. --- diff --git a/api_docs/kbn_shared_ux_button_toolbar.mdx b/api_docs/kbn_shared_ux_button_toolbar.mdx index 7354ab061730e..08ad439123b93 100644 --- a/api_docs/kbn_shared_ux_button_toolbar.mdx +++ b/api_docs/kbn_shared_ux_button_toolbar.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-button-toolbar title: "@kbn/shared-ux-button-toolbar" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-button-toolbar plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-button-toolbar'] 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. --- diff --git a/api_docs/kbn_shared_ux_card_no_data.mdx b/api_docs/kbn_shared_ux_card_no_data.mdx index c14fa909fbf1c..d043d721dde6f 100644 --- a/api_docs/kbn_shared_ux_card_no_data.mdx +++ b/api_docs/kbn_shared_ux_card_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-card-no-data title: "@kbn/shared-ux-card-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-card-no-data plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-card-no-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. --- diff --git a/api_docs/kbn_shared_ux_components.mdx b/api_docs/kbn_shared_ux_components.mdx index 20c4e2fbd6625..2ac7872d42062 100644 --- a/api_docs/kbn_shared_ux_components.mdx +++ b/api_docs/kbn_shared_ux_components.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-components title: "@kbn/shared-ux-components" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-components plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-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. --- diff --git a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx index 1aa54e6331c81..ab7620f24e9d2 100644 --- a/api_docs/kbn_shared_ux_page_analytics_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_analytics_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-analytics-no-data title: "@kbn/shared-ux-page-analytics-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-page-analytics-no-data plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-analytics-no-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. --- diff --git a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx index ef5350e540679..427d3305334b1 100644 --- a/api_docs/kbn_shared_ux_page_kibana_no_data.mdx +++ b/api_docs/kbn_shared_ux_page_kibana_no_data.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-kibana-no-data title: "@kbn/shared-ux-page-kibana-no-data" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-page-kibana-no-data plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-kibana-no-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. --- diff --git a/api_docs/kbn_shared_ux_page_solution_nav.mdx b/api_docs/kbn_shared_ux_page_solution_nav.mdx index d94970f4d7b61..b2bcd2649b0a5 100644 --- a/api_docs/kbn_shared_ux_page_solution_nav.mdx +++ b/api_docs/kbn_shared_ux_page_solution_nav.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-page-solution-nav title: "@kbn/shared-ux-page-solution-nav" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-page-solution-nav plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-page-solution-nav'] 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. --- diff --git a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx index ab5818b4c215b..ef88e637768cc 100644 --- a/api_docs/kbn_shared_ux_prompt_no_data_views.mdx +++ b/api_docs/kbn_shared_ux_prompt_no_data_views.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-prompt-no-data-views title: "@kbn/shared-ux-prompt-no-data-views" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-prompt-no-data-views plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-prompt-no-data-views'] 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. --- diff --git a/api_docs/kbn_shared_ux_services.mdx b/api_docs/kbn_shared_ux_services.mdx index fb59cbfc47978..de116be2b5b8d 100644 --- a/api_docs/kbn_shared_ux_services.mdx +++ b/api_docs/kbn_shared_ux_services.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-services title: "@kbn/shared-ux-services" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-services plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-services'] 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. --- diff --git a/api_docs/kbn_shared_ux_storybook.mdx b/api_docs/kbn_shared_ux_storybook.mdx index d560a995409cb..71e1160f71db3 100644 --- a/api_docs/kbn_shared_ux_storybook.mdx +++ b/api_docs/kbn_shared_ux_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-storybook title: "@kbn/shared-ux-storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-storybook plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-storybook'] 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. --- diff --git a/api_docs/kbn_shared_ux_utility.mdx b/api_docs/kbn_shared_ux_utility.mdx index 449d0f6d12f34..4905d179a275a 100644 --- a/api_docs/kbn_shared_ux_utility.mdx +++ b/api_docs/kbn_shared_ux_utility.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-shared-ux-utility title: "@kbn/shared-ux-utility" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/shared-ux-utility plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/shared-ux-utility'] 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. --- diff --git a/api_docs/kbn_some_dev_log.mdx b/api_docs/kbn_some_dev_log.mdx index 912d8694af12d..22e3a65326eef 100644 --- a/api_docs/kbn_some_dev_log.mdx +++ b/api_docs/kbn_some_dev_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-some-dev-log title: "@kbn/some-dev-log" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/some-dev-log plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/some-dev-log'] 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. --- diff --git a/api_docs/kbn_sort_package_json.mdx b/api_docs/kbn_sort_package_json.mdx index bc78001f9fe27..e1d7c26a964c2 100644 --- a/api_docs/kbn_sort_package_json.mdx +++ b/api_docs/kbn_sort_package_json.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-sort-package-json title: "@kbn/sort-package-json" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/sort-package-json plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/sort-package-json'] 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. --- diff --git a/api_docs/kbn_std.mdx b/api_docs/kbn_std.mdx index 890f5d40b5cfb..f484d6bc4a69e 100644 --- a/api_docs/kbn_std.mdx +++ b/api_docs/kbn_std.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-std title: "@kbn/std" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/std plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/std'] 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. --- diff --git a/api_docs/kbn_stdio_dev_helpers.mdx b/api_docs/kbn_stdio_dev_helpers.mdx index 58afeec1e90ae..3e21abd6d9231 100644 --- a/api_docs/kbn_stdio_dev_helpers.mdx +++ b/api_docs/kbn_stdio_dev_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-stdio-dev-helpers title: "@kbn/stdio-dev-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/stdio-dev-helpers plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/stdio-dev-helpers'] 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. --- diff --git a/api_docs/kbn_storybook.mdx b/api_docs/kbn_storybook.mdx index 75b41dc9af22f..433b13c8b75a1 100644 --- a/api_docs/kbn_storybook.mdx +++ b/api_docs/kbn_storybook.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-storybook title: "@kbn/storybook" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/storybook plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/storybook'] 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. --- diff --git a/api_docs/kbn_telemetry_tools.mdx b/api_docs/kbn_telemetry_tools.mdx index 59f8526ef2dd3..bee21218adc6d 100644 --- a/api_docs/kbn_telemetry_tools.mdx +++ b/api_docs/kbn_telemetry_tools.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-telemetry-tools title: "@kbn/telemetry-tools" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/telemetry-tools plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/telemetry-tools'] 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. --- diff --git a/api_docs/kbn_test.mdx b/api_docs/kbn_test.mdx index 9c1f05707b951..9139ea5014a25 100644 --- a/api_docs/kbn_test.mdx +++ b/api_docs/kbn_test.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test title: "@kbn/test" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test'] 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. --- diff --git a/api_docs/kbn_test_jest_helpers.mdx b/api_docs/kbn_test_jest_helpers.mdx index 2e5a4a1619e14..28df22b797771 100644 --- a/api_docs/kbn_test_jest_helpers.mdx +++ b/api_docs/kbn_test_jest_helpers.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-test-jest-helpers title: "@kbn/test-jest-helpers" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/test-jest-helpers plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/test-jest-helpers'] 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. --- diff --git a/api_docs/kbn_tooling_log.mdx b/api_docs/kbn_tooling_log.mdx index d6229cb4815bd..85925730a1ba7 100644 --- a/api_docs/kbn_tooling_log.mdx +++ b/api_docs/kbn_tooling_log.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-tooling-log title: "@kbn/tooling-log" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/tooling-log plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/tooling-log'] 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. --- diff --git a/api_docs/kbn_type_summarizer.mdx b/api_docs/kbn_type_summarizer.mdx index 3cbc3cf3af9ae..0809419eee9e6 100644 --- a/api_docs/kbn_type_summarizer.mdx +++ b/api_docs/kbn_type_summarizer.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-type-summarizer title: "@kbn/type-summarizer" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/type-summarizer plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/type-summarizer'] 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. --- diff --git a/api_docs/kbn_type_summarizer_core.mdx b/api_docs/kbn_type_summarizer_core.mdx index df67565d332c5..b7ab3e609d9b0 100644 --- a/api_docs/kbn_type_summarizer_core.mdx +++ b/api_docs/kbn_type_summarizer_core.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-type-summarizer-core title: "@kbn/type-summarizer-core" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/type-summarizer-core plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/type-summarizer-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. --- diff --git a/api_docs/kbn_typed_react_router_config.mdx b/api_docs/kbn_typed_react_router_config.mdx index f85562ff1c229..9fefdc9214c1f 100644 --- a/api_docs/kbn_typed_react_router_config.mdx +++ b/api_docs/kbn_typed_react_router_config.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-typed-react-router-config title: "@kbn/typed-react-router-config" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/typed-react-router-config plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/typed-react-router-config'] 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. --- diff --git a/api_docs/kbn_ui_theme.mdx b/api_docs/kbn_ui_theme.mdx index 16db3eb30ae34..f54d1433fca95 100644 --- a/api_docs/kbn_ui_theme.mdx +++ b/api_docs/kbn_ui_theme.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-ui-theme title: "@kbn/ui-theme" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/ui-theme plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/ui-theme'] 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. --- diff --git a/api_docs/kbn_utility_types.mdx b/api_docs/kbn_utility_types.mdx index 972c937e45d1b..d02ca97e00982 100644 --- a/api_docs/kbn_utility_types.mdx +++ b/api_docs/kbn_utility_types.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types title: "@kbn/utility-types" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utility-types plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types'] 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. --- diff --git a/api_docs/kbn_utility_types_jest.mdx b/api_docs/kbn_utility_types_jest.mdx index fd921df9bd744..c8eaafdd95196 100644 --- a/api_docs/kbn_utility_types_jest.mdx +++ b/api_docs/kbn_utility_types_jest.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utility-types-jest title: "@kbn/utility-types-jest" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utility-types-jest plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/utility-types-jest'] 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. --- diff --git a/api_docs/kbn_utils.mdx b/api_docs/kbn_utils.mdx index 851184bf3f4d2..2b4dfa87b8653 100644 --- a/api_docs/kbn_utils.mdx +++ b/api_docs/kbn_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-utils title: "@kbn/utils" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/utils plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/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. --- diff --git a/api_docs/kbn_yarn_lock_validator.mdx b/api_docs/kbn_yarn_lock_validator.mdx index 69d617e80f88c..898827226a426 100644 --- a/api_docs/kbn_yarn_lock_validator.mdx +++ b/api_docs/kbn_yarn_lock_validator.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kbn-yarn-lock-validator title: "@kbn/yarn-lock-validator" image: https://source.unsplash.com/400x175/?github summary: API docs for the @kbn/yarn-lock-validator plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '@kbn/yarn-lock-validator'] 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. --- diff --git a/api_docs/kibana_overview.mdx b/api_docs/kibana_overview.mdx index e1804c29c810f..0ef685996ade6 100644 --- a/api_docs/kibana_overview.mdx +++ b/api_docs/kibana_overview.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaOverview title: "kibanaOverview" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaOverview plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaOverview'] 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. --- diff --git a/api_docs/kibana_react.devdocs.json b/api_docs/kibana_react.devdocs.json index 2b8ec3ae15917..81ed6c5b9a735 100644 --- a/api_docs/kibana_react.devdocs.json +++ b/api_docs/kibana_react.devdocs.json @@ -1928,18 +1928,6 @@ "plugin": "apm", "path": "x-pack/plugins/apm/public/components/routing/app_root.tsx" }, - { - "plugin": "cloudSecurityPosture", - "path": "x-pack/plugins/cloud_security_posture/public/application/app.tsx" - }, - { - "plugin": "cloudSecurityPosture", - "path": "x-pack/plugins/cloud_security_posture/public/application/app.tsx" - }, - { - "plugin": "cloudSecurityPosture", - "path": "x-pack/plugins/cloud_security_posture/public/application/app.tsx" - }, { "plugin": "indexLifecycleManagement", "path": "x-pack/plugins/index_lifecycle_management/public/shared_imports.ts" diff --git a/api_docs/kibana_react.mdx b/api_docs/kibana_react.mdx index 93911c6d475ef..0760097c7abac 100644 --- a/api_docs/kibana_react.mdx +++ b/api_docs/kibana_react.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaReact title: "kibanaReact" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaReact plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaReact'] 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. --- diff --git a/api_docs/kibana_utils.mdx b/api_docs/kibana_utils.mdx index bba70dd6387f1..80c3a4fc7a3a0 100644 --- a/api_docs/kibana_utils.mdx +++ b/api_docs/kibana_utils.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kibanaUtils title: "kibanaUtils" image: https://source.unsplash.com/400x175/?github summary: API docs for the kibanaUtils plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaUtils'] 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. --- diff --git a/api_docs/kubernetes_security.mdx b/api_docs/kubernetes_security.mdx index 7e2a2bcce98e3..2d16e43935dbd 100644 --- a/api_docs/kubernetes_security.mdx +++ b/api_docs/kubernetes_security.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/kubernetesSecurity title: "kubernetesSecurity" image: https://source.unsplash.com/400x175/?github summary: API docs for the kubernetesSecurity plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kubernetesSecurity'] 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. --- diff --git a/api_docs/lens.devdocs.json b/api_docs/lens.devdocs.json index a0cb2134f3ed9..a969b7b0a2c2a 100644 --- a/api_docs/lens.devdocs.json +++ b/api_docs/lens.devdocs.json @@ -47,7 +47,14 @@ "LensByValueInput", ", ", "LensByReferenceInput", - ">" + ">,", + { + "pluginId": "embeddable", + "scope": "public", + "docId": "kibEmbeddablePluginApi", + "section": "def-public.SelfStyledEmbeddable", + "text": "SelfStyledEmbeddable" + } ], "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", "deprecated": false, @@ -343,6 +350,23 @@ ], "returnComment": [] }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.getExecutionContext", + "type": "Function", + "tags": [], + "label": "getExecutionContext", + "description": [], + "signature": [ + "() => ", + "KibanaExecutionContext", + " | undefined" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, { "parentPluginId": "lens", "id": "def-public.Embeddable.render", @@ -600,6 +624,21 @@ "deprecated": false, "children": [], "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Embeddable.getSelfStyledOptions", + "type": "Function", + "tags": [], + "label": "getSelfStyledOptions", + "description": [], + "signature": [ + "() => { hideTitle: boolean | undefined; }" + ], + "path": "x-pack/plugins/lens/public/embeddable/embeddable.tsx", + "deprecated": false, + "children": [], + "returnComment": [] } ], "initialIsOpen": false @@ -1380,6 +1419,38 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.DatasourcePublicAPI.getMaxPossibleNumValues", + "type": "Function", + "tags": [], + "label": "getMaxPossibleNumValues", + "description": [ + "\nReturns the maximum possible number of values for this column when it can be known, otherwise null\n(e.g. with a top 5 values operation, we can be sure that there will never be more than 5 values returned\n or 6 if the \"Other\" bucket is enabled)" + ], + "signature": [ + "(columnId: string) => number | null" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.DatasourcePublicAPI.getMaxPossibleNumValues.$1", + "type": "string", + "tags": [], + "label": "columnId", + "description": [], + "signature": [ + "string" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -5249,6 +5320,57 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Visualization.getDisplayOptions", + "type": "Function", + "tags": [], + "label": "getDisplayOptions", + "description": [ + "\nGets custom display options for showing the visualization." + ], + "signature": [ + "(() => ", + "VisualizationDisplayOptions", + ") | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "lens", + "id": "def-public.Visualization.getRenderEventCounters", + "type": "Function", + "tags": [], + "label": "getRenderEventCounters", + "description": [ + "\nGet RenderEventCounters events for telemetry" + ], + "signature": [ + "((state: T) => string[]) | undefined" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "lens", + "id": "def-public.Visualization.getRenderEventCounters.$1", + "type": "Uncategorized", + "tags": [], + "label": "state", + "description": [], + "signature": [ + "T" + ], + "path": "x-pack/plugins/lens/public/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "initialIsOpen": false @@ -8180,26 +8302,6 @@ "path": "x-pack/plugins/lens/server/plugin.tsx", "deprecated": false, "children": [ - { - "parentPluginId": "lens", - "id": "def-server.PluginSetupContract.usageCollection", - "type": "Object", - "tags": [], - "label": "usageCollection", - "description": [], - "signature": [ - { - "pluginId": "usageCollection", - "scope": "server", - "docId": "kibUsageCollectionPluginApi", - "section": "def-server.UsageCollectionSetup", - "text": "UsageCollectionSetup" - }, - " | undefined" - ], - "path": "x-pack/plugins/lens/server/plugin.tsx", - "deprecated": false - }, { "parentPluginId": "lens", "id": "def-server.PluginSetupContract.taskManager", diff --git a/api_docs/lens.mdx b/api_docs/lens.mdx index d8d848751bc51..ea6c2e2fc6373 100644 --- a/api_docs/lens.mdx +++ b/api_docs/lens.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lens title: "lens" image: https://source.unsplash.com/400x175/?github summary: API docs for the lens plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lens'] 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 [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 602 | 0 | 524 | 40 | +| 608 | 0 | 527 | 41 | ## Client diff --git a/api_docs/license_api_guard.mdx b/api_docs/license_api_guard.mdx index bb2243b550c19..b8bd230007e0c 100644 --- a/api_docs/license_api_guard.mdx +++ b/api_docs/license_api_guard.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseApiGuard title: "licenseApiGuard" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseApiGuard plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseApiGuard'] 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. --- diff --git a/api_docs/license_management.mdx b/api_docs/license_management.mdx index 506fe03b5b45c..44ceb39ac1aac 100644 --- a/api_docs/license_management.mdx +++ b/api_docs/license_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licenseManagement title: "licenseManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the licenseManagement plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licenseManagement'] 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. --- diff --git a/api_docs/licensing.mdx b/api_docs/licensing.mdx index 7f7b279727574..ecb7701fb6a18 100644 --- a/api_docs/licensing.mdx +++ b/api_docs/licensing.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/licensing title: "licensing" image: https://source.unsplash.com/400x175/?github summary: API docs for the licensing plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'licensing'] 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. --- diff --git a/api_docs/lists.devdocs.json b/api_docs/lists.devdocs.json index b996412bec0b1..6dc92b34341c1 100644 --- a/api_docs/lists.devdocs.json +++ b/api_docs/lists.devdocs.json @@ -1372,13 +1372,7 @@ "({ namespaceType, options, }: ", "OpenPointInTimeOptions", ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsOpenPointInTimeResponse", - "text": "SavedObjectsOpenPointInTimeResponse" - }, + "SavedObjectsOpenPointInTimeResponse", ">" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", @@ -1416,13 +1410,7 @@ "({ pit, }: ", "ClosePointInTimeOptions", ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClosePointInTimeResponse", - "text": "SavedObjectsClosePointInTimeResponse" - }, + "SavedObjectsClosePointInTimeResponse", ">" ], "path": "x-pack/plugins/lists/server/services/exception_lists/exception_list_client.ts", @@ -1928,6 +1916,44 @@ "True if the list item template for ILM exists, otherwise false." ] }, + { + "parentPluginId": "lists", + "id": "def-server.ListClient.getLegacyListTemplateExists", + "type": "Function", + "tags": [], + "label": "getLegacyListTemplateExists", + "description": [ + "\nReturns true if the list template for ILM exists, otherwise false" + ], + "signature": [ + "() => Promise" + ], + "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "True if the list template for ILM exists, otherwise false." + ] + }, + { + "parentPluginId": "lists", + "id": "def-server.ListClient.getLegacyListItemTemplateExists", + "type": "Function", + "tags": [], + "label": "getLegacyListItemTemplateExists", + "description": [ + "\nReturns true if the list item template for ILM exists, otherwise false" + ], + "signature": [ + "() => Promise" + ], + "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "True if the list item template for ILM exists, otherwise false." + ] + }, { "parentPluginId": "lists", "id": "def-server.ListClient.getListTemplate", @@ -2156,6 +2182,44 @@ "The contents of the list item template" ] }, + { + "parentPluginId": "lists", + "id": "def-server.ListClient.deleteLegacyListTemplate", + "type": "Function", + "tags": [], + "label": "deleteLegacyListTemplate", + "description": [ + "\nDeletes the list boot strap index for ILM policies." + ], + "signature": [ + "() => Promise" + ], + "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "The contents of the bootstrap response from Elasticsearch" + ] + }, + { + "parentPluginId": "lists", + "id": "def-server.ListClient.deleteLegacyListItemTemplate", + "type": "Function", + "tags": [], + "label": "deleteLegacyListItemTemplate", + "description": [ + "\nDelete the list item boot strap index for ILM policies." + ], + "signature": [ + "() => Promise" + ], + "path": "x-pack/plugins/lists/server/services/lists/list_client.ts", + "deprecated": false, + "children": [], + "returnComment": [ + "The contents of the bootstrap response from Elasticsearch" + ] + }, { "parentPluginId": "lists", "id": "def-server.ListClient.deleteListItem", @@ -3550,13 +3614,7 @@ "description": [], "signature": [ "(savedObjectsClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", user: string, enableServerExtensionPoints?: boolean | undefined) => ", { "pluginId": "lists", @@ -3578,331 +3636,7 @@ "label": "savedObjectsClient", "description": [], "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "SavedObjectsClientContract" ], "path": "x-pack/plugins/lists/server/types.ts", "deprecated": false @@ -4057,32 +3791,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: { (this: That, params: ", "GetRequest", " | ", @@ -4135,32 +3843,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -4231,6 +3939,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", " | ", diff --git a/api_docs/lists.mdx b/api_docs/lists.mdx index d20878cc0c890..2b4e01cdeecbc 100644 --- a/api_docs/lists.mdx +++ b/api_docs/lists.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/lists title: "lists" image: https://source.unsplash.com/400x175/?github summary: API docs for the lists plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'lists'] 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 [Security detections response](https://github.com/orgs/elastic/teams/sec | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 198 | 0 | 90 | 49 | +| 202 | 0 | 90 | 49 | ## Client diff --git a/api_docs/management.mdx b/api_docs/management.mdx index 7b51cd12823a1..874826909957b 100644 --- a/api_docs/management.mdx +++ b/api_docs/management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/management title: "management" image: https://source.unsplash.com/400x175/?github summary: API docs for the management plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'management'] 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. --- diff --git a/api_docs/maps.devdocs.json b/api_docs/maps.devdocs.json index 050fc20374fa3..adf14e6907d43 100644 --- a/api_docs/maps.devdocs.json +++ b/api_docs/maps.devdocs.json @@ -1996,6 +1996,62 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "maps", + "id": "def-public.ITMSSource", + "type": "Interface", + "tags": [], + "label": "ITMSSource", + "description": [], + "signature": [ + { + "pluginId": "maps", + "scope": "public", + "docId": "kibMapsPluginApi", + "section": "def-public.ITMSSource", + "text": "ITMSSource" + }, + " extends ", + "ISource" + ], + "path": "x-pack/plugins/maps/public/classes/sources/tms_source/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "maps", + "id": "def-public.ITMSSource.getUrlTemplate", + "type": "Function", + "tags": [], + "label": "getUrlTemplate", + "description": [], + "signature": [ + "(dataFilters: ", + "DataFilters", + ") => Promise" + ], + "path": "x-pack/plugins/maps/public/classes/sources/tms_source/index.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "maps", + "id": "def-public.ITMSSource.getUrlTemplate.$1", + "type": "Object", + "tags": [], + "label": "dataFilters", + "description": [], + "signature": [ + "DataFilters" + ], + "path": "x-pack/plugins/maps/public/classes/sources/tms_source/index.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "maps", "id": "def-public.ITooltipProperty", diff --git a/api_docs/maps.mdx b/api_docs/maps.mdx index 01b109c680ad6..34e9777a3d8c5 100644 --- a/api_docs/maps.mdx +++ b/api_docs/maps.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/maps title: "maps" image: https://source.unsplash.com/400x175/?github summary: API docs for the maps plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'maps'] 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 [GIS](https://github.com/orgs/elastic/teams/kibana-gis) for questions re | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 250 | 0 | 249 | 25 | +| 253 | 0 | 252 | 25 | ## Client diff --git a/api_docs/maps_ems.mdx b/api_docs/maps_ems.mdx index 3205a03142b17..f35b1c1042c43 100644 --- a/api_docs/maps_ems.mdx +++ b/api_docs/maps_ems.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/mapsEms title: "mapsEms" image: https://source.unsplash.com/400x175/?github summary: API docs for the mapsEms plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms'] 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. --- diff --git a/api_docs/ml.devdocs.json b/api_docs/ml.devdocs.json index 2b79974865379..234dc00a385fc 100644 --- a/api_docs/ml.devdocs.json +++ b/api_docs/ml.devdocs.json @@ -2757,13 +2757,7 @@ " & ", "ResultsServiceProvider", " & { alertingServiceProvider(savedObjectsClient: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", ", request: ", "KibanaRequest", "): { preview: (args_0: Readonly<{} & { timeRange: string; alertParams: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>; sampleSize: number; }>) => Promise; execute: (params: Readonly<{} & { severity: number; jobSelection: Readonly<{} & { groupIds: string[]; jobIds: string[]; }>; resultType: \"bucket\" | \"record\" | \"influencer\"; includeInterim: boolean; lookbackInterval: string | null; topNBuckets: number | null; }>) => Promise<{ context: ", diff --git a/api_docs/ml.mdx b/api_docs/ml.mdx index 33e8248a7c78b..3b28bc26ef5a5 100644 --- a/api_docs/ml.mdx +++ b/api_docs/ml.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ml title: "ml" image: https://source.unsplash.com/400x175/?github summary: API docs for the ml plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ml'] 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. --- diff --git a/api_docs/monitoring.mdx b/api_docs/monitoring.mdx index 0d22de8925869..69a77cb713880 100644 --- a/api_docs/monitoring.mdx +++ b/api_docs/monitoring.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoring title: "monitoring" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoring plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoring'] 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. --- diff --git a/api_docs/monitoring_collection.mdx b/api_docs/monitoring_collection.mdx index 69c1d0a0e8f3f..f09d8ab9fc9f8 100644 --- a/api_docs/monitoring_collection.mdx +++ b/api_docs/monitoring_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/monitoringCollection title: "monitoringCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the monitoringCollection plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'monitoringCollection'] 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. --- diff --git a/api_docs/navigation.devdocs.json b/api_docs/navigation.devdocs.json index a7763c89bcdd8..ef0f393abbb0d 100644 --- a/api_docs/navigation.devdocs.json +++ b/api_docs/navigation.devdocs.json @@ -238,7 +238,7 @@ "section": "def-public.TopNavMenuProps", "text": "TopNavMenuProps" }, - ") => React.ReactElement> | null" + ") => React.ReactElement> | null" ], "path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx", "deprecated": false, @@ -257,7 +257,8 @@ "docId": "kibNavigationPluginApi", "section": "def-public.TopNavMenuProps", "text": "TopNavMenuProps" - } + }, + "" ], "path": "src/plugins/navigation/public/top_nav_menu/top_nav_menu.tsx", "deprecated": false, @@ -653,7 +654,7 @@ "description": [], "signature": [ "SearchBarOwnProps", - " & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; } & Omit<", + " & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; } & Omit<", { "pluginId": "unifiedSearch", "scope": "public", @@ -661,7 +662,7 @@ "section": "def-public.SearchBarProps", "text": "SearchBarProps" }, - ", \"kibana\" | \"intl\" | \"timeHistory\"> & { config?: ", + ", \"kibana\" | \"intl\" | \"timeHistory\"> & { config?: ", { "pluginId": "navigation", "scope": "public", @@ -758,7 +759,17 @@ "label": "ui", "description": [], "signature": [ - "{ TopNavMenu: React.ComponentType<", + "{ TopNavMenu: (props: ", + { + "pluginId": "navigation", + "scope": "public", + "docId": "kibNavigationPluginApi", + "section": "def-public.TopNavMenuProps", + "text": "TopNavMenuProps" + }, + "<", + "Query", + ">) => React.ReactElement>; AggregateQueryTopNavMenu: (props: ", { "pluginId": "navigation", "scope": "public", @@ -766,7 +777,9 @@ "section": "def-public.TopNavMenuProps", "text": "TopNavMenuProps" }, - ">; }" + "<", + "AggregateQuery", + ">) => React.ReactElement>; }" ], "path": "src/plugins/navigation/public/types.ts", "deprecated": false diff --git a/api_docs/navigation.mdx b/api_docs/navigation.mdx index fd380ca88a7e1..6f2d24e312a40 100644 --- a/api_docs/navigation.mdx +++ b/api_docs/navigation.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/navigation title: "navigation" image: https://source.unsplash.com/400x175/?github summary: API docs for the navigation plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'navigation'] 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. --- diff --git a/api_docs/newsfeed.mdx b/api_docs/newsfeed.mdx index af7b5e812db40..fc8b39c58712d 100644 --- a/api_docs/newsfeed.mdx +++ b/api_docs/newsfeed.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/newsfeed title: "newsfeed" image: https://source.unsplash.com/400x175/?github summary: API docs for the newsfeed plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'newsfeed'] 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. --- diff --git a/api_docs/observability.devdocs.json b/api_docs/observability.devdocs.json index 5e64c2d86ab6b..15507ff1c804e 100644 --- a/api_docs/observability.devdocs.json +++ b/api_docs/observability.devdocs.json @@ -2083,6 +2083,19 @@ "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/embeddable/embeddable.tsx", "deprecated": false }, + { + "parentPluginId": "observability", + "id": "def-public.ExploratoryEmbeddableProps.hideTicks", + "type": "CompoundType", + "tags": [], + "label": "hideTicks", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/observability/public/components/shared/exploratory_view/embeddable/embeddable.tsx", + "deprecated": false + }, { "parentPluginId": "observability", "id": "def-public.ExploratoryEmbeddableProps.onBrushEnd", @@ -5476,32 +5489,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: { (this: That, params: ", "GetRequest", " | ", @@ -5554,32 +5541,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -5650,6 +5637,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", " | ", diff --git a/api_docs/observability.mdx b/api_docs/observability.mdx index 09f340dde85c8..d3a34bfa2539c 100644 --- a/api_docs/observability.mdx +++ b/api_docs/observability.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/observability title: "observability" image: https://source.unsplash.com/400x175/?github summary: API docs for the observability plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'observability'] 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 [Observability UI](https://github.com/orgs/elastic/teams/observability-u | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 388 | 2 | 385 | 31 | +| 389 | 2 | 386 | 31 | ## Client diff --git a/api_docs/osquery.mdx b/api_docs/osquery.mdx index 5dd65abe02ac4..ce63e4fb3fbcb 100644 --- a/api_docs/osquery.mdx +++ b/api_docs/osquery.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/osquery title: "osquery" image: https://source.unsplash.com/400x175/?github summary: API docs for the osquery plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery'] 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. --- diff --git a/api_docs/plugin_directory.mdx b/api_docs/plugin_directory.mdx index 2a080a8847b52..9bc54455199dd 100644 --- a/api_docs/plugin_directory.mdx +++ b/api_docs/plugin_directory.mdx @@ -3,7 +3,7 @@ id: kibDevDocsPluginDirectory slug: /kibana-dev-docs/api-meta/plugin-api-directory title: Directory summary: Directory of public APIs available through plugins or packages. -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana'] 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. --- @@ -12,50 +12,50 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | Count | Plugins or Packages with a
public API | Number of teams | |--------------|----------|------------------------| -| 351 | 296 | 36 | +| 369 | 311 | 37 | ### Public API health stats | API Count | Any Count | Missing comments | Missing exports | |--------------|----------|-----------------|--------| -| 27980 | 176 | 19807 | 882 | +| 28205 | 171 | 19405 | 889 | ## Plugin Directory | Plugin name           | Maintaining team | Description | API Cnt | Any Cnt | Missing
comments | Missing
exports | |--------------|----------------|-----------|--------------|----------|---------------|--------| -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 241 | 0 | 236 | 19 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 266 | 0 | 261 | 19 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 23 | 0 | 19 | 1 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | AIOps plugin maintained by ML team. | 9 | 0 | 0 | 1 | | | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 368 | 0 | 359 | 21 | -| | [APM UI](https://github.com/orgs/elastic/teams/apm-ui) | The user interface for Elastic APM | 40 | 0 | 40 | 53 | +| | [APM UI](https://github.com/orgs/elastic/teams/apm-ui) | The user interface for Elastic APM | 40 | 0 | 40 | 54 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 9 | 0 | 9 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Considering using bfetch capabilities when fetching large amounts of data. This services supports batching HTTP requests and streaming responses back. | 78 | 1 | 69 | 2 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds Canvas application to Kibana | 9 | 0 | 8 | 3 | | | [ResponseOps](https://github.com/orgs/elastic/teams/response-ops) | The Case management system in Kibana | 81 | 0 | 65 | 28 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 272 | 2 | 253 | 9 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 29 | 0 | 24 | 0 | -| | [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-posture-security) | The cloud security posture plugin | 19 | 0 | 2 | 1 | +| | [Cloud Security Posture](https://github.com/orgs/elastic/teams/cloud-posture-security) | The cloud security posture plugin | 18 | 0 | 2 | 3 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 13 | 0 | 13 | 1 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Controls Plugin contains embeddable components intended to create a simple query interface for end users, and a powerful editing suite that allows dashboard authors to build controls | 206 | 0 | 198 | 7 | -| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2470 | 5 | 664 | 17 | +| | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 2498 | 2 | 413 | 8 | | crossClusterReplication | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | | [Fleet](https://github.com/orgs/elastic/teams/fleet) | Add custom data integrations so they can be displayed in the Fleet integrations app | 102 | 0 | 83 | 1 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds the Dashboard app to Kibana | 143 | 0 | 141 | 12 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 52 | 0 | 51 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3094 | 34 | 2421 | 21 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 3097 | 34 | 2420 | 21 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | This plugin provides the ability to create data views via a modal flyout inside Kibana apps | 15 | 0 | 7 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Reusable data view field editor across Kibana | 49 | 0 | 29 | 3 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data view management app | 2 | 0 | 2 | 0 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 945 | 0 | 203 | 0 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Data services are useful for searching and querying data from Elasticsearch. Helpful utilities include: a re-usable react query bar, KQL autocomplete, async search, Data Views (Index Patterns) and field formatters. | 945 | 0 | 201 | 0 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The Data Visualizer tools help you understand your data, by analyzing the metrics and fields in a log file or an existing Elasticsearch index. | 28 | 3 | 24 | 1 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 10 | 0 | 8 | 2 | -| | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the Discover application and the saved search embeddable. | 82 | 0 | 66 | 7 | +| | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | This plugin contains the Discover application and the saved search embeddable. | 84 | 0 | 68 | 7 | | | [Data Discovery](https://github.com/orgs/elastic/teams/kibana-data-discovery) | - | 37 | 0 | 35 | 2 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds embeddables service to Kibana | 505 | 0 | 413 | 3 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds embeddables service to Kibana | 507 | 0 | 413 | 4 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Extends embeddable plugin with more functionality | 14 | 0 | 14 | 0 | | | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides encryption and decryption utilities for saved objects containing sensitive information. | 51 | 0 | 44 | 0 | -| | [Enterprise Search](https://github.com/orgs/elastic/teams/enterprise-search-frontend) | Adds dashboards for discovering and managing Enterprise Search products. | 5 | 0 | 5 | 0 | +| | [Enterprise Search](https://github.com/orgs/elastic/teams/enterprise-search-frontend) | Adds dashboards for discovering and managing Enterprise Search products. | 6 | 0 | 6 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 114 | 3 | 110 | 3 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | The Event Annotation service contains expressions for event annotations | 95 | 0 | 95 | 6 | | | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 100 | 0 | 100 | 9 | @@ -65,18 +65,18 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'image' function and renderer to expressions | 26 | 0 | 26 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Adds a `metric` renderer and function to the expression plugin. The renderer will display the `legacy metric` chart. | 48 | 0 | 48 | 1 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'metric' function and renderer to expressions | 32 | 0 | 27 | 0 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Adds a `metric` renderer and function to the expression plugin. The renderer will display the `metric` chart. | 47 | 0 | 47 | 0 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Adds a `metric` renderer and function to the expression plugin. The renderer will display the `metric` chart. | 56 | 0 | 56 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Partition Visualization plugin adds a `partitionVis` renderer and `pieVis`, `mosaicVis`, `treemapVis`, `waffleVis` functions to the expression plugin. The renderer will display the `pie`, `waffle`, `treemap` and `mosaic` charts. | 70 | 0 | 70 | 2 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'repeatImage' function and renderer to expressions | 32 | 0 | 32 | 0 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'revealImage' function and renderer to expressions | 14 | 0 | 14 | 3 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | Adds 'shape' function and renderer to expressions | 148 | 0 | 146 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression Tagcloud plugin adds a `tagcloud` renderer and function to the expression plugin. The renderer will display the `Wordcloud` chart. | 7 | 0 | 7 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Expression XY plugin adds a `xy` renderer and function to the expression plugin. The renderer will display the `xy` chart. | 150 | 0 | 140 | 14 | -| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds expression runtime to Kibana | 2180 | 17 | 1726 | 5 | +| | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds expression runtime to Kibana | 2183 | 17 | 1729 | 5 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 222 | 0 | 95 | 2 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Index pattern fields and ambiguous values formatters | 288 | 5 | 249 | 3 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | The file upload plugin contains components and services for uploading a file, analyzing its data, and then importing the data into an Elasticsearch index. Supported file types include CSV, TSV, newline-delimited JSON and GeoJSON. | 62 | 0 | 62 | 2 | -| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 1541 | 8 | 1409 | 10 | +| | [Fleet](https://github.com/orgs/elastic/teams/fleet) | - | 953 | 3 | 858 | 9 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 68 | 0 | 14 | 5 | | globalSearchBar | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | | globalSearchProviders | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 0 | 0 | 0 | 0 | @@ -95,21 +95,21 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | kibanaUsageCollection | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 0 | 0 | 0 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 615 | 3 | 420 | 9 | | | [Security Team](https://github.com/orgs/elastic/teams/security-team) | - | 3 | 0 | 3 | 1 | -| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 602 | 0 | 524 | 40 | +| | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | Visualization editor allowing to quickly and easily configure compelling visualizations to use on dashboards and canvas workpads. Exposes components to embed visualizations and link into the Lens editor from within other apps in Kibana. | 608 | 0 | 527 | 41 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 8 | 0 | 8 | 0 | | | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 3 | 0 | 3 | 0 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 117 | 0 | 42 | 10 | -| | [Security detections response](https://github.com/orgs/elastic/teams/security-detections-response) | - | 198 | 0 | 90 | 49 | +| | [Security detections response](https://github.com/orgs/elastic/teams/security-detections-response) | - | 202 | 0 | 90 | 49 | | logstash | [Logstash](https://github.com/orgs/elastic/teams/logstash) | - | 0 | 0 | 0 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 41 | 0 | 41 | 6 | -| | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 250 | 0 | 249 | 25 | +| | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 253 | 0 | 252 | 25 | | | [GIS](https://github.com/orgs/elastic/teams/kibana-gis) | - | 67 | 0 | 67 | 0 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the machine learning features provided by Elastic. | 244 | 9 | 71 | 30 | | | [Stack Monitoring](https://github.com/orgs/elastic/teams/stack-monitoring-ui) | - | 11 | 0 | 9 | 1 | | | [Stack Monitoring](https://github.com/orgs/elastic/teams/stack-monitoring-ui) | - | 9 | 0 | 9 | 0 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 34 | 0 | 34 | 2 | | | [Kibana Core](https://github.com/orgs/elastic/teams/kibana-core) | - | 17 | 0 | 17 | 0 | -| | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 388 | 2 | 385 | 31 | +| | [Observability UI](https://github.com/orgs/elastic/teams/observability-ui) | - | 389 | 2 | 386 | 31 | | | [Security asset management](https://github.com/orgs/elastic/teams/security-asset-management) | - | 13 | 0 | 13 | 0 | | painlessLab | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | | [Kibana Presentation](https://github.com/orgs/elastic/teams/kibana-presentation) | The Presentation Utility Plugin is a set of common, shared components and toolkits for solutions within the Presentation space, (e.g. Dashboards, Canvas). | 231 | 2 | 180 | 11 | @@ -125,8 +125,8 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | - | 32 | 0 | 13 | 0 | | | [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana-reporting-services) | Kibana Screenshotting Plugin | 27 | 0 | 8 | 4 | | searchprofiler | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | -| | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user. | 225 | 0 | 90 | 0 | -| | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 52 | 0 | 51 | 22 | +| | [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) | This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user. | 236 | 0 | 90 | 0 | +| | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 54 | 0 | 53 | 22 | | | [Security Team](https://github.com/orgs/elastic/teams/security-team) | - | 3 | 0 | 3 | 1 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds URL Service and sharing capabilities to Kibana | 114 | 0 | 55 | 10 | | | [Shared UX](https://github.com/orgs/elastic/teams/shared-ux) | A plugin providing components and services for shared user experiences in Kibana. | 4 | 0 | 0 | 0 | @@ -139,13 +139,14 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 31 | 0 | 26 | 6 | | | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 1 | 0 | 1 | 0 | | | [Kibana Telemetry](https://github.com/orgs/elastic/teams/kibana-telemetry) | - | 11 | 0 | 10 | 0 | +| | [Protections Experience Team](https://github.com/orgs/elastic/teams/protections-experience) | Elastic threat intelligence helps you see if you are open to or have been subject to current or historical known threats | 3 | 0 | 3 | 0 | | | [Security solution](https://github.com/orgs/elastic/teams/security-solution) | - | 447 | 1 | 342 | 32 | | | [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) | This plugin provides access to the transforms features provided by Elastic. Transforms enable you to convert existing Elasticsearch indices into summarized indices, which provide opportunities for new insights and analytics. | 4 | 0 | 4 | 1 | | translations | [Kibana Localization](https://github.com/orgs/elastic/teams/kibana-localization) | - | 0 | 0 | 0 | 0 | -| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 420 | 0 | 399 | 42 | +| | [Response Ops](https://github.com/orgs/elastic/teams/response-ops) | - | 426 | 0 | 405 | 46 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds UI Actions service to Kibana | 130 | 0 | 91 | 11 | | | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Extends UI Actions plugin with more functionality | 205 | 0 | 142 | 9 | -| | [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-services) | Contains all the key functionality of Kibana's unified search experience.Contains all the key functionality of Kibana's unified search experience. | 84 | 2 | 80 | 13 | +| | [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-services) | Contains all the key functionality of Kibana's unified search experience.Contains all the key functionality of Kibana's unified search experience. | 98 | 2 | 84 | 16 | | upgradeAssistant | [Stack Management](https://github.com/orgs/elastic/teams/kibana-stack-management) | - | 0 | 0 | 0 | 0 | | urlDrilldown | [App Services](https://github.com/orgs/elastic/teams/kibana-app-services) | Adds drilldown implementations to Kibana | 0 | 0 | 0 | 0 | | | [Vis Editors](https://github.com/orgs/elastic/teams/kibana-vis-editors) | - | 12 | 0 | 12 | 0 | @@ -204,6 +205,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 20 | 0 | 3 | 0 | | | [Owner missing] | - | 7 | 0 | 7 | 0 | | | [Owner missing] | - | 3 | 0 | 3 | 0 | +| | [Owner missing] | - | 5 | 0 | 0 | 0 | +| | [Owner missing] | - | 16 | 0 | 7 | 0 | +| | [Owner missing] | - | 6 | 0 | 6 | 0 | | | [Owner missing] | - | 15 | 0 | 13 | 0 | | | [Owner missing] | - | 9 | 0 | 3 | 0 | | | [Owner missing] | - | 6 | 0 | 6 | 0 | @@ -248,11 +252,19 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 56 | 0 | 30 | 0 | | | [Owner missing] | - | 9 | 0 | 5 | 1 | | | [Owner missing] | - | 13 | 0 | 12 | 0 | +| | [Owner missing] | - | 24 | 0 | 20 | 0 | +| | [Owner missing] | - | 11 | 1 | 11 | 0 | +| | [Owner missing] | - | 48 | 0 | 8 | 0 | +| | [Owner missing] | - | 5 | 0 | 5 | 0 | +| | [Owner missing] | - | 7 | 0 | 7 | 0 | | | [Owner missing] | - | 5 | 0 | 0 | 0 | | | [Owner missing] | - | 3 | 0 | 3 | 0 | | | [Owner missing] | - | 3 | 0 | 3 | 0 | | | [Owner missing] | - | 5 | 0 | 0 | 0 | | | [Owner missing] | - | 6 | 0 | 6 | 0 | +| | [Owner missing] | - | 94 | 1 | 66 | 0 | +| | [Owner missing] | - | 288 | 1 | 125 | 0 | +| | [Owner missing] | - | 82 | 0 | 41 | 0 | | | [Owner missing] | - | 5 | 0 | 5 | 0 | | | [Owner missing] | - | 6 | 0 | 4 | 0 | | | [Owner missing] | - | 2 | 0 | 1 | 0 | @@ -272,23 +284,25 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 1 | 0 | 1 | 0 | | | [Owner missing] | - | 27 | 0 | 14 | 1 | | | [Owner missing] | - | 7 | 0 | 3 | 0 | -| | [Owner missing] | - | 213 | 1 | 159 | 12 | +| | [Owner missing] | - | 222 | 1 | 168 | 12 | | | [Owner missing] | - | 2 | 0 | 1 | 0 | | | [Owner missing] | - | 20 | 0 | 16 | 0 | | | [Owner missing] | - | 2 | 0 | 0 | 0 | | | [Owner missing] | - | 1 | 0 | 0 | 0 | +| | [Owner missing] | - | 3 | 0 | 0 | 0 | | | [Owner missing] | - | 6 | 0 | 0 | 0 | | | [Owner missing] | - | 3 | 0 | 3 | 0 | -| | [Owner missing] | - | 10 | 0 | 4 | 2 | +| | [Owner missing] | - | 32 | 0 | 22 | 0 | +| | [Owner missing] | - | 8 | 0 | 2 | 2 | | | [Owner missing] | - | 51 | 0 | 48 | 0 | | | [Owner missing] | - | 43 | 0 | 36 | 0 | | | App Services | - | 35 | 4 | 35 | 0 | | | [Owner missing] | - | 20 | 0 | 20 | 2 | | | [Owner missing] | - | 13 | 0 | 13 | 0 | | | [Owner missing] | - | 69 | 0 | 69 | 0 | -| | [Owner missing] | - | 30 | 0 | 5 | 36 | +| | [Owner missing] | - | 30 | 0 | 5 | 37 | | | [Owner missing] | - | 8 | 0 | 8 | 0 | -| | [Owner missing] | - | 494 | 1 | 1 | 0 | +| | [Owner missing] | - | 534 | 1 | 1 | 0 | | | Machine Learning UI | This package includes utility functions related to creating elasticsearch aggregation queries, data manipulation and verification. | 53 | 2 | 35 | 4 | | | Machine Learning UI | A type guard to check record like object structures. | 3 | 0 | 2 | 0 | | | Machine Learning UI | Creates a deterministic number based hash out of a string. | 2 | 0 | 1 | 0 | @@ -299,14 +313,15 @@ warning: This document is auto-generated and is meant to be viewed inside our ex | | [Owner missing] | - | 1 | 0 | 1 | 0 | | | [Owner missing] | Just some helpers for kibana plugin devs. | 1 | 0 | 1 | 0 | | | [Owner missing] | - | 21 | 0 | 10 | 0 | +| | [Owner missing] | - | 6 | 0 | 6 | 1 | | | [Owner missing] | - | 74 | 0 | 71 | 0 | | | [Owner missing] | A library to generate scalability benchmarking simulation files from APM traces. | 3 | 0 | 3 | 1 | | | [Owner missing] | Security Solution auto complete | 50 | 1 | 35 | 0 | -| | [Owner missing] | security solution elastic search utilities to use across plugins such lists, security_solution, cases, etc... | 57 | 0 | 51 | 1 | +| | [Owner missing] | security solution elastic search utilities to use across plugins such lists, security_solution, cases, etc... | 67 | 0 | 61 | 1 | | | [Owner missing] | Security Solution utilities for React hooks | 15 | 0 | 7 | 0 | | | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 148 | 0 | 129 | 0 | | | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 458 | 1 | 446 | 0 | -| | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 54 | 0 | 32 | 0 | +| | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 61 | 0 | 32 | 0 | | | [Owner missing] | io ts utilities and types to be shared with plugins from the security solution project | 28 | 0 | 21 | 0 | | | [Owner missing] | security solution list REST API | 59 | 0 | 58 | 0 | | | [Owner missing] | security solution list constants to use across plugins such lists, security_solution, cases, etc... | 26 | 0 | 12 | 0 | diff --git a/api_docs/presentation_util.devdocs.json b/api_docs/presentation_util.devdocs.json index e07810e3f3910..667d6c5bc7c5b 100644 --- a/api_docs/presentation_util.devdocs.json +++ b/api_docs/presentation_util.devdocs.json @@ -2061,13 +2061,7 @@ "description": [], "signature": [ "(query: string, fields: string[]) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, + "SimpleSavedObject", "<", "PartialDashboardAttributes", ">[]>" @@ -2115,13 +2109,7 @@ "description": [], "signature": [ "(title: string) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, + "SimpleSavedObject", "<", "PartialDashboardAttributes", ">[]>" diff --git a/api_docs/presentation_util.mdx b/api_docs/presentation_util.mdx index 097409834d83e..003a778aa275b 100644 --- a/api_docs/presentation_util.mdx +++ b/api_docs/presentation_util.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/presentationUtil title: "presentationUtil" image: https://source.unsplash.com/400x175/?github summary: API docs for the presentationUtil plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'presentationUtil'] 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. --- diff --git a/api_docs/remote_clusters.mdx b/api_docs/remote_clusters.mdx index 28e2e6c19e2d1..758bc8b96beb4 100644 --- a/api_docs/remote_clusters.mdx +++ b/api_docs/remote_clusters.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/remoteClusters title: "remoteClusters" image: https://source.unsplash.com/400x175/?github summary: API docs for the remoteClusters plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'remoteClusters'] 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. --- diff --git a/api_docs/reporting.mdx b/api_docs/reporting.mdx index d34463567e3ca..0f54a93799a0b 100644 --- a/api_docs/reporting.mdx +++ b/api_docs/reporting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/reporting title: "reporting" image: https://source.unsplash.com/400x175/?github summary: API docs for the reporting plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'reporting'] 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. --- diff --git a/api_docs/rollup.mdx b/api_docs/rollup.mdx index 6235cf3fbcda3..1ecbb41e1236f 100644 --- a/api_docs/rollup.mdx +++ b/api_docs/rollup.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/rollup title: "rollup" image: https://source.unsplash.com/400x175/?github summary: API docs for the rollup plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'rollup'] 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. --- diff --git a/api_docs/rule_registry.devdocs.json b/api_docs/rule_registry.devdocs.json index 0ee80d8c5d8b9..20d37238bea29 100644 --- a/api_docs/rule_registry.devdocs.json +++ b/api_docs/rule_registry.devdocs.json @@ -1748,7 +1748,7 @@ "\nID of the Kibana feature associated with the index.\nUsed by alerts-as-data RBAC.\n\nNote from @dhurley14\nThe purpose of the `feature` param is to force the user to update\nthe data structure which contains the mapping of consumers to alerts\nas data indices. The idea is it is typed such that it forces the\nuser to go to the code and modify it. At least until a better system\nis put in place or we move the alerts as data client out of rule registry.\n" ], "signature": [ - "\"logs\" | \"apm\" | \"infrastructure\" | \"observability\" | \"uptime\" | \"siem\"" + "\"logs\" | \"apm\" | \"uptime\" | \"siem\" | \"infrastructure\" | \"observability\"" ], "path": "x-pack/plugins/rule_registry/server/rule_data_plugin_service/index_options.ts", "deprecated": false diff --git a/api_docs/rule_registry.mdx b/api_docs/rule_registry.mdx index 86081fa33aaca..a479a633eab0d 100644 --- a/api_docs/rule_registry.mdx +++ b/api_docs/rule_registry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ruleRegistry title: "ruleRegistry" image: https://source.unsplash.com/400x175/?github summary: API docs for the ruleRegistry plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ruleRegistry'] 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. --- diff --git a/api_docs/runtime_fields.mdx b/api_docs/runtime_fields.mdx index 691dd8bfb0355..0154b093fcdb2 100644 --- a/api_docs/runtime_fields.mdx +++ b/api_docs/runtime_fields.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/runtimeFields title: "runtimeFields" image: https://source.unsplash.com/400x175/?github summary: API docs for the runtimeFields plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'runtimeFields'] 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. --- diff --git a/api_docs/saved_objects.devdocs.json b/api_docs/saved_objects.devdocs.json index a82de64b5da32..7f5487ebc524a 100644 --- a/api_docs/saved_objects.devdocs.json +++ b/api_docs/saved_objects.devdocs.json @@ -976,21 +976,9 @@ "(source: ", "SavedObjectAttributes", ", savedObject: { getEsType(): string; title: string; displayName: string; }, options: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, + "SavedObjectsCreateOptions", ", services: { savedObjectsClient: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - }, + "SavedObjectsClientContract", "; overlays: ", { "pluginId": "core", @@ -1000,13 +988,7 @@ "text": "OverlayStart" }, "; }) => Promise<", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, + "SimpleSavedObject", "<", "SavedObjectAttributes", ">>" @@ -1087,13 +1069,7 @@ "- options to pass to the saved object create method" ], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - } + "SavedObjectsCreateOptions" ], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "deprecated": false, @@ -1117,13 +1093,7 @@ "label": "savedObjectsClient", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SavedObjectsClientContract", - "text": "SavedObjectsClientContract" - } + "SavedObjectsClientContract" ], "path": "src/plugins/saved_objects/public/saved_object/helpers/save_with_confirmation.ts", "deprecated": false @@ -2569,13 +2539,7 @@ "description": [], "signature": [ "(savedObject: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, + "SimpleSavedObject", ") => ", "IconType" ], @@ -2590,13 +2554,7 @@ "label": "savedObject", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, + "SimpleSavedObject", "" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", @@ -2615,13 +2573,7 @@ "description": [], "signature": [ "((savedObject: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, + "SimpleSavedObject", ") => string) | undefined" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", @@ -2635,13 +2587,7 @@ "label": "savedObject", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, + "SimpleSavedObject", "" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", @@ -2660,13 +2606,7 @@ "description": [], "signature": [ "((savedObject: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, + "SimpleSavedObject", ") => boolean) | undefined" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", @@ -2680,13 +2620,7 @@ "label": "savedObject", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, + "SimpleSavedObject", "" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", @@ -2705,13 +2639,7 @@ "description": [], "signature": [ "((savedObject: ", - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, + "SimpleSavedObject", ") => string) | undefined" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", @@ -2725,13 +2653,7 @@ "label": "savedObject", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "public", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-public.SimpleSavedObject", - "text": "SimpleSavedObject" - }, + "SimpleSavedObject", "" ], "path": "src/plugins/saved_objects/public/finder/saved_object_finder.tsx", diff --git a/api_docs/saved_objects.mdx b/api_docs/saved_objects.mdx index e5b7eaa7a0bc5..8e85078ec8dd6 100644 --- a/api_docs/saved_objects.mdx +++ b/api_docs/saved_objects.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjects title: "savedObjects" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjects plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', '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. --- diff --git a/api_docs/saved_objects_management.devdocs.json b/api_docs/saved_objects_management.devdocs.json index 336a2c0cc5684..8d93367005c6c 100644 --- a/api_docs/saved_objects_management.devdocs.json +++ b/api_docs/saved_objects_management.devdocs.json @@ -438,13 +438,7 @@ "description": [], "signature": [ "(response: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" - }, + "SavedObjectsImportResponse", ") => ", { "pluginId": "savedObjectsManagement", @@ -465,13 +459,7 @@ "label": "response", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" - } + "SavedObjectsImportResponse" ], "path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts", "deprecated": false, @@ -514,45 +502,15 @@ "label": "error", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportConflictError", - "text": "SavedObjectsImportConflictError" - }, + "SavedObjectsImportConflictError", " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportAmbiguousConflictError", - "text": "SavedObjectsImportAmbiguousConflictError" - }, + "SavedObjectsImportAmbiguousConflictError", " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportUnsupportedTypeError", - "text": "SavedObjectsImportUnsupportedTypeError" - }, + "SavedObjectsImportUnsupportedTypeError", " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportMissingReferencesError", - "text": "SavedObjectsImportMissingReferencesError" - }, + "SavedObjectsImportMissingReferencesError", " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportUnknownError", - "text": "SavedObjectsImportUnknownError" - } + "SavedObjectsImportUnknownError" ], "path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts", "deprecated": false @@ -598,13 +556,7 @@ "label": "successfulImports", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportSuccess", - "text": "SavedObjectsImportSuccess" - }, + "SavedObjectsImportSuccess", "[]" ], "path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts", @@ -654,13 +606,7 @@ "label": "importWarnings", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportWarning", - "text": "SavedObjectsImportWarning" - }, + "SavedObjectsImportWarning", "[]" ], "path": "src/plugins/saved_objects_management/public/lib/process_import_response.ts", @@ -797,13 +743,7 @@ "label": "namespaceType", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsNamespaceType", - "text": "SavedObjectsNamespaceType" - }, + "SavedObjectsNamespaceType", " | undefined" ], "path": "src/plugins/saved_objects_management/common/types.ts", @@ -1157,13 +1097,7 @@ "description": [], "signature": [ "{ icon: string; title: string; namespaceType: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsNamespaceType", - "text": "SavedObjectsNamespaceType" - }, + "SavedObjectsNamespaceType", "; hiddenType: boolean; }" ], "path": "src/plugins/saved_objects_management/public/services/types/record.ts", @@ -1582,13 +1516,7 @@ "label": "namespaceType", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsNamespaceType", - "text": "SavedObjectsNamespaceType" - }, + "SavedObjectsNamespaceType", " | undefined" ], "path": "src/plugins/saved_objects_management/common/types.ts", @@ -1908,13 +1836,7 @@ "label": "namespaceType", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsNamespaceType", - "text": "SavedObjectsNamespaceType" - }, + "SavedObjectsNamespaceType", " | undefined" ], "path": "src/plugins/saved_objects_management/common/types.ts", diff --git a/api_docs/saved_objects_management.mdx b/api_docs/saved_objects_management.mdx index 399ae8e016837..795ad94e7343b 100644 --- a/api_docs/saved_objects_management.mdx +++ b/api_docs/saved_objects_management.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsManagement title: "savedObjectsManagement" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsManagement plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsManagement'] 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. --- diff --git a/api_docs/saved_objects_tagging.devdocs.json b/api_docs/saved_objects_tagging.devdocs.json index 5221f4d8ada4d..475570c07c276 100644 --- a/api_docs/saved_objects_tagging.devdocs.json +++ b/api_docs/saved_objects_tagging.devdocs.json @@ -105,331 +105,7 @@ "label": "client", "description": [], "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "SavedObjectsClientContract" ], "path": "x-pack/plugins/saved_objects_tagging/server/types.ts", "deprecated": false @@ -455,331 +131,7 @@ "label": "client", "description": [], "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "SavedObjectsClientContract" ], "path": "x-pack/plugins/saved_objects_tagging/server/types.ts", "deprecated": false diff --git a/api_docs/saved_objects_tagging.mdx b/api_docs/saved_objects_tagging.mdx index 3814574b9cbaa..9522a744c0a80 100644 --- a/api_docs/saved_objects_tagging.mdx +++ b/api_docs/saved_objects_tagging.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTagging title: "savedObjectsTagging" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTagging plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTagging'] 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. --- diff --git a/api_docs/saved_objects_tagging_oss.devdocs.json b/api_docs/saved_objects_tagging_oss.devdocs.json index 655deeb8f1380..2606fbbae6145 100644 --- a/api_docs/saved_objects_tagging_oss.devdocs.json +++ b/api_docs/saved_objects_tagging_oss.devdocs.json @@ -142,13 +142,7 @@ "label": "tagReferences", "description": [], "signature": [ - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, + "SavedObjectsFindOptionsReference", "[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", @@ -535,13 +529,7 @@ ], "signature": [ "(tagName: string) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, + "SavedObjectsFindOptionsReference", " | undefined" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", @@ -649,13 +637,7 @@ "(references: (", "SavedObjectReference", " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, + "SavedObjectsFindOptionsReference", ")[]) => string[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", @@ -672,13 +654,7 @@ "(", "SavedObjectReference", " | ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsFindOptionsReference", - "text": "SavedObjectsFindOptionsReference" - }, + "SavedObjectsFindOptionsReference", ")[]" ], "path": "src/plugins/saved_objects_tagging_oss/public/api.ts", diff --git a/api_docs/saved_objects_tagging_oss.mdx b/api_docs/saved_objects_tagging_oss.mdx index bec2172fa830a..9cd503269d296 100644 --- a/api_docs/saved_objects_tagging_oss.mdx +++ b/api_docs/saved_objects_tagging_oss.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/savedObjectsTaggingOss title: "savedObjectsTaggingOss" image: https://source.unsplash.com/400x175/?github summary: API docs for the savedObjectsTaggingOss plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'savedObjectsTaggingOss'] 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. --- diff --git a/api_docs/screenshot_mode.mdx b/api_docs/screenshot_mode.mdx index 3d42974c08a83..10f1807594b6f 100644 --- a/api_docs/screenshot_mode.mdx +++ b/api_docs/screenshot_mode.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotMode title: "screenshotMode" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotMode plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotMode'] 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. --- diff --git a/api_docs/screenshotting.mdx b/api_docs/screenshotting.mdx index c5d5a62f6afaf..e5309f5ee4470 100644 --- a/api_docs/screenshotting.mdx +++ b/api_docs/screenshotting.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/screenshotting title: "screenshotting" image: https://source.unsplash.com/400x175/?github summary: API docs for the screenshotting plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'screenshotting'] 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. --- diff --git a/api_docs/security.devdocs.json b/api_docs/security.devdocs.json index 8812e523128d3..cf8b9e1cfd29e 100644 --- a/api_docs/security.devdocs.json +++ b/api_docs/security.devdocs.json @@ -716,6 +716,78 @@ } ], "initialIsOpen": false + }, + { + "parentPluginId": "security", + "id": "def-public.UserProfileBulkGetParams", + "type": "Interface", + "tags": [], + "label": "UserProfileBulkGetParams", + "description": [ + "\nParameters for the bulk get API." + ], + "path": "x-pack/plugins/security/public/account_management/user_profile/user_profile_api_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "security", + "id": "def-public.UserProfileBulkGetParams.uids", + "type": "Object", + "tags": [], + "label": "uids", + "description": [ + "\nList of user profile identifiers." + ], + "signature": [ + "Set" + ], + "path": "x-pack/plugins/security/public/account_management/user_profile/user_profile_api_client.ts", + "deprecated": false + }, + { + "parentPluginId": "security", + "id": "def-public.UserProfileBulkGetParams.dataPath", + "type": "string", + "tags": [], + "label": "dataPath", + "description": [ + "\nBy default, suggest API returns user information, but does not return any user data. The optional \"dataPath\"\nparameter can be used to return personal data for this user (within `kibana` namespace only)." + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/security/public/account_management/user_profile/user_profile_api_client.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, + { + "parentPluginId": "security", + "id": "def-public.UserProfileGetCurrentParams", + "type": "Interface", + "tags": [], + "label": "UserProfileGetCurrentParams", + "description": [ + "\nParameters for the get user profile for the current user API." + ], + "path": "x-pack/plugins/security/public/account_management/user_profile/user_profile_api_client.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "security", + "id": "def-public.UserProfileGetCurrentParams.dataPath", + "type": "string", + "tags": [], + "label": "dataPath", + "description": [ + "\nBy default, get API returns user information, but does not return any user data. The optional \"dataPath\"\nparameter can be used to return personal data for this user (within `kibana` namespace only)." + ], + "path": "x-pack/plugins/security/public/account_management/user_profile/user_profile_api_client.ts", + "deprecated": false + } + ], + "initialIsOpen": false } ], "enums": [], @@ -852,6 +924,77 @@ "path": "x-pack/plugins/security/public/plugin.tsx", "deprecated": false }, + { + "parentPluginId": "security", + "id": "def-public.SecurityPluginStart.userProfiles", + "type": "Object", + "tags": [], + "label": "userProfiles", + "description": [ + "\nA set of methods to work with Kibana user profiles." + ], + "signature": [ + "{ getCurrent(params?: ", + { + "pluginId": "security", + "scope": "public", + "docId": "kibSecurityPluginApi", + "section": "def-public.UserProfileGetCurrentParams", + "text": "UserProfileGetCurrentParams" + }, + " | undefined): Promise<", + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.UserProfileWithSecurity", + "text": "UserProfileWithSecurity" + }, + " | null>; bulkGet(params: ", + { + "pluginId": "security", + "scope": "public", + "docId": "kibSecurityPluginApi", + "section": "def-public.UserProfileBulkGetParams", + "text": "UserProfileBulkGetParams" + }, + "): Promise<", + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.UserProfile", + "text": "UserProfile" + }, + "[]>; }" + ], + "path": "x-pack/plugins/security/public/plugin.tsx", + "deprecated": false + }, { "parentPluginId": "security", "id": "def-public.SecurityPluginStart.uiApi", @@ -1662,6 +1805,52 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "security", + "id": "def-server.UserProfileGetCurrentParams", + "type": "Interface", + "tags": [], + "label": "UserProfileGetCurrentParams", + "description": [ + "\nParameters for the get user profile for the current user API." + ], + "path": "x-pack/plugins/security/server/user_profile/user_profile_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "security", + "id": "def-server.UserProfileGetCurrentParams.request", + "type": "Object", + "tags": [], + "label": "request", + "description": [ + "\nUser request instance to get user profile for." + ], + "signature": [ + "KibanaRequest", + "" + ], + "path": "x-pack/plugins/security/server/user_profile/user_profile_service.ts", + "deprecated": false + }, + { + "parentPluginId": "security", + "id": "def-server.UserProfileGetCurrentParams.dataPath", + "type": "string", + "tags": [], + "label": "dataPath", + "description": [ + "\nBy default, get API returns user information, but does not return any user data. The optional \"dataPath\"\nparameter can be used to return personal data for this user (within `kibana` namespace only)." + ], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/security/server/user_profile/user_profile_service.ts", + "deprecated": false + } + ], + "initialIsOpen": false + }, { "parentPluginId": "security", "id": "def-server.UserProfileRequiredPrivileges", @@ -1716,6 +1905,78 @@ "path": "x-pack/plugins/security/server/user_profile/user_profile_service.ts", "deprecated": false, "children": [ + { + "parentPluginId": "security", + "id": "def-server.UserProfileServiceStart.getCurrent", + "type": "Function", + "tags": [], + "label": "getCurrent", + "description": [ + "\nRetrieves a user profile for the current user extracted from the specified request. If the profile isn't available,\ne.g. for the anonymous users or users authenticated via authenticating proxies, the `null` value is returned." + ], + "signature": [ + "(params: ", + { + "pluginId": "security", + "scope": "server", + "docId": "kibSecurityPluginApi", + "section": "def-server.UserProfileGetCurrentParams", + "text": "UserProfileGetCurrentParams" + }, + ") => Promise<", + { + "pluginId": "security", + "scope": "common", + "docId": "kibSecurityPluginApi", + "section": "def-common.UserProfileWithSecurity", + "text": "UserProfileWithSecurity" + }, + " | null>" + ], + "path": "x-pack/plugins/security/server/user_profile/user_profile_service.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "security", + "id": "def-server.UserProfileServiceStart.getCurrent.$1", + "type": "Object", + "tags": [], + "label": "params", + "description": [ + "Get current user profile operation parameters." + ], + "signature": [ + { + "pluginId": "security", + "scope": "server", + "docId": "kibSecurityPluginApi", + "section": "def-server.UserProfileGetCurrentParams", + "text": "UserProfileGetCurrentParams" + } + ], + "path": "x-pack/plugins/security/server/user_profile/user_profile_service.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "security", "id": "def-server.UserProfileServiceStart.bulkGet", diff --git a/api_docs/security.mdx b/api_docs/security.mdx index 430c80112dff9..44775dce7018e 100644 --- a/api_docs/security.mdx +++ b/api_docs/security.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/security title: "security" image: https://source.unsplash.com/400x175/?github summary: API docs for the security plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security'] 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 [Platform Security](https://github.com/orgs/elastic/teams/kibana-securit | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 225 | 0 | 90 | 0 | +| 236 | 0 | 90 | 0 | ## Client diff --git a/api_docs/security_solution.devdocs.json b/api_docs/security_solution.devdocs.json index 55f725bd37567..a084c94c8989b 100644 --- a/api_docs/security_solution.devdocs.json +++ b/api_docs/security_solution.devdocs.json @@ -62,7 +62,7 @@ "label": "experimentalFeatures", "description": [], "signature": [ - "{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly kubernetesEnabled: boolean; readonly disableIsolationUIPendingStatuses: boolean; readonly riskyHostsEnabled: boolean; readonly riskyUsersEnabled: boolean; readonly pendingActionResponsesWithAck: boolean; readonly policyListEnabled: boolean; readonly policyResponseInFleetEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly responseActionsConsoleEnabled: boolean; readonly cloudSecurityPostureNavigation: boolean; readonly insightsRelatedAlertsByProcessAncestry: boolean; }" + "{ readonly tGridEnabled: boolean; readonly tGridEventRenderedViewEnabled: boolean; readonly excludePoliciesInFilterEnabled: boolean; readonly kubernetesEnabled: boolean; readonly disableIsolationUIPendingStatuses: boolean; readonly riskyHostsEnabled: boolean; readonly riskyUsersEnabled: boolean; readonly pendingActionResponsesWithAck: boolean; readonly policyListEnabled: boolean; readonly policyResponseInFleetEnabled: boolean; readonly previewTelemetryUrlEnabled: boolean; readonly responseActionsConsoleEnabled: boolean; readonly insightsRelatedAlertsByProcessAncestry: boolean; readonly extendedRuleExecutionLoggingEnabled: boolean; }" ], "path": "x-pack/plugins/security_solution/public/plugin.tsx", "deprecated": false @@ -916,6 +916,47 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "securitySolution", + "id": "def-server.SecuritySolutionApiRequestHandlerContext.getRacClient", + "type": "Function", + "tags": [], + "label": "getRacClient", + "description": [], + "signature": [ + "(req: ", + "KibanaRequest", + ") => Promise<", + { + "pluginId": "ruleRegistry", + "scope": "server", + "docId": "kibRuleRegistryPluginApi", + "section": "def-server.AlertsClient", + "text": "AlertsClient" + }, + ">" + ], + "path": "x-pack/plugins/security_solution/server/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "securitySolution", + "id": "def-server.SecuritySolutionApiRequestHandlerContext.getRacClient.$1", + "type": "Object", + "tags": [], + "label": "req", + "description": [], + "signature": [ + "KibanaRequest", + "" + ], + "path": "x-pack/plugins/security_solution/server/types.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, { "parentPluginId": "securitySolution", "id": "def-server.SecuritySolutionApiRequestHandlerContext.getExceptionListClient", @@ -1003,7 +1044,7 @@ "label": "ConfigType", "description": [], "signature": [ - "Readonly<{} & { signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; alertIgnoreFields: string[]; enableExperimental: string[]; packagerTaskInterval: string; prebuiltRulesFromFileSystem: boolean; prebuiltRulesFromSavedObjects: boolean; }> & { experimentalFeatures: Readonly<{ tGridEnabled: boolean; tGridEventRenderedViewEnabled: boolean; excludePoliciesInFilterEnabled: boolean; kubernetesEnabled: boolean; disableIsolationUIPendingStatuses: boolean; riskyHostsEnabled: boolean; riskyUsersEnabled: boolean; pendingActionResponsesWithAck: boolean; policyListEnabled: boolean; policyResponseInFleetEnabled: boolean; previewTelemetryUrlEnabled: boolean; responseActionsConsoleEnabled: boolean; cloudSecurityPostureNavigation: boolean; insightsRelatedAlertsByProcessAncestry: boolean; }>; }" + "Readonly<{} & { signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; alertMergeStrategy: \"allFields\" | \"missingFields\" | \"noFields\"; alertIgnoreFields: string[]; enableExperimental: string[]; packagerTaskInterval: string; prebuiltRulesFromFileSystem: boolean; prebuiltRulesFromSavedObjects: boolean; }> & { experimentalFeatures: Readonly<{ tGridEnabled: boolean; tGridEventRenderedViewEnabled: boolean; excludePoliciesInFilterEnabled: boolean; kubernetesEnabled: boolean; disableIsolationUIPendingStatuses: boolean; riskyHostsEnabled: boolean; riskyUsersEnabled: boolean; pendingActionResponsesWithAck: boolean; policyListEnabled: boolean; policyResponseInFleetEnabled: boolean; previewTelemetryUrlEnabled: boolean; responseActionsConsoleEnabled: boolean; insightsRelatedAlertsByProcessAncestry: boolean; extendedRuleExecutionLoggingEnabled: boolean; }>; }" ], "path": "x-pack/plugins/security_solution/server/config.ts", "deprecated": false, diff --git a/api_docs/security_solution.mdx b/api_docs/security_solution.mdx index a956b02859281..c34c034bf7d18 100644 --- a/api_docs/security_solution.mdx +++ b/api_docs/security_solution.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/securitySolution title: "securitySolution" image: https://source.unsplash.com/400x175/?github summary: API docs for the securitySolution plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'securitySolution'] 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 [Security solution](https://github.com/orgs/elastic/teams/security-solut | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 52 | 0 | 51 | 22 | +| 54 | 0 | 53 | 22 | ## Client diff --git a/api_docs/session_view.mdx b/api_docs/session_view.mdx index 5a619f77c5a8a..6eb3955617c10 100644 --- a/api_docs/session_view.mdx +++ b/api_docs/session_view.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sessionView title: "sessionView" image: https://source.unsplash.com/400x175/?github summary: API docs for the sessionView plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sessionView'] 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. --- diff --git a/api_docs/share.mdx b/api_docs/share.mdx index f1d46c68e89a3..027105522eac9 100644 --- a/api_docs/share.mdx +++ b/api_docs/share.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/share title: "share" image: https://source.unsplash.com/400x175/?github summary: API docs for the share plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'share'] 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. --- diff --git a/api_docs/shared_u_x.mdx b/api_docs/shared_u_x.mdx index a84bba398d673..2ccda0622384d 100644 --- a/api_docs/shared_u_x.mdx +++ b/api_docs/shared_u_x.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/sharedUX title: "sharedUX" image: https://source.unsplash.com/400x175/?github summary: API docs for the sharedUX plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'sharedUX'] 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. --- diff --git a/api_docs/snapshot_restore.mdx b/api_docs/snapshot_restore.mdx index e9b6897e263ed..a39813de58b34 100644 --- a/api_docs/snapshot_restore.mdx +++ b/api_docs/snapshot_restore.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/snapshotRestore title: "snapshotRestore" image: https://source.unsplash.com/400x175/?github summary: API docs for the snapshotRestore plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'snapshotRestore'] 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. --- diff --git a/api_docs/spaces.devdocs.json b/api_docs/spaces.devdocs.json index e05dbfc9d31de..6aaa933b5af79 100644 --- a/api_docs/spaces.devdocs.json +++ b/api_docs/spaces.devdocs.json @@ -582,13 +582,7 @@ "description": [], "signature": [ "(objects: SavedObjectTarget[]) => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCollectMultiNamespaceReferencesResponse", - "text": "SavedObjectsCollectMultiNamespaceReferencesResponse" - }, + "SavedObjectsCollectMultiNamespaceReferencesResponse", ">" ], "path": "x-pack/plugins/spaces/public/spaces_manager/spaces_manager.ts", @@ -863,13 +857,7 @@ "description": [], "signature": [ "[spaceId: string]: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsImportResponse", - "text": "SavedObjectsImportResponse" - } + "SavedObjectsImportResponse" ], "path": "x-pack/plugins/spaces/public/copy_saved_objects_to_space/types.ts", "deprecated": false @@ -3205,13 +3193,7 @@ ], "signature": [ "(id: string) => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsPointInTimeFinder", - "text": "ISavedObjectsPointInTimeFinder" - }, + "ISavedObjectsPointInTimeFinder", "" ], "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts", @@ -3912,13 +3894,7 @@ "text": "SavedObjectsServiceStart" }, ") => ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.ISavedObjectsRepository", - "text": "ISavedObjectsRepository" - } + "ISavedObjectsRepository" ], "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts", "deprecated": false, diff --git a/api_docs/spaces.mdx b/api_docs/spaces.mdx index b84e5834b6041..fa9330b6206db 100644 --- a/api_docs/spaces.mdx +++ b/api_docs/spaces.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/spaces title: "spaces" image: https://source.unsplash.com/400x175/?github summary: API docs for the spaces plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'spaces'] 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. --- diff --git a/api_docs/stack_alerts.mdx b/api_docs/stack_alerts.mdx index 7a5c7f7e8a390..6b6b1782d3a81 100644 --- a/api_docs/stack_alerts.mdx +++ b/api_docs/stack_alerts.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/stackAlerts title: "stackAlerts" image: https://source.unsplash.com/400x175/?github summary: API docs for the stackAlerts plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'stackAlerts'] 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. --- diff --git a/api_docs/task_manager.mdx b/api_docs/task_manager.mdx index e8486f67da3c5..798b69588cc22 100644 --- a/api_docs/task_manager.mdx +++ b/api_docs/task_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/taskManager title: "taskManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the taskManager plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'taskManager'] 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. --- diff --git a/api_docs/telemetry.mdx b/api_docs/telemetry.mdx index b9f1058ebc65b..3a65896a4b0cf 100644 --- a/api_docs/telemetry.mdx +++ b/api_docs/telemetry.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetry title: "telemetry" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetry plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetry'] 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. --- diff --git a/api_docs/telemetry_collection_manager.devdocs.json b/api_docs/telemetry_collection_manager.devdocs.json index 85ea9702a12ca..d1a6df2c7957b 100644 --- a/api_docs/telemetry_collection_manager.devdocs.json +++ b/api_docs/telemetry_collection_manager.devdocs.json @@ -166,32 +166,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: { (this: That, params: ", "GetRequest", " | ", @@ -244,32 +218,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -340,6 +314,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", " | ", @@ -1273,331 +1273,7 @@ "label": "soClient", "description": [], "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "SavedObjectsClientContract" ], "path": "src/plugins/telemetry_collection_manager/server/types.ts", "deprecated": false diff --git a/api_docs/telemetry_collection_manager.mdx b/api_docs/telemetry_collection_manager.mdx index 3bb0307fde48d..16328aa0da6e2 100644 --- a/api_docs/telemetry_collection_manager.mdx +++ b/api_docs/telemetry_collection_manager.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionManager title: "telemetryCollectionManager" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionManager plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionManager'] 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. --- diff --git a/api_docs/telemetry_collection_xpack.mdx b/api_docs/telemetry_collection_xpack.mdx index 04ba3b4d1e7d8..f698c0eef9c6a 100644 --- a/api_docs/telemetry_collection_xpack.mdx +++ b/api_docs/telemetry_collection_xpack.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryCollectionXpack title: "telemetryCollectionXpack" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryCollectionXpack plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryCollectionXpack'] 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. --- diff --git a/api_docs/telemetry_management_section.mdx b/api_docs/telemetry_management_section.mdx index d9aa42a2f9f9a..d4d3ddaa9452a 100644 --- a/api_docs/telemetry_management_section.mdx +++ b/api_docs/telemetry_management_section.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/telemetryManagementSection title: "telemetryManagementSection" image: https://source.unsplash.com/400x175/?github summary: API docs for the telemetryManagementSection plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'telemetryManagementSection'] 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. --- diff --git a/api_docs/threat_intelligence.devdocs.json b/api_docs/threat_intelligence.devdocs.json new file mode 100644 index 0000000000000..dc72fbcc1107c --- /dev/null +++ b/api_docs/threat_intelligence.devdocs.json @@ -0,0 +1,68 @@ +{ + "id": "threatIntelligence", + "client": { + "classes": [], + "functions": [], + "interfaces": [ + { + "parentPluginId": "threatIntelligence", + "id": "def-public.ThreatIntelligencePluginSetup", + "type": "Interface", + "tags": [], + "label": "ThreatIntelligencePluginSetup", + "description": [], + "path": "x-pack/plugins/threat_intelligence/public/types.ts", + "deprecated": false, + "children": [], + "initialIsOpen": false + }, + { + "parentPluginId": "threatIntelligence", + "id": "def-public.ThreatIntelligencePluginStart", + "type": "Interface", + "tags": [], + "label": "ThreatIntelligencePluginStart", + "description": [], + "path": "x-pack/plugins/threat_intelligence/public/types.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "threatIntelligence", + "id": "def-public.ThreatIntelligencePluginStart.getComponent", + "type": "Function", + "tags": [], + "label": "getComponent", + "description": [], + "signature": [ + "() => React.VFC<{}>" + ], + "path": "x-pack/plugins/threat_intelligence/public/types.ts", + "deprecated": false, + "children": [], + "returnComment": [] + } + ], + "initialIsOpen": false + } + ], + "enums": [], + "misc": [], + "objects": [] + }, + "server": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + }, + "common": { + "classes": [], + "functions": [], + "interfaces": [], + "enums": [], + "misc": [], + "objects": [] + } +} \ No newline at end of file diff --git a/api_docs/threat_intelligence.mdx b/api_docs/threat_intelligence.mdx new file mode 100644 index 0000000000000..2339c488a6cd9 --- /dev/null +++ b/api_docs/threat_intelligence.mdx @@ -0,0 +1,27 @@ +--- +id: kibThreatIntelligencePluginApi +slug: /kibana-dev-docs/api/threatIntelligence +title: "threatIntelligence" +image: https://source.unsplash.com/400x175/?github +summary: API docs for the threatIntelligence plugin +date: 2022-07-28 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'threatIntelligence'] +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. +--- +import threatIntelligenceObj from './threat_intelligence.devdocs.json'; + +Elastic threat intelligence helps you see if you are open to or have been subject to current or historical known threats + +Contact [Protections Experience Team](https://github.com/orgs/elastic/teams/protections-experience) for questions regarding this plugin. + +**Code health stats** + +| Public API count | Any count | Items lacking comments | Missing exports | +|-------------------|-----------|------------------------|-----------------| +| 3 | 0 | 3 | 0 | + +## Client + +### Interfaces + + diff --git a/api_docs/timelines.devdocs.json b/api_docs/timelines.devdocs.json index 70f9ddcd7fb4b..041b50c3f880d 100644 --- a/api_docs/timelines.devdocs.json +++ b/api_docs/timelines.devdocs.json @@ -6958,7 +6958,7 @@ "section": "def-common.ISearchRequestParams", "text": "ISearchRequestParams" }, - " | undefined; defaultIndex: string[]; timerange: ", + " | undefined; timerange: ", { "pluginId": "timelines", "scope": "common", @@ -6966,7 +6966,7 @@ "section": "def-common.TimerangeInput", "text": "TimerangeInput" }, - "; filterQuery: string | ", + "; defaultIndex: string[]; filterQuery: string | ", "ESQuery", " | undefined; factoryQueryType?: ", "TimelineEventsQueries", diff --git a/api_docs/timelines.mdx b/api_docs/timelines.mdx index c1bcea8720eba..4d868c586c46c 100644 --- a/api_docs/timelines.mdx +++ b/api_docs/timelines.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/timelines title: "timelines" image: https://source.unsplash.com/400x175/?github summary: API docs for the timelines plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'timelines'] 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. --- diff --git a/api_docs/transform.mdx b/api_docs/transform.mdx index 9facda1df93e6..cbaf1fb97f47a 100644 --- a/api_docs/transform.mdx +++ b/api_docs/transform.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/transform title: "transform" image: https://source.unsplash.com/400x175/?github summary: API docs for the transform plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'transform'] 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. --- diff --git a/api_docs/triggers_actions_ui.devdocs.json b/api_docs/triggers_actions_ui.devdocs.json index 410f43f674d33..264b29f1817f1 100644 --- a/api_docs/triggers_actions_ui.devdocs.json +++ b/api_docs/triggers_actions_ui.devdocs.json @@ -863,9 +863,9 @@ "label": "loadActionTypes", "description": [], "signature": [ - "({ http }: { http: ", + "({\n http,\n featureId,\n}: { http: ", "HttpSetup", - "; }) => Promise<", + "; featureId?: string | undefined; }) => Promise<", { "pluginId": "actions", "scope": "common", @@ -883,7 +883,7 @@ "id": "def-public.loadActionTypes.$1", "type": "Object", "tags": [], - "label": "{ http }", + "label": "{\n http,\n featureId,\n}", "description": [], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connector_types.ts", "deprecated": false, @@ -900,6 +900,19 @@ ], "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connector_types.ts", "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.loadActionTypes.$1.featureId", + "type": "string", + "tags": [], + "label": "featureId", + "description": [], + "signature": [ + "string | undefined" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connector_types.ts", + "deprecated": false } ] } @@ -1864,6 +1877,19 @@ ], "path": "x-pack/plugins/actions/common/types.ts", "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.ActionType.supportedFeatureIds", + "type": "Array", + "tags": [], + "label": "supportedFeatureIds", + "description": [], + "signature": [ + "string[]" + ], + "path": "x-pack/plugins/actions/common/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -1942,9 +1968,8 @@ "label": "alert", "description": [], "signature": [ - "{ [x: `container.image.tag.${number}`]: string[]; [x: `email.to.${number}`]: string[]; [x: `email.cc.${number}`]: string[]; [x: `email.bcc.${number}`]: string[]; [x: `email.attachments.${number}`]: string[]; [x: `user.roles.${number}`]: string[]; [x: `user.target.roles.${number}`]: string[]; [x: `user.changes.roles.${number}`]: string[]; [x: `user.effective.roles.${number}`]: string[]; [x: `source.user.roles.${number}`]: string[]; [x: `tags.${number}`]: string[]; [x: `client.user.roles.${number}`]: string[]; [x: `file.attributes.${number}`]: string[]; [x: `file.elf.exports.${number}`]: string[]; [x: `file.elf.imports.${number}`]: string[]; [x: `file.elf.sections.${number}`]: string[]; [x: `file.elf.segments.${number}`]: string[]; [x: `file.elf.shared_libraries.${number}`]: string[]; [x: `file.x509.issuer.organization.${number}`]: string[]; [x: `file.x509.issuer.common_name.${number}`]: string[]; [x: `file.x509.issuer.country.${number}`]: string[]; [x: `file.x509.issuer.locality.${number}`]: string[]; [x: `file.x509.issuer.organizational_unit.${number}`]: string[]; [x: `file.x509.issuer.state_or_province.${number}`]: string[]; [x: `file.x509.subject.organization.${number}`]: string[]; [x: `file.x509.subject.common_name.${number}`]: string[]; [x: `file.x509.subject.country.${number}`]: string[]; [x: `file.x509.subject.locality.${number}`]: string[]; [x: `file.x509.subject.organizational_unit.${number}`]: string[]; [x: `file.x509.subject.state_or_province.${number}`]: string[]; [x: `file.x509.alternative_names.${number}`]: string[]; [x: `host.ip.${number}`]: string[]; [x: `host.mac.${number}`]: string[]; [x: `server.user.roles.${number}`]: string[]; [x: `rule.author.${number}`]: string[]; [x: `event.type.${number}`]: string[]; [x: `event.category.${number}`]: string[]; [x: `registry.data.strings.${number}`]: string[]; [x: `destination.user.roles.${number}`]: string[]; [x: `dns.answers.${number}`]: string[]; [x: `dns.header_flags.${number}`]: string[]; [x: `dns.resolved_ip.${number}`]: string[]; [x: `observer.ip.${number}`]: string[]; [x: `observer.mac.${number}`]: string[]; [x: `process.elf.exports.${number}`]: string[]; [x: `process.elf.imports.${number}`]: string[]; [x: `process.elf.sections.${number}`]: string[]; [x: `process.elf.segments.${number}`]: string[]; [x: `process.elf.shared_libraries.${number}`]: string[]; [x: `process.args.${number}`]: string[]; [x: `process.target.args.${number}`]: string[]; [x: `process.parent.args.${number}`]: string[]; [x: `process.target.elf.exports.${number}`]: string[]; [x: `process.target.elf.imports.${number}`]: string[]; [x: `process.target.elf.sections.${number}`]: string[]; [x: `process.target.elf.segments.${number}`]: string[]; [x: `process.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.args.${number}`]: string[]; [x: `process.target.parent.args.${number}`]: string[]; [x: `process.parent.elf.exports.${number}`]: string[]; [x: `process.parent.elf.imports.${number}`]: string[]; [x: `process.parent.elf.sections.${number}`]: string[]; [x: `process.parent.elf.segments.${number}`]: string[]; [x: `process.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.args.${number}`]: string[]; [x: `process.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.target.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.target.parent.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.target.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.target.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.target.parent.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.target.parent.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.target.parent.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.target.parent.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.elf.exports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.elf.imports.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.elf.sections.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.elf.segments.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.elf.shared_libraries.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.target.args.${number}`]: string[]; [x: `process.parent.parent.parent.parent.parent.parent.parent.parent.args.${number}`]: string[]; [x: `related.ip.${number}`]: string[]; [x: `related.user.${number}`]: string[]; [x: `related.hash.${number}`]: string[]; [x: `related.hosts.${number}`]: string[]; [x: `threat.group.alias.${number}`]: string[]; [x: `threat.indicator.x509.issuer.organization.${number}`]: string[]; [x: `threat.indicator.x509.issuer.common_name.${number}`]: string[]; [x: `threat.indicator.x509.issuer.country.${number}`]: string[]; [x: `threat.indicator.x509.issuer.locality.${number}`]: string[]; [x: `threat.indicator.x509.issuer.organizational_unit.${number}`]: string[]; [x: `threat.indicator.x509.issuer.state_or_province.${number}`]: string[]; [x: `threat.indicator.x509.subject.organization.${number}`]: string[]; [x: `threat.indicator.x509.subject.common_name.${number}`]: string[]; [x: `threat.indicator.x509.subject.country.${number}`]: string[]; [x: `threat.indicator.x509.subject.locality.${number}`]: string[]; [x: `threat.indicator.x509.subject.organizational_unit.${number}`]: string[]; [x: `threat.indicator.x509.subject.state_or_province.${number}`]: string[]; [x: `threat.indicator.x509.alternative_names.${number}`]: string[]; [x: `threat.indicator.file.attributes.${number}`]: string[]; [x: `threat.indicator.file.elf.exports.${number}`]: string[]; [x: `threat.indicator.file.elf.imports.${number}`]: string[]; [x: `threat.indicator.file.elf.sections.${number}`]: string[]; [x: `threat.indicator.file.elf.segments.${number}`]: string[]; [x: `threat.indicator.file.elf.shared_libraries.${number}`]: string[]; [x: `threat.indicator.file.x509.issuer.organization.${number}`]: string[]; [x: `threat.indicator.file.x509.issuer.common_name.${number}`]: string[]; [x: `threat.indicator.file.x509.issuer.country.${number}`]: string[]; [x: `threat.indicator.file.x509.issuer.locality.${number}`]: string[]; [x: `threat.indicator.file.x509.issuer.organizational_unit.${number}`]: string[]; [x: `threat.indicator.file.x509.issuer.state_or_province.${number}`]: string[]; [x: `threat.indicator.file.x509.subject.organization.${number}`]: string[]; [x: `threat.indicator.file.x509.subject.common_name.${number}`]: string[]; [x: `threat.indicator.file.x509.subject.country.${number}`]: string[]; [x: `threat.indicator.file.x509.subject.locality.${number}`]: string[]; [x: `threat.indicator.file.x509.subject.organizational_unit.${number}`]: string[]; [x: `threat.indicator.file.x509.subject.state_or_province.${number}`]: string[]; [x: `threat.indicator.file.x509.alternative_names.${number}`]: string[]; [x: `threat.indicator.registry.data.strings.${number}`]: string[]; [x: `threat.enrichments.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.issuer.organization.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.issuer.common_name.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.issuer.country.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.issuer.locality.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.issuer.organizational_unit.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.issuer.state_or_province.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.subject.organization.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.subject.common_name.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.subject.country.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.subject.locality.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.subject.organizational_unit.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.subject.state_or_province.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.x509.alternative_names.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.attributes.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.elf.exports.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.elf.imports.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.elf.sections.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.elf.segments.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.elf.shared_libraries.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.issuer.organization.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.issuer.common_name.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.issuer.country.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.issuer.locality.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.issuer.organizational_unit.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.issuer.state_or_province.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.subject.organization.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.subject.common_name.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.subject.country.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.subject.locality.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.subject.organizational_unit.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.subject.state_or_province.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.file.x509.alternative_names.${number}`]: string[]; [x: `threat.enrichments.${number}.indicator.registry.data.strings.${number}`]: string[]; [x: `threat.software.platforms.${number}`]: string[]; [x: `threat.tactic.id.${number}`]: string[]; [x: `threat.tactic.name.${number}`]: string[]; [x: `threat.tactic.reference.${number}`]: string[]; [x: `threat.technique.id.${number}`]: string[]; [x: `threat.technique.name.${number}`]: string[]; [x: `threat.technique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.reference.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.id.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.name.${number}`]: string[]; [x: `threat.technique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.subtechnique.reference.${number}`]: string[]; [x: `tls.client.x509.issuer.organization.${number}`]: string[]; [x: `tls.client.x509.issuer.common_name.${number}`]: string[]; [x: `tls.client.x509.issuer.country.${number}`]: string[]; [x: `tls.client.x509.issuer.locality.${number}`]: string[]; [x: `tls.client.x509.issuer.organizational_unit.${number}`]: string[]; [x: `tls.client.x509.issuer.state_or_province.${number}`]: string[]; [x: `tls.client.x509.subject.organization.${number}`]: string[]; [x: `tls.client.x509.subject.common_name.${number}`]: string[]; [x: `tls.client.x509.subject.country.${number}`]: string[]; [x: `tls.client.x509.subject.locality.${number}`]: string[]; [x: `tls.client.x509.subject.organizational_unit.${number}`]: string[]; [x: `tls.client.x509.subject.state_or_province.${number}`]: string[]; [x: `tls.client.x509.alternative_names.${number}`]: string[]; [x: `tls.client.certificate_chain.${number}`]: string[]; [x: `tls.client.supported_ciphers.${number}`]: string[]; [x: `tls.server.x509.issuer.organization.${number}`]: string[]; [x: `tls.server.x509.issuer.common_name.${number}`]: string[]; [x: `tls.server.x509.issuer.country.${number}`]: string[]; [x: `tls.server.x509.issuer.locality.${number}`]: string[]; [x: `tls.server.x509.issuer.organizational_unit.${number}`]: string[]; [x: `tls.server.x509.issuer.state_or_province.${number}`]: string[]; [x: `tls.server.x509.subject.organization.${number}`]: string[]; [x: `tls.server.x509.subject.common_name.${number}`]: string[]; [x: `tls.server.x509.subject.country.${number}`]: string[]; [x: `tls.server.x509.subject.locality.${number}`]: string[]; [x: `tls.server.x509.subject.organizational_unit.${number}`]: string[]; [x: `tls.server.x509.subject.state_or_province.${number}`]: string[]; [x: `tls.server.x509.alternative_names.${number}`]: string[]; [x: `tls.server.certificate_chain.${number}`]: string[]; [x: `vulnerability.category.${number}`]: string[]; } & ", "BasicFields", - " & { tags?: string[] | undefined; kibana?: string[] | undefined; \"@timestamp\"?: string[] | undefined; \"event.action\"?: string[] | undefined; \"kibana.alert.rule.parameters\"?: string[] | undefined; \"kibana.alert.rule.rule_type_id\"?: string[] | undefined; \"kibana.alert.rule.consumer\"?: string[] | undefined; \"kibana.alert.rule.producer\"?: string[] | undefined; \"kibana.space_ids\"?: string[] | undefined; \"kibana.alert.uuid\"?: string[] | undefined; \"kibana.alert.instance.id\"?: string[] | undefined; \"kibana.alert.start\"?: string[] | undefined; \"kibana.alert.end\"?: string[] | undefined; \"kibana.alert.duration.us\"?: string[] | undefined; \"kibana.alert.severity\"?: string[] | undefined; \"kibana.alert.status\"?: string[] | undefined; \"kibana.version\"?: string[] | undefined; \"ecs.version\"?: string[] | undefined; \"kibana.alert.risk_score\"?: string[] | undefined; \"kibana.alert.workflow_status\"?: string[] | undefined; \"kibana.alert.workflow_user\"?: string[] | undefined; \"kibana.alert.workflow_reason\"?: string[] | undefined; \"kibana.alert.system_status\"?: string[] | undefined; \"kibana.alert.action_group\"?: string[] | undefined; \"kibana.alert.reason\"?: string[] | undefined; \"kibana.alert.rule.author\"?: string[] | undefined; \"kibana.alert.rule.category\"?: string[] | undefined; \"kibana.alert.rule.uuid\"?: string[] | undefined; \"kibana.alert.rule.created_at\"?: string[] | undefined; \"kibana.alert.rule.created_by\"?: string[] | undefined; \"kibana.alert.rule.description\"?: string[] | undefined; \"kibana.alert.rule.enabled\"?: string[] | undefined; \"kibana.alert.rule.execution.uuid\"?: string[] | undefined; \"kibana.alert.rule.from\"?: string[] | undefined; \"kibana.alert.rule.interval\"?: string[] | undefined; \"kibana.alert.rule.license\"?: string[] | undefined; \"kibana.alert.rule.name\"?: string[] | undefined; \"kibana.alert.rule.note\"?: string[] | undefined; \"kibana.alert.rule.references\"?: string[] | undefined; \"kibana.alert.rule.rule_id\"?: string[] | undefined; \"kibana.alert.rule.rule_name_override\"?: string[] | undefined; \"kibana.alert.rule.tags\"?: string[] | undefined; \"kibana.alert.rule.to\"?: string[] | undefined; \"kibana.alert.rule.type\"?: string[] | undefined; \"kibana.alert.rule.updated_at\"?: string[] | undefined; \"kibana.alert.rule.updated_by\"?: string[] | undefined; \"kibana.alert.rule.version\"?: string[] | undefined; \"event.kind\"?: string[] | undefined; \"event.module\"?: string[] | undefined; \"kibana.alert.evaluation.threshold\"?: string[] | undefined; \"kibana.alert.evaluation.value\"?: string[] | undefined; \"kibana.alert.building_block_type\"?: string[] | undefined; \"kibana.alert.rule.exceptions_list\"?: string[] | undefined; \"kibana.alert.rule.namespace\"?: string[] | undefined; \"kibana.alert\"?: string[] | undefined; \"kibana.alert.rule\"?: string[] | undefined; }" + " & { tags?: string[] | undefined; kibana?: string[] | undefined; \"@timestamp\"?: string[] | undefined; \"event.action\"?: string[] | undefined; \"kibana.alert.rule.parameters\"?: string[] | undefined; \"kibana.alert.rule.rule_type_id\"?: string[] | undefined; \"kibana.alert.rule.consumer\"?: string[] | undefined; \"kibana.alert.rule.producer\"?: string[] | undefined; \"kibana.space_ids\"?: string[] | undefined; \"kibana.alert.uuid\"?: string[] | undefined; \"kibana.alert.instance.id\"?: string[] | undefined; \"kibana.alert.start\"?: string[] | undefined; \"kibana.alert.end\"?: string[] | undefined; \"kibana.alert.duration.us\"?: string[] | undefined; \"kibana.alert.severity\"?: string[] | undefined; \"kibana.alert.status\"?: string[] | undefined; \"kibana.version\"?: string[] | undefined; \"ecs.version\"?: string[] | undefined; \"kibana.alert.risk_score\"?: string[] | undefined; \"kibana.alert.workflow_status\"?: string[] | undefined; \"kibana.alert.workflow_user\"?: string[] | undefined; \"kibana.alert.workflow_reason\"?: string[] | undefined; \"kibana.alert.system_status\"?: string[] | undefined; \"kibana.alert.action_group\"?: string[] | undefined; \"kibana.alert.reason\"?: string[] | undefined; \"kibana.alert.rule.author\"?: string[] | undefined; \"kibana.alert.rule.category\"?: string[] | undefined; \"kibana.alert.rule.uuid\"?: string[] | undefined; \"kibana.alert.rule.created_at\"?: string[] | undefined; \"kibana.alert.rule.created_by\"?: string[] | undefined; \"kibana.alert.rule.description\"?: string[] | undefined; \"kibana.alert.rule.enabled\"?: string[] | undefined; \"kibana.alert.rule.execution.uuid\"?: string[] | undefined; \"kibana.alert.rule.from\"?: string[] | undefined; \"kibana.alert.rule.interval\"?: string[] | undefined; \"kibana.alert.rule.license\"?: string[] | undefined; \"kibana.alert.rule.name\"?: string[] | undefined; \"kibana.alert.rule.note\"?: string[] | undefined; \"kibana.alert.rule.references\"?: string[] | undefined; \"kibana.alert.rule.rule_id\"?: string[] | undefined; \"kibana.alert.rule.rule_name_override\"?: string[] | undefined; \"kibana.alert.rule.tags\"?: string[] | undefined; \"kibana.alert.rule.to\"?: string[] | undefined; \"kibana.alert.rule.type\"?: string[] | undefined; \"kibana.alert.rule.updated_at\"?: string[] | undefined; \"kibana.alert.rule.updated_by\"?: string[] | undefined; \"kibana.alert.rule.version\"?: string[] | undefined; \"event.kind\"?: string[] | undefined; \"event.module\"?: string[] | undefined; \"kibana.alert.evaluation.threshold\"?: string[] | undefined; \"kibana.alert.evaluation.value\"?: string[] | undefined; \"kibana.alert.building_block_type\"?: string[] | undefined; \"kibana.alert.rule.exceptions_list\"?: string[] | undefined; \"kibana.alert.rule.namespace\"?: string[] | undefined; \"kibana.alert\"?: string[] | undefined; \"kibana.alert.rule\"?: string[] | undefined; } & { [x: string]: unknown[]; }" ], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false @@ -2137,6 +2162,16 @@ "description": [], "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "deprecated": false + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.AlertsTableProps.updatedAt", + "type": "number", + "tags": [], + "label": "updatedAt", + "description": [], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false } ], "initialIsOpen": false @@ -2867,6 +2902,19 @@ "children": [], "returnComment": [] }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.RuleDefinitionProps.hideEditButton", + "type": "CompoundType", + "tags": [], + "label": "hideEditButton", + "description": [], + "signature": [ + "boolean | undefined" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/types.ts", + "deprecated": false + }, { "parentPluginId": "triggersActionsUi", "id": "def-public.RuleDefinitionProps.filteredRuleTypes", @@ -4379,35 +4427,13 @@ "label": "RuleEventLogListProps", "description": [], "signature": [ - "{ rule: ", - { - "pluginId": "triggersActionsUi", - "scope": "public", - "docId": "kibTriggersActionsUiPluginApi", - "section": "def-public.Rule", - "text": "Rule" - }, - "<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.RuleTypeParams", - "text": "RuleTypeParams" - }, - ">; localStorageKey?: string | undefined; refreshToken?: number | undefined; requestRefresh?: (() => Promise) | undefined; customLoadExecutionLogAggregations?: ((props: ", - "LoadExecutionLogAggregationsProps", - ") => Promise<", - { - "pluginId": "alerting", - "scope": "common", - "docId": "kibAlertingPluginApi", - "section": "def-common.IExecutionLogResult", - "text": "IExecutionLogResult" - }, - ">) | undefined; } & Pick<", - "ComponentOpts", - ", \"loadExecutionLogAggregations\">" + "T extends \"default\" ? ", + "RuleEventLogListCommonProps", + " : T extends \"stackManagement\" ? ", + "RuleEventLogListStackManagementProps", + " & ", + "RuleEventLogListCommonProps", + " : never" ], "path": "x-pack/plugins/triggers_actions_ui/public/application/sections/rule_details/components/rule_event_log_list.tsx", "deprecated": false, @@ -5883,7 +5909,9 @@ "label": "getRuleEventLogList", "description": [], "signature": [ - "(props: ", + "(props: ", { "pluginId": "triggersActionsUi", "scope": "public", @@ -5891,7 +5919,7 @@ "section": "def-public.RuleEventLogListProps", "text": "RuleEventLogListProps" }, - ") => React.ReactElement<", + ") => React.ReactElement<", { "pluginId": "triggersActionsUi", "scope": "public", @@ -5899,7 +5927,7 @@ "section": "def-public.RuleEventLogListProps", "text": "RuleEventLogListProps" }, - ", string | React.JSXElementConstructor>" + ", string | React.JSXElementConstructor>" ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false, @@ -5907,7 +5935,7 @@ { "parentPluginId": "triggersActionsUi", "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleEventLogList.$1", - "type": "CompoundType", + "type": "Uncategorized", "tags": [], "label": "props", "description": [], @@ -5918,7 +5946,8 @@ "docId": "kibTriggersActionsUiPluginApi", "section": "def-public.RuleEventLogListProps", "text": "RuleEventLogListProps" - } + }, + "" ], "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "deprecated": false, @@ -6078,6 +6107,40 @@ } ], "returnComment": [] + }, + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleAlertsSummary", + "type": "Function", + "tags": [], + "label": "getRuleAlertsSummary", + "description": [], + "signature": [ + "(props: ", + "RuleAlertsSummaryProps", + ") => React.ReactElement<", + "RuleAlertsSummaryProps", + ", string | React.JSXElementConstructor>" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "children": [ + { + "parentPluginId": "triggersActionsUi", + "id": "def-public.TriggersAndActionsUIPublicPluginStart.getRuleAlertsSummary.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "RuleAlertsSummaryProps" + ], + "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] } ], "lifecycle": "start", diff --git a/api_docs/triggers_actions_ui.mdx b/api_docs/triggers_actions_ui.mdx index ab9062aef1710..cd02d095d95df 100644 --- a/api_docs/triggers_actions_ui.mdx +++ b/api_docs/triggers_actions_ui.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/triggersActionsUi title: "triggersActionsUi" image: https://source.unsplash.com/400x175/?github summary: API docs for the triggersActionsUi plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'triggersActionsUi'] 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 | |-------------------|-----------|------------------------|-----------------| -| 420 | 0 | 399 | 42 | +| 426 | 0 | 405 | 46 | ## Client diff --git a/api_docs/ui_actions.mdx b/api_docs/ui_actions.mdx index 31775949773ac..7adc1bf264c67 100644 --- a/api_docs/ui_actions.mdx +++ b/api_docs/ui_actions.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActions title: "uiActions" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActions plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActions'] 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. --- diff --git a/api_docs/ui_actions_enhanced.mdx b/api_docs/ui_actions_enhanced.mdx index 32387f565d3b4..bfa02bc7440b7 100644 --- a/api_docs/ui_actions_enhanced.mdx +++ b/api_docs/ui_actions_enhanced.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/uiActionsEnhanced title: "uiActionsEnhanced" image: https://source.unsplash.com/400x175/?github summary: API docs for the uiActionsEnhanced plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'uiActionsEnhanced'] 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. --- diff --git a/api_docs/unified_search.devdocs.json b/api_docs/unified_search.devdocs.json index ad5676176be04..35dbc669b349e 100644 --- a/api_docs/unified_search.devdocs.json +++ b/api_docs/unified_search.devdocs.json @@ -11,8 +11,8 @@ "label": "DataViewPicker", "description": [], "signature": [ - "({ isMissingCurrent, currentDataViewId, onChangeDataView, onAddField, onDataViewCreated, trigger, selectableProps, showNewMenuTour, }: ", - "DataViewPickerProps", + "({ isMissingCurrent, currentDataViewId, onChangeDataView, onAddField, onDataViewCreated, trigger, selectableProps, showNewMenuTour, textBasedLanguages, onSaveTextLanguageQuery, onTextLangQuerySubmit, textBasedLanguage, }: ", + "DataViewPickerPropsExtended", ") => JSX.Element" ], "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", @@ -23,10 +23,10 @@ "id": "def-public.DataViewPicker.$1", "type": "Object", "tags": [], - "label": "{\n isMissingCurrent,\n currentDataViewId,\n onChangeDataView,\n onAddField,\n onDataViewCreated,\n trigger,\n selectableProps,\n showNewMenuTour,\n}", + "label": "{\n isMissingCurrent,\n currentDataViewId,\n onChangeDataView,\n onAddField,\n onDataViewCreated,\n trigger,\n selectableProps,\n showNewMenuTour,\n textBasedLanguages,\n onSaveTextLanguageQuery,\n onTextLangQuerySubmit,\n textBasedLanguage,\n}", "description": [], "signature": [ - "DataViewPickerProps" + "DataViewPickerPropsExtended" ], "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", "deprecated": false, @@ -44,7 +44,7 @@ "label": "DataViewsList", "description": [], "signature": [ - "({\n dataViewsList,\n onChangeDataView,\n currentDataViewId,\n selectableProps,\n searchListInputId,\n}: ", + "({\n dataViewsList,\n onChangeDataView,\n isTextBasedLangSelected,\n currentDataViewId,\n selectableProps,\n searchListInputId,\n}: ", "DataViewsListProps", ") => JSX.Element" ], @@ -56,7 +56,7 @@ "id": "def-public.DataViewsList.$1", "type": "Object", "tags": [], - "label": "{\n dataViewsList,\n onChangeDataView,\n currentDataViewId,\n selectableProps,\n searchListInputId,\n}", + "label": "{\n dataViewsList,\n onChangeDataView,\n isTextBasedLangSelected,\n currentDataViewId,\n selectableProps,\n searchListInputId,\n}", "description": [], "signature": [ "DataViewsListProps" @@ -179,6 +179,122 @@ ], "returnComment": [], "initialIsOpen": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.SearchBar", + "type": "Function", + "tags": [], + "label": "SearchBar", + "description": [], + "signature": [ + "(props: Omit<", + { + "pluginId": "unifiedSearch", + "scope": "public", + "docId": "kibUnifiedSearchPluginApi", + "section": "def-public.SearchBarProps", + "text": "SearchBarProps" + }, + ", \"kibana\" | \"intl\">) => JSX.Element" + ], + "path": "src/plugins/unified_search/public/search_bar/index.tsx", + "deprecated": false, + "returnComment": [], + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.SearchBar.$1", + "type": "Object", + "tags": [], + "label": "props", + "description": [], + "signature": [ + "{ dataTestSubj?: string | undefined; query?: ", + "Query", + " | QT | undefined; filters?: ", + "Filter", + "[] | undefined; savedQuery?: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQuery", + "text": "SavedQuery" + }, + " | undefined; refreshInterval?: number | undefined; placeholder?: string | undefined; iconType?: ", + "IconType", + " | undefined; indexPatterns?: ", + { + "pluginId": "dataViews", + "scope": "common", + "docId": "kibDataViewsPluginApi", + "section": "def-common.DataView", + "text": "DataView" + }, + "[] | undefined; isLoading?: boolean | undefined; timeHistory?: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.TimeHistoryContract", + "text": "TimeHistoryContract" + }, + " | undefined; customSubmitButton?: React.ReactNode; screenTitle?: string | undefined; showQueryBar?: boolean | undefined; showQueryInput?: boolean | undefined; showFilterBar?: boolean | undefined; showDatePicker?: boolean | undefined; showAutoRefreshOnly?: boolean | undefined; hiddenFilterPanelOptions?: ", + "FilterPanelOption", + "[] | undefined; isRefreshPaused?: boolean | undefined; dateRangeFrom?: string | undefined; dateRangeTo?: string | undefined; showSaveQuery?: boolean | undefined; onQueryChange?: ((payload: { dateRange: ", + "TimeRange", + "; query?: ", + "Query", + " | QT | undefined; }) => void) | undefined; onQuerySubmit?: ((payload: { dateRange: ", + "TimeRange", + "; query?: ", + "Query", + " | QT | undefined; }, isUpdate?: boolean | undefined) => void) | undefined; onSaved?: ((savedQuery: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQuery", + "text": "SavedQuery" + }, + ") => void) | undefined; onSavedQueryUpdated?: ((savedQuery: ", + { + "pluginId": "data", + "scope": "public", + "docId": "kibDataQueryPluginApi", + "section": "def-public.SavedQuery", + "text": "SavedQuery" + }, + ") => void) | undefined; onClearSavedQuery?: (() => void) | undefined; onRefresh?: ((payload: { dateRange: ", + "TimeRange", + "; }) => void) | undefined; indicateNoData?: boolean | undefined; isClearable?: boolean | undefined; nonKqlMode?: \"text\" | \"lucene\" | undefined; displayStyle?: \"inPage\" | \"detached\" | undefined; fillSubmitButton?: boolean | undefined; dataViewPickerComponentProps?: ", + { + "pluginId": "unifiedSearch", + "scope": "public", + "docId": "kibUnifiedSearchPluginApi", + "section": "def-public.DataViewPickerProps", + "text": "DataViewPickerProps" + }, + " | undefined; textBasedLanguageModeErrors?: Error[] | undefined; onTextBasedSavedAndExit?: (({ onSave }: ", + "OnSaveTextLanguageQueryProps", + ") => void) | undefined; showSubmitButton?: boolean | undefined; suggestionsSize?: ", + "SuggestionsListSize", + " | undefined; isScreenshotMode?: boolean | undefined; onFiltersUpdated?: ((filters: ", + "Filter", + "[]) => void) | undefined; onRefreshChange?: ((options: { isPaused: boolean; refreshInterval: number; }) => void) | undefined; }" + ], + "path": "src/plugins/unified_search/public/search_bar/index.tsx", + "deprecated": false + } + ], + "initialIsOpen": false } ], "interfaces": [ @@ -248,6 +364,212 @@ ], "initialIsOpen": false }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPickerProps", + "type": "Interface", + "tags": [], + "label": "DataViewPickerProps", + "description": [], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPickerProps.trigger", + "type": "CompoundType", + "tags": [], + "label": "trigger", + "description": [ + "\nThe properties of the button that triggers the dataview picker." + ], + "signature": [ + "EuiButtonProps", + " & { label: string; title?: string | undefined; }" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPickerProps.isMissingCurrent", + "type": "CompoundType", + "tags": [], + "label": "isMissingCurrent", + "description": [ + "\nFlag that should be enabled when the current dataview is missing." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPickerProps.onChangeDataView", + "type": "Function", + "tags": [], + "label": "onChangeDataView", + "description": [ + "\nCallback that is called when the user changes the currently selected dataview." + ], + "signature": [ + "(newId: string) => void" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPickerProps.onChangeDataView.$1", + "type": "string", + "tags": [], + "label": "newId", + "description": [], + "signature": [ + "string" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPickerProps.currentDataViewId", + "type": "string", + "tags": [], + "label": "currentDataViewId", + "description": [ + "\nThe id of the selected dataview." + ], + "signature": [ + "string | undefined" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPickerProps.selectableProps", + "type": "CompoundType", + "tags": [], + "label": "selectableProps", + "description": [ + "\nEuiSelectable properties." + ], + "signature": [ + "EuiSelectableProps", + "<{}> | undefined" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPickerProps.onAddField", + "type": "Function", + "tags": [], + "label": "onAddField", + "description": [ + "\nCallback that is called when the user clicks the add runtime field option.\nAlso works as a flag to show the add runtime field button." + ], + "signature": [ + "(() => void) | undefined" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPickerProps.onDataViewCreated", + "type": "Function", + "tags": [], + "label": "onDataViewCreated", + "description": [ + "\nCallback that is called when the user clicks the create dataview option.\nAlso works as a flag to show the create dataview button." + ], + "signature": [ + "(() => void) | undefined" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false, + "children": [], + "returnComment": [] + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPickerProps.showNewMenuTour", + "type": "CompoundType", + "tags": [], + "label": "showNewMenuTour", + "description": [ + "\nFlag to show the tour component for the first time." + ], + "signature": [ + "boolean | undefined" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPickerProps.textBasedLanguages", + "type": "Array", + "tags": [], + "label": "textBasedLanguages", + "description": [ + "\nList of the supported text based languages (SQL, ESQL) etc.\nDefined per application, if not provided, no text based languages\nwill be available." + ], + "signature": [ + "TextBasedLanguages", + "[] | undefined" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false + }, + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPickerProps.onSaveTextLanguageQuery", + "type": "Function", + "tags": [], + "label": "onSaveTextLanguageQuery", + "description": [ + "\nCallback that is called when the user clicks the Save and switch transition modal button" + ], + "signature": [ + "(({ onSave, onCancel }: ", + "OnSaveTextLanguageQueryProps", + ") => void) | undefined" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false, + "children": [ + { + "parentPluginId": "unifiedSearch", + "id": "def-public.DataViewPickerProps.onSaveTextLanguageQuery.$1", + "type": "Object", + "tags": [], + "label": "{ onSave, onCancel }", + "description": [], + "signature": [ + "OnSaveTextLanguageQueryProps" + ], + "path": "src/plugins/unified_search/public/dataview_picker/index.tsx", + "deprecated": false, + "isRequired": true + } + ], + "returnComment": [] + } + ], + "initialIsOpen": false + }, { "parentPluginId": "unifiedSearch", "id": "def-public.QueryStringInputProps", @@ -698,30 +1020,6 @@ "deprecated": false, "initialIsOpen": false }, - { - "parentPluginId": "unifiedSearch", - "id": "def-public.SearchBar", - "type": "CompoundType", - "tags": [], - "label": "SearchBar", - "description": [], - "signature": [ - "React.ComponentClass, \"timeHistory\" | keyof ", - "SearchBarOwnProps", - " | \"onFiltersUpdated\" | \"onRefreshChange\">, any> & { WrappedComponent: React.ComponentType & ReactIntl.InjectedIntlProps>; }" - ], - "path": "src/plugins/unified_search/public/search_bar/index.tsx", - "deprecated": false, - "initialIsOpen": false - }, { "parentPluginId": "unifiedSearch", "id": "def-public.SearchBarProps", @@ -731,7 +1029,7 @@ "description": [], "signature": [ "SearchBarOwnProps", - " & ", + " & ", "SearchBarInjectedDeps" ], "path": "src/plugins/unified_search/public/search_bar/search_bar.tsx", @@ -747,7 +1045,7 @@ "description": [], "signature": [ "SearchBarOwnProps", - " & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; }" + " & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; }" ], "path": "src/plugins/unified_search/public/search_bar/create_search_bar.tsx", "deprecated": false, diff --git a/api_docs/unified_search.mdx b/api_docs/unified_search.mdx index 9a63519fa57cb..221b0bb447217 100644 --- a/api_docs/unified_search.mdx +++ b/api_docs/unified_search.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch title: "unifiedSearch" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch'] 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 [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-servic | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 84 | 2 | 80 | 13 | +| 98 | 2 | 84 | 16 | ## Client diff --git a/api_docs/unified_search_autocomplete.mdx b/api_docs/unified_search_autocomplete.mdx index 5070d9de44d78..4625c35bbc581 100644 --- a/api_docs/unified_search_autocomplete.mdx +++ b/api_docs/unified_search_autocomplete.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/unifiedSearch-autocomplete title: "unifiedSearch.autocomplete" image: https://source.unsplash.com/400x175/?github summary: API docs for the unifiedSearch.autocomplete plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'unifiedSearch.autocomplete'] 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 [Unified Search](https://github.com/orgs/elastic/teams/kibana-app-servic | Public API count | Any count | Items lacking comments | Missing exports | |-------------------|-----------|------------------------|-----------------| -| 84 | 2 | 80 | 13 | +| 98 | 2 | 84 | 16 | ## Client diff --git a/api_docs/url_forwarding.mdx b/api_docs/url_forwarding.mdx index e81d0d6ff12f6..a486575a76e97 100644 --- a/api_docs/url_forwarding.mdx +++ b/api_docs/url_forwarding.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/urlForwarding title: "urlForwarding" image: https://source.unsplash.com/400x175/?github summary: API docs for the urlForwarding plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'urlForwarding'] 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. --- diff --git a/api_docs/usage_collection.devdocs.json b/api_docs/usage_collection.devdocs.json index f0311a525f3f4..af132ce09f96c 100644 --- a/api_docs/usage_collection.devdocs.json +++ b/api_docs/usage_collection.devdocs.json @@ -420,32 +420,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: { (this: That, params: ", "GetRequest", " | ", @@ -498,32 +472,32 @@ "TransportRequestOptions", " | undefined): Promise<", "UpdateResponse", - ">; }; closePointInTime: { (this: That, params: ", - "ClosePointInTimeRequest", + ">; }; 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: ", @@ -594,6 +568,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", " | ", @@ -1529,331 +1529,7 @@ "\nRequest-scoped Saved Objects client" ], "signature": [ - "{ create: (type: string, attributes: T, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsCreateOptions", - "text": "SavedObjectsCreateOptions" - }, - " | undefined) => Promise<", - "SavedObject", - ">; bulkCreate: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkCreateObject", - "text": "SavedObjectsBulkCreateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - ">; bulkGet: (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" - }, - ">; bulkResolve: (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" - }, - ">; get: (type: string, id: string, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBaseOptions", - "text": "SavedObjectsBaseOptions" - }, - ") => Promise<", - "SavedObject", - ">; resolve: (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" - }, - ">; update: (type: string, id: string, attributes: Partial, options?: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateOptions", - "text": "SavedObjectsUpdateOptions" - }, - ") => Promise<", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsUpdateResponse", - "text": "SavedObjectsUpdateResponse" - }, - ">; 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: (objects: ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsBulkUpdateObject", - "text": "SavedObjectsBulkUpdateObject" - }, - "[], 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" - }, - ">; 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: (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" - }, - "; errors: typeof ", - { - "pluginId": "core", - "scope": "server", - "docId": "kibCoreSavedObjectsPluginApi", - "section": "def-server.SavedObjectsErrorHelpers", - "text": "SavedObjectsErrorHelpers" - }, - "; }" + "SavedObjectsClientContract" ], "path": "src/plugins/usage_collection/server/collector/types.ts", "deprecated": false diff --git a/api_docs/usage_collection.mdx b/api_docs/usage_collection.mdx index e2b8b431277b2..4e3472e52488b 100644 --- a/api_docs/usage_collection.mdx +++ b/api_docs/usage_collection.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/usageCollection title: "usageCollection" image: https://source.unsplash.com/400x175/?github summary: API docs for the usageCollection plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'usageCollection'] 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. --- diff --git a/api_docs/ux.mdx b/api_docs/ux.mdx index 41f8f07ec0bb0..b5002b7439b0b 100644 --- a/api_docs/ux.mdx +++ b/api_docs/ux.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/ux title: "ux" image: https://source.unsplash.com/400x175/?github summary: API docs for the ux plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ux'] 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. --- diff --git a/api_docs/vis_default_editor.mdx b/api_docs/vis_default_editor.mdx index f32881a729064..af06e0906d435 100644 --- a/api_docs/vis_default_editor.mdx +++ b/api_docs/vis_default_editor.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visDefaultEditor title: "visDefaultEditor" image: https://source.unsplash.com/400x175/?github summary: API docs for the visDefaultEditor plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visDefaultEditor'] 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. --- diff --git a/api_docs/vis_type_gauge.mdx b/api_docs/vis_type_gauge.mdx index f4138181c2392..e9586552219fe 100644 --- a/api_docs/vis_type_gauge.mdx +++ b/api_docs/vis_type_gauge.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeGauge title: "visTypeGauge" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeGauge plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeGauge'] 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. --- diff --git a/api_docs/vis_type_heatmap.mdx b/api_docs/vis_type_heatmap.mdx index 58b9056b20e22..c890183df0389 100644 --- a/api_docs/vis_type_heatmap.mdx +++ b/api_docs/vis_type_heatmap.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeHeatmap title: "visTypeHeatmap" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeHeatmap plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeHeatmap'] 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. --- diff --git a/api_docs/vis_type_pie.mdx b/api_docs/vis_type_pie.mdx index 9aa0d06dcdb73..a2a56b3477ea4 100644 --- a/api_docs/vis_type_pie.mdx +++ b/api_docs/vis_type_pie.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypePie title: "visTypePie" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypePie plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypePie'] 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. --- diff --git a/api_docs/vis_type_table.mdx b/api_docs/vis_type_table.mdx index 6f719edc75a7a..0c5300d359bb2 100644 --- a/api_docs/vis_type_table.mdx +++ b/api_docs/vis_type_table.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTable title: "visTypeTable" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTable plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTable'] 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. --- diff --git a/api_docs/vis_type_timelion.mdx b/api_docs/vis_type_timelion.mdx index 7e4d6c02f93eb..feb0f7cf343a8 100644 --- a/api_docs/vis_type_timelion.mdx +++ b/api_docs/vis_type_timelion.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimelion title: "visTypeTimelion" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimelion plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimelion'] 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. --- diff --git a/api_docs/vis_type_timeseries.mdx b/api_docs/vis_type_timeseries.mdx index 7b83ffcc71974..08b8ac44e16bf 100644 --- a/api_docs/vis_type_timeseries.mdx +++ b/api_docs/vis_type_timeseries.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeTimeseries title: "visTypeTimeseries" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeTimeseries plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeTimeseries'] 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. --- diff --git a/api_docs/vis_type_vega.mdx b/api_docs/vis_type_vega.mdx index d71121e566d73..d508073c70408 100644 --- a/api_docs/vis_type_vega.mdx +++ b/api_docs/vis_type_vega.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVega title: "visTypeVega" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVega plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVega'] 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. --- diff --git a/api_docs/vis_type_vislib.mdx b/api_docs/vis_type_vislib.mdx index 4f637e3b3db09..4d36b899a0b5a 100644 --- a/api_docs/vis_type_vislib.mdx +++ b/api_docs/vis_type_vislib.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeVislib title: "visTypeVislib" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeVislib plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeVislib'] 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. --- diff --git a/api_docs/vis_type_xy.mdx b/api_docs/vis_type_xy.mdx index 85cdc093b14bb..822042f8399ac 100644 --- a/api_docs/vis_type_xy.mdx +++ b/api_docs/vis_type_xy.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visTypeXy title: "visTypeXy" image: https://source.unsplash.com/400x175/?github summary: API docs for the visTypeXy plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visTypeXy'] 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. --- diff --git a/api_docs/visualizations.devdocs.json b/api_docs/visualizations.devdocs.json index 9e3b0bd75383d..d25dd72157eb8 100644 --- a/api_docs/visualizations.devdocs.json +++ b/api_docs/visualizations.devdocs.json @@ -1464,7 +1464,7 @@ "label": "VisualizationContainer", "description": [], "signature": [ - "({ \"data-test-subj\": dataTestSubj, className, children, handlers, showNoResult, error, }: ", + "({ \"data-test-subj\": dataTestSubj, className, children, handlers, showNoResult, error, renderComplete, }: ", "VisualizationContainerProps", ") => JSX.Element" ], @@ -1476,7 +1476,7 @@ "id": "def-public.VisualizationContainer.$1", "type": "Object", "tags": [], - "label": "{\n 'data-test-subj': dataTestSubj = '',\n className,\n children,\n handlers,\n showNoResult = false,\n error,\n}", + "label": "{\n 'data-test-subj': dataTestSubj = '',\n className,\n children,\n handlers,\n showNoResult = false,\n error,\n renderComplete,\n}", "description": [], "signature": [ "VisualizationContainerProps" @@ -2600,6 +2600,8 @@ "signature": [ "{ type?: string | undefined; query?: ", "Query", + " | ", + "AggregateQuery", " | undefined; filter?: ", "Filter", "[] | undefined; sort?: ", @@ -6761,6 +6763,8 @@ "signature": [ "{ type?: string | undefined; query?: ", "Query", + " | ", + "AggregateQuery", " | undefined; filter?: ", "Filter", "[] | undefined; sort?: ", diff --git a/api_docs/visualizations.mdx b/api_docs/visualizations.mdx index a04ddfc4bb41d..3aa3acd733743 100644 --- a/api_docs/visualizations.mdx +++ b/api_docs/visualizations.mdx @@ -4,7 +4,7 @@ slug: /kibana-dev-docs/api/visualizations title: "visualizations" image: https://source.unsplash.com/400x175/?github summary: API docs for the visualizations plugin -date: 2022-07-25 +date: 2022-07-28 tags: ['contributor', 'dev', 'apidocs', 'kibana', 'visualizations'] 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. --- diff --git a/dev_docs/operations/operations_landing.mdx b/dev_docs/operations/operations_landing.mdx index 2e2cef5c9bbbb..2533df2f194b9 100644 --- a/dev_docs/operations/operations_landing.mdx +++ b/dev_docs/operations/operations_landing.mdx @@ -22,6 +22,7 @@ layout: landing \ No newline at end of file diff --git a/docs/management/advanced-options.asciidoc b/docs/management/advanced-options.asciidoc index 5ca8f75a0fba0..c0fdb537aed73 100644 --- a/docs/management/advanced-options.asciidoc +++ b/docs/management/advanced-options.asciidoc @@ -319,6 +319,9 @@ The default sort direction for time-based data views. [[doctable-hidetimecolumn]]`doc_table:hideTimeColumn`:: Hides the "Time" column in *Discover* and in all saved searches on dashboards. +[[discover:enableSql]]`discover:enableSql`:: +When enabled, allows SQL queries for search. + [[doctable-highlight]]`doc_table:highlight`:: Highlights results in *Discover* and saved searches on dashboards. Highlighting slows requests when working on big documents. diff --git a/kbn_pm/src/lib/bazel.mjs b/kbn_pm/src/lib/bazel.mjs index 3fb27a18e5557..671db2f9b3f66 100644 --- a/kbn_pm/src/lib/bazel.mjs +++ b/kbn_pm/src/lib/bazel.mjs @@ -56,7 +56,7 @@ function throwBazelError(log, name, code, output) { async function runBazel(log, inputArgs, opts = undefined) { const bazel = (await getBazelRunner()).runBazel; - const args = [...(opts?.offline ? ['--config=offline'] : []), ...inputArgs]; + const args = [...inputArgs, ...(opts?.offline ? ['--config=offline'] : [])]; log.debug(`> bazel ${args.join(' ')}`); await bazel(args, { env: opts?.env, diff --git a/nav-kibana-dev.docnav.json b/nav-kibana-dev.docnav.json index 96f4074d9a7f7..2ab23a70c26fa 100644 --- a/nav-kibana-dev.docnav.json +++ b/nav-kibana-dev.docnav.json @@ -531,6 +531,12 @@ }, { "id": "kibDevDocsOpsDevCliRunner" + }, + { + "id": "kibDevDocsOpsGetRepoFiles" + }, + { + "id": "kibDevDocsOpsRepoSourceClassifier" } ] } diff --git a/package.json b/package.json index 590a66cc451f2..eabeab0d26d44 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,7 @@ "dashboarding" ], "private": true, - "version": "8.4.0", + "version": "8.5.0", "branch": "main", "types": "./kibana.d.ts", "tsdocMetadata": "./build/tsdoc-metadata.json", @@ -224,6 +224,9 @@ "@kbn/core-preboot-server": "link:bazel-bin/packages/core/preboot/core-preboot-server", "@kbn/core-preboot-server-internal": "link:bazel-bin/packages/core/preboot/core-preboot-server-internal", "@kbn/core-preboot-server-mocks": "link:bazel-bin/packages/core/preboot/core-preboot-server-mocks", + "@kbn/core-saved-objects-api-browser": "link:bazel-bin/packages/core/saved-objects/core-saved-objects-api-browser", + "@kbn/core-saved-objects-api-server": "link:bazel-bin/packages/core/saved-objects/core-saved-objects-api-server", + "@kbn/core-saved-objects-common": "link:bazel-bin/packages/core/saved-objects/core-saved-objects-common", "@kbn/core-test-helpers-http-setup-browser": "link:bazel-bin/packages/core/test-helpers/core-test-helpers-http-setup-browser", "@kbn/core-theme-browser": "link:bazel-bin/packages/core/theme/core-theme-browser", "@kbn/core-theme-browser-internal": "link:bazel-bin/packages/core/theme/core-theme-browser-internal", @@ -244,7 +247,9 @@ "@kbn/flot-charts": "link:bazel-bin/packages/kbn-flot-charts", "@kbn/handlebars": "link:bazel-bin/packages/kbn-handlebars", "@kbn/hapi-mocks": "link:bazel-bin/packages/kbn-hapi-mocks", - "@kbn/home-sample-data-cards": "link:bazel-bin/packages/home/sample_data_cards", + "@kbn/home-sample-data-card": "link:bazel-bin/packages/home/sample_data_card", + "@kbn/home-sample-data-tab": "link:bazel-bin/packages/home/sample_data_tab", + "@kbn/home-sample-data-types": "link:bazel-bin/packages/home/sample_data_types", "@kbn/i18n": "link:bazel-bin/packages/kbn-i18n", "@kbn/i18n-react": "link:bazel-bin/packages/kbn-i18n-react", "@kbn/interpreter": "link:bazel-bin/packages/kbn-interpreter", @@ -604,6 +609,7 @@ "@kbn/expect": "link:bazel-bin/packages/kbn-expect", "@kbn/find-used-node-modules": "link:bazel-bin/packages/kbn-find-used-node-modules", "@kbn/generate": "link:bazel-bin/packages/kbn-generate", + "@kbn/get-repo-files": "link:bazel-bin/packages/kbn-get-repo-files", "@kbn/import-resolver": "link:bazel-bin/packages/kbn-import-resolver", "@kbn/jest-serializers": "link:bazel-bin/packages/kbn-jest-serializers", "@kbn/optimizer": "link:bazel-bin/packages/kbn-optimizer", @@ -611,6 +617,8 @@ "@kbn/performance-testing-dataset-extractor": "link:bazel-bin/packages/kbn-performance-testing-dataset-extractor", "@kbn/plugin-generator": "link:bazel-bin/packages/kbn-plugin-generator", "@kbn/plugin-helpers": "link:bazel-bin/packages/kbn-plugin-helpers", + "@kbn/repo-source-classifier": "link:bazel-bin/packages/kbn-repo-source-classifier", + "@kbn/repo-source-classifier-cli": "link:bazel-bin/packages/kbn-repo-source-classifier-cli", "@kbn/scalability-simulation-generator": "link:bazel-bin/packages/kbn-scalability-simulation-generator", "@kbn/some-dev-log": "link:bazel-bin/packages/kbn-some-dev-log", "@kbn/sort-package-json": "link:bazel-bin/packages/kbn-sort-package-json", @@ -825,6 +833,9 @@ "@types/kbn__core-preboot-server-internal": "link:bazel-bin/packages/core/preboot/core-preboot-server-internal/npm_module_types", "@types/kbn__core-preboot-server-mocks": "link:bazel-bin/packages/core/preboot/core-preboot-server-mocks/npm_module_types", "@types/kbn__core-public-internal-base": "link:bazel-bin/packages/core/public/internal-base/npm_module_types", + "@types/kbn__core-saved-objects-api-browser": "link:bazel-bin/packages/core/saved-objects/core-saved-objects-api-browser/npm_module_types", + "@types/kbn__core-saved-objects-api-server": "link:bazel-bin/packages/core/saved-objects/core-saved-objects-api-server/npm_module_types", + "@types/kbn__core-saved-objects-common": "link:bazel-bin/packages/core/saved-objects/core-saved-objects-common/npm_module_types", "@types/kbn__core-server-internal-base": "link:bazel-bin/packages/core/server/internal-base/npm_module_types", "@types/kbn__core-test-helpers-http-setup-browser": "link:bazel-bin/packages/core/test-helpers/core-test-helpers-http-setup-browser/npm_module_types", "@types/kbn__core-theme-browser": "link:bazel-bin/packages/core/theme/core-theme-browser/npm_module_types", @@ -851,9 +862,12 @@ "@types/kbn__field-types": "link:bazel-bin/packages/kbn-field-types/npm_module_types", "@types/kbn__find-used-node-modules": "link:bazel-bin/packages/kbn-find-used-node-modules/npm_module_types", "@types/kbn__generate": "link:bazel-bin/packages/kbn-generate/npm_module_types", + "@types/kbn__get-repo-files": "link:bazel-bin/packages/kbn-get-repo-files/npm_module_types", "@types/kbn__handlebars": "link:bazel-bin/packages/kbn-handlebars/npm_module_types", "@types/kbn__hapi-mocks": "link:bazel-bin/packages/kbn-hapi-mocks/npm_module_types", - "@types/kbn__home-sample-data-cards": "link:bazel-bin/packages/home/sample_data_cards/npm_module_types", + "@types/kbn__home-sample-data-card": "link:bazel-bin/packages/home/sample_data_card/npm_module_types", + "@types/kbn__home-sample-data-tab": "link:bazel-bin/packages/home/sample_data_tab/npm_module_types", + "@types/kbn__home-sample-data-types": "link:bazel-bin/packages/home/sample_data_types/npm_module_types", "@types/kbn__i18n": "link:bazel-bin/packages/kbn-i18n/npm_module_types", "@types/kbn__i18n-react": "link:bazel-bin/packages/kbn-i18n-react/npm_module_types", "@types/kbn__import-resolver": "link:bazel-bin/packages/kbn-import-resolver/npm_module_types", @@ -876,6 +890,8 @@ "@types/kbn__plugin-generator": "link:bazel-bin/packages/kbn-plugin-generator/npm_module_types", "@types/kbn__plugin-helpers": "link:bazel-bin/packages/kbn-plugin-helpers/npm_module_types", "@types/kbn__react-field": "link:bazel-bin/packages/kbn-react-field/npm_module_types", + "@types/kbn__repo-source-classifier": "link:bazel-bin/packages/kbn-repo-source-classifier/npm_module_types", + "@types/kbn__repo-source-classifier-cli": "link:bazel-bin/packages/kbn-repo-source-classifier-cli/npm_module_types", "@types/kbn__rule-data-utils": "link:bazel-bin/packages/kbn-rule-data-utils/npm_module_types", "@types/kbn__scalability-simulation-generator": "link:bazel-bin/packages/kbn-scalability-simulation-generator/npm_module_types", "@types/kbn__securitysolution-autocomplete": "link:bazel-bin/packages/kbn-securitysolution-autocomplete/npm_module_types", diff --git a/packages/BUILD.bazel b/packages/BUILD.bazel index d376efa4c0028..9754dfd4c3805 100644 --- a/packages/BUILD.bazel +++ b/packages/BUILD.bazel @@ -92,6 +92,9 @@ filegroup( "//packages/core/preboot/core-preboot-server-internal:build", "//packages/core/preboot/core-preboot-server-mocks:build", "//packages/core/preboot/core-preboot-server:build", + "//packages/core/saved-objects/core-saved-objects-api-browser:build", + "//packages/core/saved-objects/core-saved-objects-api-server:build", + "//packages/core/saved-objects/core-saved-objects-common:build", "//packages/core/test-helpers/core-test-helpers-http-setup-browser:build", "//packages/core/theme/core-theme-browser-internal:build", "//packages/core/theme/core-theme-browser-mocks:build", @@ -102,7 +105,9 @@ filegroup( "//packages/core/ui-settings/core-ui-settings-common:build", "//packages/elastic-apm-synthtrace:build", "//packages/elastic-safer-lodash-set:build", - "//packages/home/sample_data_cards:build", + "//packages/home/sample_data_card:build", + "//packages/home/sample_data_tab:build", + "//packages/home/sample_data_types:build", "//packages/kbn-ace:build", "//packages/kbn-alerts:build", "//packages/kbn-ambient-storybook-types:build", @@ -145,6 +150,7 @@ filegroup( "//packages/kbn-find-used-node-modules:build", "//packages/kbn-flot-charts:build", "//packages/kbn-generate:build", + "//packages/kbn-get-repo-files:build", "//packages/kbn-handlebars:build", "//packages/kbn-hapi-mocks:build", "//packages/kbn-i18n-react:build", @@ -165,6 +171,8 @@ filegroup( "//packages/kbn-plugin-generator:build", "//packages/kbn-plugin-helpers:build", "//packages/kbn-react-field:build", + "//packages/kbn-repo-source-classifier-cli:build", + "//packages/kbn-repo-source-classifier:build", "//packages/kbn-rule-data-utils:build", "//packages/kbn-scalability-simulation-generator:build", "//packages/kbn-securitysolution-autocomplete:build", @@ -317,6 +325,9 @@ filegroup( "//packages/core/preboot/core-preboot-server-internal:build_types", "//packages/core/preboot/core-preboot-server-mocks:build_types", "//packages/core/preboot/core-preboot-server:build_types", + "//packages/core/saved-objects/core-saved-objects-api-browser:build_types", + "//packages/core/saved-objects/core-saved-objects-api-server:build_types", + "//packages/core/saved-objects/core-saved-objects-common:build_types", "//packages/core/test-helpers/core-test-helpers-http-setup-browser:build_types", "//packages/core/theme/core-theme-browser-internal:build_types", "//packages/core/theme/core-theme-browser-mocks:build_types", @@ -327,7 +338,8 @@ filegroup( "//packages/core/ui-settings/core-ui-settings-common:build_types", "//packages/elastic-apm-synthtrace:build_types", "//packages/elastic-safer-lodash-set:build_types", - "//packages/home/sample_data_cards:build_types", + "//packages/home/sample_data_card:build_types", + "//packages/home/sample_data_tab:build_types", "//packages/kbn-ace:build_types", "//packages/kbn-alerts:build_types", "//packages/kbn-analytics:build_types", @@ -361,6 +373,7 @@ filegroup( "//packages/kbn-field-types:build_types", "//packages/kbn-find-used-node-modules:build_types", "//packages/kbn-generate:build_types", + "//packages/kbn-get-repo-files:build_types", "//packages/kbn-handlebars:build_types", "//packages/kbn-hapi-mocks:build_types", "//packages/kbn-i18n-react:build_types", @@ -381,6 +394,8 @@ filegroup( "//packages/kbn-plugin-generator:build_types", "//packages/kbn-plugin-helpers:build_types", "//packages/kbn-react-field:build_types", + "//packages/kbn-repo-source-classifier-cli:build_types", + "//packages/kbn-repo-source-classifier:build_types", "//packages/kbn-rule-data-utils:build_types", "//packages/kbn-scalability-simulation-generator:build_types", "//packages/kbn-securitysolution-autocomplete:build_types", diff --git a/packages/core/logging/core-logging-server-internal/src/__snapshots__/logging_system.test.ts.snap b/packages/core/logging/core-logging-server-internal/src/__snapshots__/logging_system.test.ts.snap index e369d7b0cba37..55a144b92ee26 100644 --- a/packages/core/logging/core-logging-server-internal/src/__snapshots__/logging_system.test.ts.snap +++ b/packages/core/logging/core-logging-server-internal/src/__snapshots__/logging_system.test.ts.snap @@ -16,7 +16,7 @@ exports[`asLoggerFactory() only allows to create new loggers. 1`] = ` Object { "@timestamp": "2012-01-30T22:33:22.011-05:00", "ecs": Object { - "version": "8.0.0", + "version": "8.4.0", }, "log": Object { "level": "TRACE", @@ -33,7 +33,7 @@ exports[`asLoggerFactory() only allows to create new loggers. 2`] = ` Object { "@timestamp": "2012-01-30T17:33:22.011-05:00", "ecs": Object { - "version": "8.0.0", + "version": "8.4.0", }, "log": Object { "level": "INFO", @@ -51,7 +51,7 @@ exports[`asLoggerFactory() only allows to create new loggers. 3`] = ` Object { "@timestamp": "2012-01-30T12:33:22.011-05:00", "ecs": Object { - "version": "8.0.0", + "version": "8.4.0", }, "log": Object { "level": "FATAL", @@ -68,7 +68,7 @@ exports[`flushes memory buffer logger and switches to real logger once config is Object { "@timestamp": "2012-02-01T09:33:22.011-05:00", "ecs": Object { - "version": "8.0.0", + "version": "8.4.0", }, "log": Object { "level": "INFO", @@ -86,7 +86,7 @@ exports[`flushes memory buffer logger and switches to real logger once config is Object { "@timestamp": "2012-01-31T23:33:22.011-05:00", "ecs": Object { - "version": "8.0.0", + "version": "8.4.0", }, "log": Object { "level": "INFO", diff --git a/packages/core/logging/core-logging-server-internal/src/layouts/json_layout.test.ts b/packages/core/logging/core-logging-server-internal/src/layouts/json_layout.test.ts index 259900fd5d3fb..1a197883e511d 100644 --- a/packages/core/logging/core-logging-server-internal/src/layouts/json_layout.test.ts +++ b/packages/core/logging/core-logging-server-internal/src/layouts/json_layout.test.ts @@ -81,7 +81,7 @@ test('`format()` correctly formats record and includes correct ECS version.', () for (const record of records) { const { ecs, ...restOfRecord } = JSON.parse(layout.format(record)); - expect(ecs).toStrictEqual({ version: '8.0.0' }); + expect(ecs).toStrictEqual({ version: '8.4.0' }); expect(restOfRecord).toMatchSnapshot(); } }); diff --git a/packages/core/logging/core-logging-server-internal/src/layouts/json_layout.ts b/packages/core/logging/core-logging-server-internal/src/layouts/json_layout.ts index da5ae237b5660..4e4d2d6faa718 100644 --- a/packages/core/logging/core-logging-server-internal/src/layouts/json_layout.ts +++ b/packages/core/logging/core-logging-server-internal/src/layouts/json_layout.ts @@ -42,7 +42,7 @@ export class JsonLayout implements Layout { const transactionId = record.meta?.transaction?.id ?? record.transactionId; const log: Ecs = { - ecs: { version: '8.0.0' }, + ecs: { version: '8.4.0' }, '@timestamp': moment(record.timestamp).format('YYYY-MM-DDTHH:mm:ss.SSSZ'), message: record.message, error: JsonLayout.errorToSerializableObject(record.error), diff --git a/packages/core/node/core-node-server-internal/src/node_service.ts b/packages/core/node/core-node-server-internal/src/node_service.ts index cd73c7f85e6f5..7d3ab67364224 100644 --- a/packages/core/node/core-node-server-internal/src/node_service.ts +++ b/packages/core/node/core-node-server-internal/src/node_service.ts @@ -49,7 +49,6 @@ export class NodeService { public async preboot({ loggingSystem }: PrebootDeps): Promise { const roles = await this.getNodeRoles(); - // @ts-expect-error Custom ECS field loggingSystem.setGlobalContext({ service: { node: { roles } } }); this.log.info(`Kibana process configured with roles: [${roles.join(', ')}]`); diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/BUILD.bazel b/packages/core/saved-objects/core-saved-objects-api-browser/BUILD.bazel new file mode 100644 index 0000000000000..57e9e94250cdc --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/BUILD.bazel @@ -0,0 +1,108 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-saved-objects-api-browser" +PKG_REQUIRE_NAME = "@kbn/core-saved-objects-api-browser" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//react" +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "//packages/core/saved-objects/core-saved-objects-common:npm_module_types", + "//packages/core/saved-objects/core-saved-objects-api-server:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/README.md b/packages/core/saved-objects/core-saved-objects-api-browser/README.md new file mode 100644 index 0000000000000..9e6d2592ed72d --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/README.md @@ -0,0 +1,3 @@ +# @kbn/core-saved-objects-api-browser + +This package contains the public types for core's browser-side savedObjects client APIs. diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/jest.config.js b/packages/core/saved-objects/core-saved-objects-api-browser/jest.config.js new file mode 100644 index 0000000000000..4da6aa55e6c12 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: ['/packages/core/saved-objects/core-saved-objects-api-browser'], +}; diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/package.json b/packages/core/saved-objects/core-saved-objects-api-browser/package.json new file mode 100644 index 0000000000000..7e40339fbf326 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-saved-objects-api-browser", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/base.ts b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/base.ts new file mode 100644 index 0000000000000..6414b206a672b --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/base.ts @@ -0,0 +1,14 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { SimpleSavedObject } from '../simple_saved_object'; + +/** @public */ +export interface SavedObjectsBatchResponse { + savedObjects: Array>; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_create.ts b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_create.ts new file mode 100644 index 0000000000000..4e4190cb55675 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_create.ts @@ -0,0 +1,26 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectsCreateOptions } from './create'; + +/** + * @param type - Create a SavedObject of the given type + * @param attributes - Create a SavedObject with the given attributes + * + * @public + */ +export interface SavedObjectsBulkCreateObject extends SavedObjectsCreateOptions { + type: string; + attributes: T; +} + +/** @public */ +export interface SavedObjectsBulkCreateOptions { + /** If a document with the given `id` already exists, overwrite it's contents (default=false). */ + overwrite?: boolean; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_resolve.ts b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_resolve.ts new file mode 100644 index 0000000000000..58316983c7a8d --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_resolve.ts @@ -0,0 +1,14 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { ResolvedSimpleSavedObject } from './resolve'; + +/** @public */ +export interface SavedObjectsBulkResolveResponse { + resolved_objects: Array>; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_update.ts b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_update.ts new file mode 100644 index 0000000000000..f5ba2cc249c19 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/bulk_update.ts @@ -0,0 +1,23 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectReference } from '@kbn/core-saved-objects-common'; + +/** @public */ +export interface SavedObjectsBulkUpdateObject { + type: string; + id: string; + attributes: T; + version?: string; + references?: SavedObjectReference[]; +} + +/** @public */ +export interface SavedObjectsBulkUpdateOptions { + namespace?: string; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/create.ts b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/create.ts new file mode 100644 index 0000000000000..fb2e70d7d1ebd --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/create.ts @@ -0,0 +1,27 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { + SavedObjectReference, + SavedObjectsMigrationVersion, +} from '@kbn/core-saved-objects-common'; + +/** @public */ +export interface SavedObjectsCreateOptions { + /** + * (Not recommended) Specify an id instead of having the saved objects service generate one for you. + */ + id?: string; + /** If a document with the given `id` already exists, overwrite it's contents (default=false). */ + overwrite?: boolean; + /** {@inheritDoc SavedObjectsMigrationVersion} */ + migrationVersion?: SavedObjectsMigrationVersion; + /** A semver value that is used when upgrading objects between Kibana versions. */ + coreMigrationVersion?: string; + references?: SavedObjectReference[]; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/delete.ts b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/delete.ts new file mode 100644 index 0000000000000..598a35a0aad41 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/delete.ts @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +/** @public */ +export interface SavedObjectsDeleteOptions { + /** Force deletion of an object that exists in multiple namespaces */ + force?: boolean; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/find.ts b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/find.ts new file mode 100644 index 0000000000000..7f555764124a0 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/find.ts @@ -0,0 +1,39 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectsFindOptions as SavedObjectFindOptionsServer } from '@kbn/core-saved-objects-api-server'; +import type { SavedObjectsBatchResponse } from './base'; + +/** + * @public + */ +export type SavedObjectsFindOptions = Omit< + SavedObjectFindOptionsServer, + 'pit' | 'rootSearchFields' | 'searchAfter' | 'sortOrder' | 'typeToNamespacesMap' +>; + +/** + * Return type of the Saved Objects `find()` method. + * + * @public + */ +export interface SavedObjectsFindResponse + extends SavedObjectsBatchResponse { + aggregations?: A; + total: number; + perPage: number; + page: number; +} + +/** + * @public + */ +export interface SavedObjectsFindOptionsReference { + type: string; + id: string; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/index.ts b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/index.ts new file mode 100644 index 0000000000000..4652facb972cc --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/index.ts @@ -0,0 +1,21 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type { SavedObjectsBatchResponse } from './base'; +export type { SavedObjectsBulkCreateObject, SavedObjectsBulkCreateOptions } from './bulk_create'; +export type { SavedObjectsBulkResolveResponse } from './bulk_resolve'; +export type { SavedObjectsBulkUpdateObject, SavedObjectsBulkUpdateOptions } from './bulk_update'; +export type { SavedObjectsCreateOptions } from './create'; +export type { SavedObjectsDeleteOptions } from './delete'; +export type { + SavedObjectsFindResponse, + SavedObjectsFindOptions, + SavedObjectsFindOptionsReference, +} from './find'; +export type { ResolvedSimpleSavedObject } from './resolve'; +export type { SavedObjectsUpdateOptions } from './update'; diff --git a/src/core/public/saved_objects/types.ts b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/resolve.ts similarity index 93% rename from src/core/public/saved_objects/types.ts rename to packages/core/saved-objects/core-saved-objects-api-browser/src/apis/resolve.ts index 92ecde94973ec..c2383d7cb50d5 100644 --- a/src/core/public/saved_objects/types.ts +++ b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/resolve.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ -import type { SavedObjectsResolveResponse } from '../../server'; -import { SimpleSavedObject } from './simple_saved_object'; +import type { SavedObjectsResolveResponse } from '@kbn/core-saved-objects-api-server'; +import { SimpleSavedObject } from '../simple_saved_object'; /** * This interface is a very simple wrapper for SavedObjects resolved from the server diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/update.ts b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/update.ts new file mode 100644 index 0000000000000..dd9a6dc523229 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/src/apis/update.ts @@ -0,0 +1,16 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectReference } from '@kbn/core-saved-objects-common'; + +/** @public */ +export interface SavedObjectsUpdateOptions { + version?: string; + upsert?: Attributes; + references?: SavedObjectReference[]; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/src/index.ts b/packages/core/saved-objects/core-saved-objects-api-browser/src/index.ts new file mode 100644 index 0000000000000..82a93cf091c77 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/src/index.ts @@ -0,0 +1,25 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type { SavedObjectsClientContract } from './saved_objects_client'; +export type { SimpleSavedObject } from './simple_saved_object'; +export type { + SavedObjectsCreateOptions, + SavedObjectsDeleteOptions, + SavedObjectsBatchResponse, + SavedObjectsFindOptions, + SavedObjectsFindOptionsReference, + SavedObjectsUpdateOptions, + ResolvedSimpleSavedObject, + SavedObjectsBulkUpdateObject, + SavedObjectsFindResponse, + SavedObjectsBulkCreateOptions, + SavedObjectsBulkUpdateOptions, + SavedObjectsBulkResolveResponse, + SavedObjectsBulkCreateObject, +} from './apis'; diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts b/packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts new file mode 100644 index 0000000000000..123b5c81d4064 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/src/saved_objects_client.ts @@ -0,0 +1,157 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectTypeIdTuple } from '@kbn/core-saved-objects-common'; +import type { + ResolvedSimpleSavedObject, + SavedObjectsBatchResponse, + SavedObjectsBulkCreateObject, + SavedObjectsBulkCreateOptions, + SavedObjectsBulkResolveResponse, + SavedObjectsBulkUpdateObject, + SavedObjectsCreateOptions, + SavedObjectsFindResponse, + SavedObjectsFindOptions, + SavedObjectsUpdateOptions, + SavedObjectsDeleteOptions, +} from './apis'; +import type { SimpleSavedObject } from './simple_saved_object'; + +/** + * The client-side SavedObjectsClient is a thin convenience library around the SavedObjects + * HTTP API for interacting with Saved Objects. + * + * @public + */ +export interface SavedObjectsClientContract { + /** + * Persists an object + */ + create( + type: string, + attributes: T, + options?: SavedObjectsCreateOptions + ): Promise>; + + /** + * Creates multiple documents at once + * @returns The result of the create operation containing created saved objects. + */ + bulkCreate( + objects: SavedObjectsBulkCreateObject[], + options?: SavedObjectsBulkCreateOptions + ): Promise>; + + /** + * Deletes an object + */ + delete(type: string, id: string, options?: SavedObjectsDeleteOptions): Promise<{}>; + + /** + * Search for objects + * + * @param {object} [options={}] + * @property {string} options.type + * @property {string} options.search + * @property {string} options.searchFields - see Elasticsearch Simple Query String + * Query field argument for more information + * @property {integer} [options.page=1] + * @property {integer} [options.perPage=20] + * @property {array} options.fields + * @property {object} [options.hasReference] - { type, id } + * @returns A find result with objects matching the specified search. + */ + find( + options: SavedObjectsFindOptions + ): Promise>; + + /** + * Fetches a single object + * + * @param {string} type + * @param {string} id + * @returns The saved object for the given type and id. + */ + get(type: string, id: string): Promise>; + + /** + * Returns an array of objects by id + * + * @param {array} objects - an array ids, or an array of objects containing id and optionally type + * @returns The saved objects with the given type and ids requested + * @example + * + * bulkGet([ + * { id: 'one', type: 'config' }, + * { id: 'foo', type: 'index-pattern' } + * ]) + */ + bulkGet(objects: SavedObjectTypeIdTuple[]): Promise>; + + /** + * Resolves a single object + * + * @param {string} type + * @param {string} id + * @returns The resolve result for the saved object for the given type and id. + * + * @note Saved objects that Kibana fails to find are replaced with an error object and an "exactMatch" outcome. The rationale behind the + * outcome is that "exactMatch" is the default outcome, and the outcome only changes if an alias is found. This behavior for the `resolve` + * API is unique to the public client, which batches individual calls with `bulkResolve` under the hood. We don't throw an error in that + * case for legacy compatibility reasons. + */ + resolve(type: string, id: string): Promise>; + + /** + * Resolves an array of objects by id, using any legacy URL aliases if they exist + * + * @param objects - an array of objects containing id, type + * @returns The bulk resolve result for the saved objects for the given types and ids. + * @example + * + * bulkResolve([ + * { id: 'one', type: 'config' }, + * { id: 'foo', type: 'index-pattern' } + * ]) + * + * @note Saved objects that Kibana fails to find are replaced with an error object and an "exactMatch" outcome. The rationale behind the + * outcome is that "exactMatch" is the default outcome, and the outcome only changes if an alias is found. The `resolve` method in the + * public client uses `bulkResolve` under the hood, so it behaves the same way. + */ + bulkResolve( + objects: SavedObjectTypeIdTuple[] + ): Promise>; + + /** + * Updates an object + * + * @param {string} type + * @param {string} id + * @param {object} attributes + * @param {object} options + * @prop {integer} options.version - ensures version matches that of persisted object + * @prop {object} options.migrationVersion - The optional migrationVersion of this document + * @returns + */ + update( + type: string, + id: string, + attributes: T, + options?: SavedObjectsUpdateOptions + ): Promise>; + + /** + * Update multiple documents at once + * + * @param {array} objects - [{ type, id, attributes, options: { version, references } }] + * @returns The result of the update operation containing both failed and updated saved objects. + */ + bulkUpdate( + objects: SavedObjectsBulkUpdateObject[] + ): Promise>; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts b/packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts new file mode 100644 index 0000000000000..46d3e65cdec1b --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/src/simple_saved_object.ts @@ -0,0 +1,45 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObject as SavedObjectType } from '@kbn/core-saved-objects-common'; + +/** + * Very simple wrapper for SavedObjects loaded from the server + * with the {@link SavedObjectsClientContract}. + * + * It provides basic functionality for creating/saving/deleting saved objects, + * but doesn't include any type-specific implementations. + * + * @public + */ +export interface SimpleSavedObject { + attributes: T; + _version?: SavedObjectType['version']; + id: SavedObjectType['id']; + type: SavedObjectType['type']; + migrationVersion: SavedObjectType['migrationVersion']; + coreMigrationVersion: SavedObjectType['coreMigrationVersion']; + error: SavedObjectType['error']; + references: SavedObjectType['references']; + updatedAt: SavedObjectType['updated_at']; + /** + * Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with + * `namespaceType: 'agnostic'`. + */ + namespaces: SavedObjectType['namespaces']; + + get(key: string): any; + + set(key: string, value: any): T; + + has(key: string): boolean; + + save(): Promise>; + + delete(): Promise<{}>; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-browser/tsconfig.json b/packages/core/saved-objects/core-saved-objects-api-browser/tsconfig.json new file mode 100644 index 0000000000000..39d3c7097814a --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-browser/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/BUILD.bazel b/packages/core/saved-objects/core-saved-objects-api-server/BUILD.bazel new file mode 100644 index 0000000000000..31c7374fd44d9 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/BUILD.bazel @@ -0,0 +1,99 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-saved-objects-api-server" +PKG_REQUIRE_NAME = "@kbn/core-saved-objects-api-server" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//@elastic/elasticsearch", + "//packages/core/saved-objects/core-saved-objects-common:npm_module_types" +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/saved-objects/core-saved-objects-api-server/README.md b/packages/core/saved-objects/core-saved-objects-api-server/README.md new file mode 100644 index 0000000000000..8a2da90f7337d --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/README.md @@ -0,0 +1,5 @@ +# @kbn/core-saved-objects-api-server + +This package contains the public types for core's server-side savedObjects client (and repository) APIs. + + diff --git a/packages/core/saved-objects/core-saved-objects-api-server/jest.config.js b/packages/core/saved-objects/core-saved-objects-api-server/jest.config.js new file mode 100644 index 0000000000000..c598c13ec8f15 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../..', + roots: ['/packages/core/saved-objects/core-saved-objects-api-server'], +}; diff --git a/packages/core/saved-objects/core-saved-objects-api-server/package.json b/packages/core/saved-objects/core-saved-objects-api-server/package.json new file mode 100644 index 0000000000000..971c97fad93bb --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/core-saved-objects-api-server", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/base.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/base.ts new file mode 100644 index 0000000000000..e02a4142448ef --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/base.ts @@ -0,0 +1,32 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObject } from '@kbn/core-saved-objects-common'; + +/** + * Base options used by most of the savedObject APIs. + * @public + */ +export interface SavedObjectsBaseOptions { + /** Specify the namespace for this operation */ + namespace?: string; +} + +/** + * Elasticsearch Refresh setting for mutating operation + * @public + */ +export type MutatingOperationRefreshSetting = boolean | 'wait_for'; + +/** + * + * @public + */ +export interface SavedObjectsBulkResponse { + saved_objects: Array>; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_create.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_create.ts new file mode 100644 index 0000000000000..735564cfec63d --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_create.ts @@ -0,0 +1,49 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { + SavedObjectReference, + SavedObjectsMigrationVersion, +} from '@kbn/core-saved-objects-common'; + +/** + * + * @public + */ +export interface SavedObjectsBulkCreateObject { + id?: string; + type: string; + attributes: T; + version?: string; + references?: SavedObjectReference[]; + /** {@inheritDoc SavedObjectsMigrationVersion} */ + migrationVersion?: SavedObjectsMigrationVersion; + /** + * A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current + * Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the + * current Kibana version, it will result in an error. + * + * @remarks + * Do not attempt to set this manually. It should only be used if you retrieved an existing object that had the `coreMigrationVersion` + * field set and you want to create it again. + */ + coreMigrationVersion?: string; + /** Optional ID of the original saved object, if this object's `id` was regenerated */ + originId?: string; + /** + * Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in + * {@link SavedObjectsCreateOptions}. + * + * * For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, + * including the "All spaces" identifier (`'*'`). + * * For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only + * be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. + * * For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. + */ + initialNamespaces?: string[]; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_get.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_get.ts new file mode 100644 index 0000000000000..fbbe6c958594d --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_get.ts @@ -0,0 +1,29 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +/** + * + * @public + */ +export interface SavedObjectsBulkGetObject { + id: string; + type: string; + /** SavedObject fields to include in the response */ + fields?: string[]; + /** + * Optional namespace(s) for the object to be retrieved in. If this is defined, it will supersede the namespace ID that is in the + * top-level options. + * + * * For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, + * including the "All spaces" identifier (`'*'`). + * * For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only + * be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. + * * For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. + */ + namespaces?: string[]; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_resolve.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_resolve.ts new file mode 100644 index 0000000000000..b52c8caf26e82 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_resolve.ts @@ -0,0 +1,26 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectsResolveResponse } from './resolve'; + +/** + * + * @public + */ +export interface SavedObjectsBulkResolveObject { + id: string; + type: string; +} + +/** + * + * @public + */ +export interface SavedObjectsBulkResolveResponse { + resolved_objects: Array>; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts new file mode 100644 index 0000000000000..102e46809b55e --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/bulk_update.ts @@ -0,0 +1,48 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { MutatingOperationRefreshSetting, SavedObjectsBaseOptions } from './base'; +import type { SavedObjectsUpdateOptions, SavedObjectsUpdateResponse } from './update'; + +/** + * + * @public + */ +export interface SavedObjectsBulkUpdateObject + extends Pick, 'version' | 'references'> { + /** The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` */ + id: string; + /** The type of this Saved Object. Each plugin can define it's own custom Saved Object types. */ + type: string; + /** {@inheritdoc SavedObjectAttributes} */ + attributes: Partial; + /** + * Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in + * {@link SavedObjectsBulkUpdateOptions}. + * + * Note: the default namespace's string representation is `'default'`, and its ID representation is `undefined`. + **/ + namespace?: string; +} + +/** + * + * @public + */ +export interface SavedObjectsBulkUpdateOptions extends SavedObjectsBaseOptions { + /** The Elasticsearch Refresh setting for this operation */ + refresh?: MutatingOperationRefreshSetting; +} + +/** + * + * @public + */ +export interface SavedObjectsBulkUpdateResponse { + saved_objects: Array>; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/check_conflicts.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/check_conflicts.ts new file mode 100644 index 0000000000000..38d1c281b1000 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/check_conflicts.ts @@ -0,0 +1,30 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectError } from '@kbn/core-saved-objects-common'; + +/** + * + * @public + */ +export interface SavedObjectsCheckConflictsObject { + id: string; + type: string; +} + +/** + * + * @public + */ +export interface SavedObjectsCheckConflictsResponse { + errors: Array<{ + id: string; + type: string; + error: SavedObjectError; + }>; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/close_point_in_time.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/close_point_in_time.ts new file mode 100644 index 0000000000000..16348155003d2 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/close_point_in_time.ts @@ -0,0 +1,29 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectsBaseOptions } from './base'; + +/** + * @public + */ +export type SavedObjectsClosePointInTimeOptions = SavedObjectsBaseOptions; + +/** + * @public + */ +export interface SavedObjectsClosePointInTimeResponse { + /** + * If true, all search contexts associated with the PIT id are + * successfully closed. + */ + succeeded: boolean; + /** + * The number of search contexts that have been successfully closed. + */ + num_freed: number; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts new file mode 100644 index 0000000000000..59bfd4144a8c1 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/collect_multinamespace_references.ts @@ -0,0 +1,77 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectsBaseOptions } from './base'; + +/** + * An object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the + * `namespaceType: 'multiple'` or `namespaceType: 'multiple-isolated'` option). + * + * Note: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with + * the `namespaceType: 'multiple'`). + * + * @public + */ +export interface SavedObjectsCollectMultiNamespaceReferencesObject { + id: string; + type: string; +} + +/** + * Options for collecting references. + * + * @public + */ +export interface SavedObjectsCollectMultiNamespaceReferencesOptions + extends SavedObjectsBaseOptions { + /** Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences' */ + purpose?: 'collectMultiNamespaceReferences' | 'updateObjectsSpaces'; +} + +/** + * A returned input object or one of its references, with additional context. + * + * @public + */ +export interface SavedObjectReferenceWithContext { + /** The type of the referenced object */ + type: string; + /** The ID of the referenced object */ + id: string; + /** The origin ID of the referenced object (if it has one) */ + originId?: string; + /** The space(s) that the referenced object exists in */ + spaces: string[]; + /** + * References to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains + * inbound references for the scope of this operation + */ + inboundReferences: Array<{ + /** The type of the object that has the inbound reference */ + type: string; + /** The ID of the object that has the inbound reference */ + id: string; + /** The name of the inbound reference */ + name: string; + }>; + /** Whether or not this object or reference is missing */ + isMissing?: boolean; + /** The space(s) that legacy URL aliases matching this type/id exist in */ + spacesWithMatchingAliases?: string[]; + /** The space(s) that objects matching this origin exist in (including this one) */ + spacesWithMatchingOrigins?: string[]; +} + +/** + * The response when object references are collected. + * + * @public + */ +export interface SavedObjectsCollectMultiNamespaceReferencesResponse { + objects: SavedObjectReferenceWithContext[]; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/create.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/create.ts new file mode 100644 index 0000000000000..2172b75be4b46 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/create.ts @@ -0,0 +1,57 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { + SavedObjectsMigrationVersion, + SavedObjectReference, +} from '@kbn/core-saved-objects-common'; +import type { MutatingOperationRefreshSetting, SavedObjectsBaseOptions } from './base'; + +/** + * + * @public + */ +export interface SavedObjectsCreateOptions extends SavedObjectsBaseOptions { + /** (not recommended) Specify an id for the document */ + id?: string; + /** Overwrite existing documents (defaults to false) */ + overwrite?: boolean; + /** + * An opaque version number which changes on each successful write operation. + * Can be used in conjunction with `overwrite` for implementing optimistic concurrency control. + **/ + version?: string; + /** {@inheritDoc SavedObjectsMigrationVersion} */ + migrationVersion?: SavedObjectsMigrationVersion; + /** + * A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current + * Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the + * current Kibana version, it will result in an error. + * + * @remarks + * Do not attempt to set this manually. It should only be used if you retrieved an existing object that had the `coreMigrationVersion` + * field set and you want to create it again. + */ + coreMigrationVersion?: string; + references?: SavedObjectReference[]; + /** The Elasticsearch Refresh setting for this operation */ + refresh?: MutatingOperationRefreshSetting; + /** Optional ID of the original saved object, if this object's `id` was regenerated */ + originId?: string; + /** + * Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in + * {@link SavedObjectsCreateOptions}. + * + * * For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, + * including the "All spaces" identifier (`'*'`). + * * For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only + * be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. + * * For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. + */ + initialNamespaces?: string[]; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/create_point_in_time_finder.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/create_point_in_time_finder.ts new file mode 100644 index 0000000000000..ea7e1f319a582 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/create_point_in_time_finder.ts @@ -0,0 +1,47 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectsFindOptions, SavedObjectsFindResponse } from './find'; +import type { SavedObjectsClientContract } from '../saved_objects_client'; + +/** + * @public + */ +export type SavedObjectsCreatePointInTimeFinderOptions = Omit< + SavedObjectsFindOptions, + 'page' | 'pit' | 'searchAfter' +>; + +/** + * @public + */ +export interface SavedObjectsCreatePointInTimeFinderDependencies { + client: Pick; +} + +/** @public */ +export interface ISavedObjectsPointInTimeFinder { + /** + * An async generator which wraps calls to `savedObjectsClient.find` and + * iterates over multiple pages of results using `_pit` and `search_after`. + * This will open a new Point-In-Time (PIT), and continue paging until a set + * of results is received that's smaller than the designated `perPage` size. + */ + find: () => AsyncGenerator>; + /** + * Closes the Point-In-Time associated with this finder instance. + * + * Once you have retrieved all of the results you need, it is recommended + * to call `close()` to clean up the PIT and prevent Elasticsearch from + * consuming resources unnecessarily. This is only required if you are + * done iterating and have not yet paged through all of the results: the + * PIT will automatically be closed for you once you reach the last page + * of results, or if the underlying call to `find` fails for any reason. + */ + close: () => Promise; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/delete.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/delete.ts new file mode 100644 index 0000000000000..36c5dab7d689e --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/delete.ts @@ -0,0 +1,20 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { MutatingOperationRefreshSetting, SavedObjectsBaseOptions } from './base'; + +/** + * + * @public + */ +export interface SavedObjectsDeleteOptions extends SavedObjectsBaseOptions { + /** The Elasticsearch Refresh setting for this operation */ + refresh?: MutatingOperationRefreshSetting; + /** Force deletion of an object that exists in multiple namespaces */ + force?: boolean; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/delete_by_namespace.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/delete_by_namespace.ts new file mode 100644 index 0000000000000..17eda87e3dd70 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/delete_by_namespace.ts @@ -0,0 +1,18 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectsBaseOptions } from './base'; + +/** + * + * @public + */ +export interface SavedObjectsDeleteByNamespaceOptions extends SavedObjectsBaseOptions { + /** The Elasticsearch supports only boolean flag for this operation */ + refresh?: boolean; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts new file mode 100644 index 0000000000000..49042029f334b --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/find.ts @@ -0,0 +1,173 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { + SortOrder, + AggregationsAggregationContainer, + Id as EsId, +} from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; + +type KueryNode = any; + +/** + * @public + */ +export interface SavedObjectsFindOptionsReference { + type: string; + id: string; +} + +/** + * @public + */ +export interface SavedObjectsPitParams { + id: string; + keepAlive?: string; +} + +/** + * + * @public + */ +export interface SavedObjectsFindOptions { + type: string | string[]; + page?: number; + perPage?: number; + sortField?: string; + sortOrder?: SortOrder; + /** + * An array of fields to include in the results + * @example + * SavedObjects.find({type: 'dashboard', fields: ['attributes.name', 'attributes.location']}) + */ + fields?: string[]; + /** Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information */ + search?: string; + /** The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information */ + searchFields?: string[]; + /** + * Use the sort values from the previous page to retrieve the next page of results. + */ + searchAfter?: EsId[]; + /** + * The fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not + * be modified. If used in conjunction with `searchFields`, both are concatenated together. + */ + rootSearchFields?: string[]; + + /** + * Search for documents having a reference to the specified objects. + * Use `hasReferenceOperator` to specify the operator to use when searching for multiple references. + */ + hasReference?: SavedObjectsFindOptionsReference | SavedObjectsFindOptionsReference[]; + /** + * The operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR` + */ + hasReferenceOperator?: 'AND' | 'OR'; + + /** + * The search operator to use with the provided filter. Defaults to `OR` + */ + defaultSearchOperator?: 'AND' | 'OR'; + filter?: string | KueryNode; + /** + * A record of aggregations to perform. + * The API currently only supports a limited set of metrics and bucket aggregation types. + * Additional aggregation types can be contributed to Core. + * + * @example + * Aggregating on SO attribute field + * ```ts + * const aggs = { latest_version: { max: { field: 'dashboard.attributes.version' } } }; + * return client.find({ type: 'dashboard', aggs }) + * ``` + * + * @example + * Aggregating on SO root field + * ```ts + * const aggs = { latest_update: { max: { field: 'dashboard.updated_at' } } }; + * return client.find({ type: 'dashboard', aggs }) + * ``` + * + * @alpha + */ + aggs?: Record; + namespaces?: string[]; + /** + * This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved + * object client wrapper. + * If this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query. + * Any types that are not included in this map will be excluded entirely. + * If a type is included but its value is undefined, the operation will search for that type in the Default namespace. + */ + typeToNamespacesMap?: Map; + /** An optional ES preference value to be used for the query **/ + preference?: string; + /** + * Search against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}. + */ + pit?: SavedObjectsPitParams; +} + +/** + * + * @public + */ +export interface SavedObjectsFindResult extends SavedObject { + /** + * The Elasticsearch `_score` of this result. + */ + score: number; + /** + * The Elasticsearch `sort` value of this result. + * + * @remarks + * This can be passed directly to the `searchAfter` param in the {@link SavedObjectsFindOptions} + * in order to page through large numbers of hits. It is recommended you use this alongside + * a Point In Time (PIT) that was opened with {@link SavedObjectsClient.openPointInTimeForType}. + * + * @example + * ```ts + * const { id } = await savedObjectsClient.openPointInTimeForType('visualization'); + * const page1 = await savedObjectsClient.find({ + * type: 'visualization', + * sortField: 'updated_at', + * sortOrder: 'asc', + * pit: { id }, + * }); + * const lastHit = page1.saved_objects[page1.saved_objects.length - 1]; + * const page2 = await savedObjectsClient.find({ + * type: 'visualization', + * sortField: 'updated_at', + * sortOrder: 'asc', + * pit: { id: page1.pit_id }, + * searchAfter: lastHit.sort, + * }); + * await savedObjectsClient.closePointInTime(page2.pit_id); + * ``` + */ + sort?: string[]; +} + +/** + * Return type of the Saved Objects `find()` method. + * + * *Note*: this type is different between the Public and Server Saved Objects + * clients. + * + * @public + */ +export interface SavedObjectsFindResponse { + aggregations?: A; + saved_objects: Array>; + total: number; + per_page: number; + page: number; + pit_id?: string; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/increment_counter.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/increment_counter.ts new file mode 100644 index 0000000000000..8a87bb7b38b06 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/increment_counter.ts @@ -0,0 +1,43 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectsMigrationVersion } from '@kbn/core-saved-objects-common'; +import type { MutatingOperationRefreshSetting, SavedObjectsBaseOptions } from './base'; + +/** + * @public + */ +export interface SavedObjectsIncrementCounterOptions + extends SavedObjectsBaseOptions { + /** + * (default=false) If true, sets all the counter fields to 0 if they don't + * already exist. Existing fields will be left as-is and won't be incremented. + */ + initialize?: boolean; + /** {@link SavedObjectsMigrationVersion} */ + migrationVersion?: SavedObjectsMigrationVersion; + /** + * (default='wait_for') The Elasticsearch refresh setting for this + * operation. See {@link MutatingOperationRefreshSetting} + */ + refresh?: MutatingOperationRefreshSetting; + /** + * Attributes to use when upserting the document if it doesn't exist. + */ + upsertAttributes?: Attributes; +} + +/** + * @public + */ +export interface SavedObjectsIncrementCounterField { + /** The field name to increment the counter by.*/ + fieldName: string; + /** The number to increment the field by (defaults to 1).*/ + incrementBy?: number; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/index.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/index.ts new file mode 100644 index 0000000000000..53457c98f20f6 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/index.ts @@ -0,0 +1,73 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type { + SavedObjectsBaseOptions, + MutatingOperationRefreshSetting, + SavedObjectsBulkResponse, +} from './base'; +export type { SavedObjectsBulkCreateObject } from './bulk_create'; +export type { SavedObjectsBulkGetObject } from './bulk_get'; +export type { + SavedObjectsBulkResolveObject, + SavedObjectsBulkResolveResponse, +} from './bulk_resolve'; +export type { + SavedObjectsBulkUpdateObject, + SavedObjectsBulkUpdateResponse, + SavedObjectsBulkUpdateOptions, +} from './bulk_update'; +export type { + SavedObjectsCheckConflictsObject, + SavedObjectsCheckConflictsResponse, +} from './check_conflicts'; +export type { + SavedObjectsClosePointInTimeOptions, + SavedObjectsClosePointInTimeResponse, +} from './close_point_in_time'; +export type { + SavedObjectsCollectMultiNamespaceReferencesObject, + SavedObjectReferenceWithContext, + SavedObjectsCollectMultiNamespaceReferencesResponse, + SavedObjectsCollectMultiNamespaceReferencesOptions, +} from './collect_multinamespace_references'; +export type { SavedObjectsCreateOptions } from './create'; +export type { + SavedObjectsCreatePointInTimeFinderOptions, + SavedObjectsCreatePointInTimeFinderDependencies, + ISavedObjectsPointInTimeFinder, +} from './create_point_in_time_finder'; +export type { SavedObjectsDeleteOptions } from './delete'; +export type { SavedObjectsDeleteByNamespaceOptions } from './delete_by_namespace'; +export type { + SavedObjectsFindOptions, + SavedObjectsFindOptionsReference, + SavedObjectsFindResponse, + SavedObjectsFindResult, + SavedObjectsPitParams, +} from './find'; +export type { + SavedObjectsIncrementCounterField, + SavedObjectsIncrementCounterOptions, +} from './increment_counter'; +export type { + SavedObjectsOpenPointInTimeOptions, + SavedObjectsOpenPointInTimeResponse, +} from './open_point_in_time_for_type'; +export type { + SavedObjectsRemoveReferencesToOptions, + SavedObjectsRemoveReferencesToResponse, +} from './remove_references_to'; +export type { SavedObjectsResolveResponse } from './resolve'; +export type { SavedObjectsUpdateResponse, SavedObjectsUpdateOptions } from './update'; +export type { + SavedObjectsUpdateObjectsSpacesObject, + SavedObjectsUpdateObjectsSpacesResponse, + SavedObjectsUpdateObjectsSpacesOptions, + SavedObjectsUpdateObjectsSpacesResponseObject, +} from './update_objects_spaces'; diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/open_point_in_time_for_type.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/open_point_in_time_for_type.ts new file mode 100644 index 0000000000000..ad9a2face8b06 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/open_point_in_time_for_type.ts @@ -0,0 +1,40 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +/** + * @public + */ +export interface SavedObjectsOpenPointInTimeOptions { + /** + * Optionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`. + */ + keepAlive?: string; + /** + * An optional ES preference value to be used for the query. + */ + preference?: string; + /** + * An optional list of namespaces to be used when opening the PIT. + * + * When the spaces plugin is enabled: + * - this will default to the user's current space (as determined by the URL) + * - if specified, the user's current space will be ignored + * - `['*']` will search across all available spaces + */ + namespaces?: string[]; +} + +/** + * @public + */ +export interface SavedObjectsOpenPointInTimeResponse { + /** + * PIT ID returned from ES. + */ + id: string; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/remove_references_to.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/remove_references_to.ts new file mode 100644 index 0000000000000..4e5be5fda67f2 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/remove_references_to.ts @@ -0,0 +1,27 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectsBaseOptions } from './base'; + +/** + * + * @public + */ +export interface SavedObjectsRemoveReferencesToOptions extends SavedObjectsBaseOptions { + /** The Elasticsearch Refresh setting for this operation. Defaults to `true` */ + refresh?: boolean; +} + +/** + * + * @public + */ +export interface SavedObjectsRemoveReferencesToResponse extends SavedObjectsBaseOptions { + /** The number of objects that have been updated by this operation */ + updated: number; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/resolve.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/resolve.ts new file mode 100644 index 0000000000000..9e764053392a5 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/resolve.ts @@ -0,0 +1,45 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObject } from '@kbn/core-saved-objects-common'; + +/** + * + * @public + */ +export interface SavedObjectsResolveResponse { + /** + * The saved object that was found. + */ + saved_object: SavedObject; + /** + * The outcome for a successful `resolve` call is one of the following values: + * + * * `'exactMatch'` -- One document exactly matched the given ID. + * * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different + * than the given ID. + * * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the + * `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID. + */ + outcome: 'exactMatch' | 'aliasMatch' | 'conflict'; + /** + * The ID of the object that the legacy URL alias points to. + * + * **Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). + */ + alias_target_id?: string; + /** + * The reason this alias was created. + * + * Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias + * was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL. + * + * **Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). + */ + alias_purpose?: 'savedObjectConversion' | 'savedObjectImport'; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/update.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/update.ts new file mode 100644 index 0000000000000..31bac37b94fff --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/update.ts @@ -0,0 +1,43 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectReference, SavedObject } from '@kbn/core-saved-objects-common'; +import type { MutatingOperationRefreshSetting, SavedObjectsBaseOptions } from './base'; + +/** + * + * @public + */ +export interface SavedObjectsUpdateOptions extends SavedObjectsBaseOptions { + /** + * An opaque version number which changes on each successful write operation. + * Can be used for implementing optimistic concurrency control. + */ + version?: string; + /** {@inheritdoc SavedObjectReference} */ + references?: SavedObjectReference[]; + /** The Elasticsearch Refresh setting for this operation */ + refresh?: MutatingOperationRefreshSetting; + /** If specified, will be used to perform an upsert if the document doesn't exist */ + upsert?: Attributes; + /** + * The Elasticsearch `retry_on_conflict` setting for this operation. + * Defaults to `0` when `version` is provided, `3` otherwise. + */ + retryOnConflict?: number; +} + +/** + * + * @public + */ +export interface SavedObjectsUpdateResponse + extends Omit, 'attributes' | 'references'> { + attributes: Partial; + references: SavedObjectReference[] | undefined; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts new file mode 100644 index 0000000000000..148d3480f2975 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/apis/update_objects_spaces.ts @@ -0,0 +1,69 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObjectError } from '@kbn/core-saved-objects-common'; +import type { MutatingOperationRefreshSetting, SavedObjectsBaseOptions } from './base'; + +/** + * An object that should have its spaces updated. + * + * @public + */ +export interface SavedObjectsUpdateObjectsSpacesObject { + /** The type of the object to update */ + id: string; + /** The ID of the object to update */ + type: string; + /** + * The space(s) that the object to update currently exists in. This is only intended to be used by SOC wrappers. + * + * @internal + */ + spaces?: string[]; + /** + * The version of the object to update; this is used for optimistic concurrency control. This is only intended to be used by SOC wrappers. + * + * @internal + */ + version?: string; +} + +/** + * Options for the update operation. + * + * @public + */ +export interface SavedObjectsUpdateObjectsSpacesOptions extends SavedObjectsBaseOptions { + /** The Elasticsearch Refresh setting for this operation */ + refresh?: MutatingOperationRefreshSetting; +} + +/** + * The response when objects' spaces are updated. + * + * @public + */ +export interface SavedObjectsUpdateObjectsSpacesResponse { + objects: SavedObjectsUpdateObjectsSpacesResponseObject[]; +} + +/** + * Details about a specific object's update result. + * + * @public + */ +export interface SavedObjectsUpdateObjectsSpacesResponseObject { + /** The type of the referenced object */ + type: string; + /** The ID of the referenced object */ + id: string; + /** The space(s) that the referenced object exists in */ + spaces: string[]; + /** Included if there was an error updating this object's spaces */ + error?: SavedObjectError; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/index.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/index.ts new file mode 100644 index 0000000000000..f10ee8e548819 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/index.ts @@ -0,0 +1,54 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type { SavedObjectsClientContract } from './saved_objects_client'; +export type { ISavedObjectsRepository } from './saved_objects_repository'; +export type { + MutatingOperationRefreshSetting, + SavedObjectsBaseOptions, + SavedObjectsIncrementCounterOptions, + SavedObjectsDeleteByNamespaceOptions, + SavedObjectsBulkResponse, + SavedObjectsUpdateResponse, + SavedObjectsBulkGetObject, + SavedObjectsBulkResolveObject, + SavedObjectsIncrementCounterField, + SavedObjectsBulkCreateObject, + SavedObjectsBulkResolveResponse, + SavedObjectsCreateOptions, + SavedObjectsFindResponse, + SavedObjectsBulkUpdateResponse, + SavedObjectsUpdateObjectsSpacesResponse, + SavedObjectsUpdateObjectsSpacesOptions, + SavedObjectsCollectMultiNamespaceReferencesOptions, + SavedObjectsCollectMultiNamespaceReferencesResponse, + SavedObjectsRemoveReferencesToResponse, + SavedObjectsCheckConflictsObject, + SavedObjectsCheckConflictsResponse, + SavedObjectsBulkUpdateOptions, + SavedObjectsFindOptionsReference, + SavedObjectsFindResult, + SavedObjectsRemoveReferencesToOptions, + SavedObjectsDeleteOptions, + SavedObjectsOpenPointInTimeResponse, + SavedObjectsBulkUpdateObject, + SavedObjectsClosePointInTimeResponse, + ISavedObjectsPointInTimeFinder, + SavedObjectsCreatePointInTimeFinderDependencies, + SavedObjectsPitParams, + SavedObjectsResolveResponse, + SavedObjectsCollectMultiNamespaceReferencesObject, + SavedObjectsUpdateObjectsSpacesResponseObject, + SavedObjectsUpdateObjectsSpacesObject, + SavedObjectReferenceWithContext, + SavedObjectsUpdateOptions, + SavedObjectsOpenPointInTimeOptions, + SavedObjectsClosePointInTimeOptions, + SavedObjectsCreatePointInTimeFinderOptions, + SavedObjectsFindOptions, +} from './apis'; diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts new file mode 100644 index 0000000000000..82808e4024c73 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_client.ts @@ -0,0 +1,359 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObject } from '@kbn/core-saved-objects-common'; +import type { + SavedObjectsBaseOptions, + SavedObjectsFindOptions, + SavedObjectsClosePointInTimeOptions, + SavedObjectsOpenPointInTimeOptions, + SavedObjectsCreatePointInTimeFinderOptions, + SavedObjectsUpdateOptions, + SavedObjectsUpdateResponse, + SavedObjectsUpdateObjectsSpacesObject, + SavedObjectsUpdateObjectsSpacesOptions, + SavedObjectsCollectMultiNamespaceReferencesObject, + SavedObjectsUpdateObjectsSpacesResponse, + SavedObjectsResolveResponse, + ISavedObjectsPointInTimeFinder, + SavedObjectsRemoveReferencesToOptions, + SavedObjectsClosePointInTimeResponse, + SavedObjectsDeleteOptions, + SavedObjectsCreatePointInTimeFinderDependencies, + SavedObjectsCheckConflictsResponse, + SavedObjectsBulkUpdateOptions, + SavedObjectsCollectMultiNamespaceReferencesResponse, + SavedObjectsBulkUpdateResponse, + SavedObjectsFindResponse, + SavedObjectsCreateOptions, + SavedObjectsCheckConflictsObject, + SavedObjectsBulkUpdateObject, + SavedObjectsBulkResolveResponse, + SavedObjectsBulkResolveObject, + SavedObjectsBulkGetObject, + SavedObjectsBulkCreateObject, + SavedObjectsOpenPointInTimeResponse, + SavedObjectsRemoveReferencesToResponse, + SavedObjectsCollectMultiNamespaceReferencesOptions, + SavedObjectsBulkResponse, +} from './apis'; + +/** + * Saved Objects is Kibana's data persisentence mechanism allowing plugins to + * use Elasticsearch for storing plugin state. + * + * ## SavedObjectsClient errors + * + * Since the SavedObjectsClient has its hands in everything we + * are a little paranoid about the way we present errors back to + * to application code. Ideally, all errors will be either: + * + * 1. Caused by bad implementation (ie. undefined is not a function) and + * as such unpredictable + * 2. An error that has been classified and decorated appropriately + * by the decorators in {@link SavedObjectsErrorHelpers} + * + * Type 1 errors are inevitable, but since all expected/handle-able errors + * should be Type 2 the `isXYZError()` helpers exposed at + * `SavedObjectsErrorHelpers` should be used to understand and manage error + * responses from the `SavedObjectsClient`. + * + * Type 2 errors are decorated versions of the source error, so if + * the elasticsearch client threw an error it will be decorated based + * on its type. That means that rather than looking for `error.body.error.type` or + * doing substring checks on `error.body.error.reason`, just use the helpers to + * understand the meaning of the error: + * + * ```js + * if (SavedObjectsErrorHelpers.isNotFoundError(error)) { + * // handle 404 + * } + * + * if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { + * // 401 handling should be automatic, but in case you wanted to know + * } + * + * // always rethrow the error unless you handle it + * throw error; + * ``` + * + * ### 404s from missing index + * + * From the perspective of application code and APIs the SavedObjectsClient is + * a black box that persists objects. One of the internal details that users have + * no control over is that we use an elasticsearch index for persistence and that + * index might be missing. + * + * At the time of writing we are in the process of transitioning away from the + * operating assumption that the SavedObjects index is always available. Part of + * this transition is handling errors resulting from an index missing. These used + * to trigger a 500 error in most cases, and in others cause 404s with different + * error messages. + * + * From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The + * object the request/call was targeting could not be found. This is why #14141 + * takes special care to ensure that 404 errors are generic and don't distinguish + * between index missing or document missing. + * + * See {@link SavedObjectsClient} + * See {@link SavedObjectsErrorHelpers} + * + * @public + */ +export interface SavedObjectsClientContract { + /** + * Persists a SavedObject + * + * @param type + * @param attributes + * @param options + */ + create( + type: string, + attributes: T, + options?: SavedObjectsCreateOptions + ): Promise>; + + /** + * Persists multiple documents batched together as a single request + * + * @param objects + * @param options + */ + bulkCreate( + objects: Array>, + options?: SavedObjectsCreateOptions + ): Promise>; + + /** + * Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are + * multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. + * + * @param objects + * @param options + */ + checkConflicts( + objects: SavedObjectsCheckConflictsObject[], + options?: SavedObjectsBaseOptions + ): Promise; + + /** + * Deletes a SavedObject + * + * @param type + * @param id + * @param options + */ + delete(type: string, id: string, options?: SavedObjectsDeleteOptions): Promise<{}>; + + /** + * Find all SavedObjects matching the search query + * + * @param options + */ + find( + options: SavedObjectsFindOptions + ): Promise>; + + /** + * Returns an array of objects by id + * + * @param objects - an array of ids, or an array of objects containing id, type and optionally fields + * @example + * + * bulkGet([ + * { id: 'one', type: 'config' }, + * { id: 'foo', type: 'index-pattern' } + * ]) + */ + bulkGet( + objects: SavedObjectsBulkGetObject[], + options?: SavedObjectsBaseOptions + ): Promise>; + + /** + * Retrieves a single object + * + * @param type - The type of SavedObject to retrieve + * @param id - The ID of the SavedObject to retrieve + * @param options + */ + get( + type: string, + id: string, + options?: SavedObjectsBaseOptions + ): Promise>; + + /** + * Resolves an array of objects by id, using any legacy URL aliases if they exist + * + * @param objects - an array of objects containing id, type + * @example + * + * bulkResolve([ + * { id: 'one', type: 'config' }, + * { id: 'foo', type: 'index-pattern' } + * ]) + * + * @note Saved objects that Kibana fails to find are replaced with an error object and an "exactMatch" outcome. The rationale behind the + * outcome is that "exactMatch" is the default outcome, and the outcome only changes if an alias is found. This behavior is unique to + * `bulkResolve`; the regular `resolve` API will throw an error instead. + */ + bulkResolve( + objects: SavedObjectsBulkResolveObject[], + options?: SavedObjectsBaseOptions + ): Promise>; + + /** + * Resolves a single object, using any legacy URL alias if it exists + * + * @param type - The type of SavedObject to retrieve + * @param id - The ID of the SavedObject to retrieve + * @param options + */ + resolve( + type: string, + id: string, + options?: SavedObjectsBaseOptions + ): Promise>; + + /** + * Updates an SavedObject + * + * @param type + * @param id + * @param options + */ + update( + type: string, + id: string, + attributes: Partial, + options?: SavedObjectsUpdateOptions + ): Promise>; + + /** + * Bulk Updates multiple SavedObject at once + * + * @param objects + */ + bulkUpdate( + objects: Array>, + options?: SavedObjectsBulkUpdateOptions + ): Promise>; + + /** + * Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. + */ + removeReferencesTo( + type: string, + id: string, + options?: SavedObjectsRemoveReferencesToOptions + ): Promise; + + /** + * Opens a Point In Time (PIT) against the indices for the specified Saved Object types. + * The returned `id` can then be passed to {@link SavedObjectsClient.find} to search + * against that PIT. + * + * Only use this API if you have an advanced use case that's not solved by the + * {@link SavedObjectsClient.createPointInTimeFinder} method. + */ + openPointInTimeForType( + type: string | string[], + options?: SavedObjectsOpenPointInTimeOptions + ): Promise; + + /** + * Closes a Point In Time (PIT) by ID. This simply proxies the request to ES via the + * Elasticsearch client, and is included in the Saved Objects Client as a convenience + * for consumers who are using {@link SavedObjectsClient.openPointInTimeForType}. + * + * Only use this API if you have an advanced use case that's not solved by the + * {@link SavedObjectsClient.createPointInTimeFinder} method. + */ + closePointInTime( + id: string, + options?: SavedObjectsClosePointInTimeOptions + ): Promise; + + /** + * Returns a {@link ISavedObjectsPointInTimeFinder} to help page through + * large sets of saved objects. We strongly recommend using this API for + * any `find` queries that might return more than 1000 saved objects, + * however this API is only intended for use in server-side "batch" + * processing of objects where you are collecting all objects in memory + * or streaming them back to the client. + * + * Do NOT use this API in a route handler to facilitate paging through + * saved objects on the client-side unless you are streaming all of the + * results back to the client at once. Because the returned generator is + * stateful, you cannot rely on subsequent http requests retrieving new + * pages from the same Kibana server in multi-instance deployments. + * + * The generator wraps calls to {@link SavedObjectsClient.find} and iterates + * over multiple pages of results using `_pit` and `search_after`. This will + * open a new Point-In-Time (PIT), and continue paging until a set of + * results is received that's smaller than the designated `perPage`. + * + * Once you have retrieved all of the results you need, it is recommended + * to call `close()` to clean up the PIT and prevent Elasticsearch from + * consuming resources unnecessarily. This is only required if you are + * done iterating and have not yet paged through all of the results: the + * PIT will automatically be closed for you once you reach the last page + * of results, or if the underlying call to `find` fails for any reason. + * + * @example + * ```ts + * const findOptions: SavedObjectsCreatePointInTimeFinderOptions = { + * type: 'visualization', + * search: 'foo*', + * perPage: 100, + * }; + * + * const finder = savedObjectsClient.createPointInTimeFinder(findOptions); + * + * const responses: SavedObjectFindResponse[] = []; + * for await (const response of finder.find()) { + * responses.push(...response); + * if (doneSearching) { + * await finder.close(); + * } + * } + * ``` + */ + createPointInTimeFinder( + findOptions: SavedObjectsCreatePointInTimeFinderOptions, + dependencies?: SavedObjectsCreatePointInTimeFinderDependencies + ): ISavedObjectsPointInTimeFinder; + + /** + * Gets all references and transitive references of the listed objects. Ignores any object that is not a multi-namespace type. + * + * @param objects + * @param options + */ + collectMultiNamespaceReferences( + objects: SavedObjectsCollectMultiNamespaceReferencesObject[], + options?: SavedObjectsCollectMultiNamespaceReferencesOptions + ): Promise; + + /** + * Updates one or more objects to add and/or remove them from specified spaces. + * + * @param objects + * @param spacesToAdd + * @param spacesToRemove + * @param options + */ + updateObjectsSpaces( + objects: SavedObjectsUpdateObjectsSpacesObject[], + spacesToAdd: string[], + spacesToRemove: string[], + options?: SavedObjectsUpdateObjectsSpacesOptions + ): Promise; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts b/packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts new file mode 100644 index 0000000000000..102afce9dd73d --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/src/saved_objects_repository.ts @@ -0,0 +1,476 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { SavedObject } from '@kbn/core-saved-objects-common'; +import type { + SavedObjectsBaseOptions, + SavedObjectsFindOptions, + SavedObjectsClosePointInTimeOptions, + SavedObjectsOpenPointInTimeOptions, + SavedObjectsCreatePointInTimeFinderOptions, + SavedObjectsUpdateOptions, + SavedObjectsUpdateResponse, + SavedObjectsUpdateObjectsSpacesObject, + SavedObjectsUpdateObjectsSpacesOptions, + SavedObjectsCollectMultiNamespaceReferencesObject, + SavedObjectsUpdateObjectsSpacesResponse, + SavedObjectsResolveResponse, + ISavedObjectsPointInTimeFinder, + SavedObjectsRemoveReferencesToOptions, + SavedObjectsClosePointInTimeResponse, + SavedObjectsDeleteOptions, + SavedObjectsCreatePointInTimeFinderDependencies, + SavedObjectsCheckConflictsResponse, + SavedObjectsBulkUpdateOptions, + SavedObjectsCollectMultiNamespaceReferencesResponse, + SavedObjectsBulkUpdateResponse, + SavedObjectsFindResponse, + SavedObjectsCreateOptions, + SavedObjectsCheckConflictsObject, + SavedObjectsBulkUpdateObject, + SavedObjectsBulkResolveResponse, + SavedObjectsBulkResolveObject, + SavedObjectsBulkGetObject, + SavedObjectsBulkCreateObject, + SavedObjectsOpenPointInTimeResponse, + SavedObjectsRemoveReferencesToResponse, + SavedObjectsCollectMultiNamespaceReferencesOptions, + SavedObjectsBulkResponse, + SavedObjectsDeleteByNamespaceOptions, + SavedObjectsIncrementCounterField, + SavedObjectsIncrementCounterOptions, +} from './apis'; + +/** + * The savedObjects repository contract. + * + * @public + */ +export interface ISavedObjectsRepository { + /** + * Persists an object + * + * @param {string} type + * @param {object} attributes + * @param {object} [options={}] + * @property {string} [options.id] - force id on creation, not recommended + * @property {boolean} [options.overwrite=false] + * @property {object} [options.migrationVersion=undefined] + * @property {string} [options.namespace] + * @property {array} [options.references=[]] - [{ name, type, id }] + * @returns {promise} - { id, type, version, attributes } + */ + create( + type: string, + attributes: T, + options?: SavedObjectsCreateOptions + ): Promise>; + + /** + * Creates multiple documents at once + * + * @param {array} objects - [{ type, id, attributes, references, migrationVersion }] + * @param {object} [options={}] + * @property {boolean} [options.overwrite=false] - overwrites existing documents + * @property {string} [options.namespace] + * @returns {promise} - {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]} + */ + bulkCreate( + objects: Array>, + options?: SavedObjectsCreateOptions + ): Promise>; + + /** + * Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are + * multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. + */ + checkConflicts( + objects: SavedObjectsCheckConflictsObject[], + options?: SavedObjectsBaseOptions + ): Promise; + + /** + * Deletes an object + * + * @param {string} type + * @param {string} id + * @param {object} [options={}] + * @property {string} [options.namespace] + * @returns {promise} + */ + delete(type: string, id: string, options?: SavedObjectsDeleteOptions): Promise<{}>; + + /** + * Deletes all objects from the provided namespace. + * + * @param {string} namespace + * @returns {promise} - { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures } + */ + deleteByNamespace( + namespace: string, + options?: SavedObjectsDeleteByNamespaceOptions + ): Promise; + + /** + * @param {object} [options={}] + * @property {(string|Array)} [options.type] + * @property {string} [options.search] + * @property {string} [options.defaultSearchOperator] + * @property {Array} [options.searchFields] - see Elasticsearch Simple Query String + * Query field argument for more information + * @property {integer} [options.page=1] + * @property {integer} [options.perPage=20] + * @property {Array} [options.searchAfter] + * @property {string} [options.sortField] + * @property {string} [options.sortOrder] + * @property {Array} [options.fields] + * @property {string} [options.namespace] + * @property {object} [options.hasReference] - { type, id } + * @property {string} [options.pit] + * @property {string} [options.preference] + * @returns {promise} - { saved_objects: [{ id, type, version, attributes }], total, per_page, page } + */ + find( + options: SavedObjectsFindOptions + ): Promise>; + + /** + * Returns an array of objects by id + * + * @param {array} objects - an array of objects containing id, type and optionally fields + * @param {object} [options={}] + * @property {string} [options.namespace] + * @returns {promise} - { saved_objects: [{ id, type, version, attributes }] } + * @example + * + * bulkGet([ + * { id: 'one', type: 'config' }, + * { id: 'foo', type: 'index-pattern' } + * ]) + */ + bulkGet( + objects: SavedObjectsBulkGetObject[], + options?: SavedObjectsBaseOptions + ): Promise>; + + /** + * Resolves an array of objects by id, using any legacy URL aliases if they exist + * + * @param {array} objects - an array of objects containing id, type + * @param {object} [options={}] + * @property {string} [options.namespace] + * @returns {promise} - { resolved_objects: [{ saved_object, outcome }] } + * @example + * + * bulkResolve([ + * { id: 'one', type: 'config' }, + * { id: 'foo', type: 'index-pattern' } + * ]) + */ + bulkResolve( + objects: SavedObjectsBulkResolveObject[], + options?: SavedObjectsBaseOptions + ): Promise>; + + /** + * Gets a single object + * + * @param {string} type + * @param {string} id + * @param {object} [options={}] + * @property {string} [options.namespace] + * @returns {promise} - { id, type, version, attributes } + */ + get( + type: string, + id: string, + options?: SavedObjectsBaseOptions + ): Promise>; + + /** + * Resolves a single object, using any legacy URL alias if it exists + * + * @param {string} type + * @param {string} id + * @param {object} [options={}] + * @property {string} [options.namespace] + * @returns {promise} - { saved_object, outcome } + */ + resolve( + type: string, + id: string, + options?: SavedObjectsBaseOptions + ): Promise>; + + /** + * Updates an object + * + * @param {string} type + * @param {string} id + * @param {object} [options={}] + * @property {string} options.version - ensures version matches that of persisted object + * @property {string} [options.namespace] + * @property {array} [options.references] - [{ name, type, id }] + * @returns {promise} + */ + update( + type: string, + id: string, + attributes: Partial, + options?: SavedObjectsUpdateOptions + ): Promise>; + + /** + * Gets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace + * type. + * + * @param objects The objects to get the references for. + */ + collectMultiNamespaceReferences( + objects: SavedObjectsCollectMultiNamespaceReferencesObject[], + options?: SavedObjectsCollectMultiNamespaceReferencesOptions + ): Promise; + + /** + * Updates one or more objects to add and/or remove them from specified spaces. + * + * @param objects + * @param spacesToAdd + * @param spacesToRemove + * @param options + */ + updateObjectsSpaces( + objects: SavedObjectsUpdateObjectsSpacesObject[], + spacesToAdd: string[], + spacesToRemove: string[], + options?: SavedObjectsUpdateObjectsSpacesOptions + ): Promise; + + /** + * Updates multiple objects in bulk + * + * @param {array} objects - [{ type, id, attributes, options: { version, namespace } references }] + * @property {string} options.version - ensures version matches that of persisted object + * @property {string} [options.namespace] + * @returns {promise} - {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]} + */ + bulkUpdate( + objects: Array>, + options?: SavedObjectsBulkUpdateOptions + ): Promise>; + + /** + * Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. + * + * @remarks Will throw a conflict error if the `update_by_query` operation returns any failure. In that case + * some references might have been removed, and some were not. It is the caller's responsibility + * to handle and fix this situation if it was to happen. + */ + removeReferencesTo( + type: string, + id: string, + options?: SavedObjectsRemoveReferencesToOptions + ): Promise; + + /** + * Increments all the specified counter fields (by one by default). Creates the document + * if one doesn't exist for the given id. + * + * @remarks + * When supplying a field name like `stats.api.counter` the field name will + * be used as-is to create a document like: + * `{attributes: {'stats.api.counter': 1}}` + * It will not create a nested structure like: + * `{attributes: {stats: {api: {counter: 1}}}}` + * + * When using incrementCounter for collecting usage data, you need to ensure + * that usage collection happens on a best-effort basis and doesn't + * negatively affect your plugin or users. See https://github.com/elastic/kibana/blob/main/src/plugins/usage_collection/README.mdx#tracking-interactions-with-incrementcounter) + * + * @example + * ```ts + * const repository = coreStart.savedObjects.createInternalRepository(); + * + * // Initialize all fields to 0 + * repository + * .incrementCounter('dashboard_counter_type', 'counter_id', [ + * 'stats.apiCalls', + * 'stats.sampleDataInstalled', + * ], {initialize: true}); + * + * // Increment the apiCalls field counter + * repository + * .incrementCounter('dashboard_counter_type', 'counter_id', [ + * 'stats.apiCalls', + * ]) + * + * // Increment the apiCalls field counter by 4 + * repository + * .incrementCounter('dashboard_counter_type', 'counter_id', [ + * { fieldName: 'stats.apiCalls' incrementBy: 4 }, + * ]) + * + * // Initialize the document with arbitrary fields if not present + * repository.incrementCounter<{ appId: string }>( + * 'dashboard_counter_type', + * 'counter_id', + * [ 'stats.apiCalls'], + * { upsertAttributes: { appId: 'myId' } } + * ) + * ``` + * + * @param type - The type of saved object whose fields should be incremented + * @param id - The id of the document whose fields should be incremented + * @param counterFields - An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField} + * @param options - {@link SavedObjectsIncrementCounterOptions} + * @returns The saved object after the specified fields were incremented + */ + incrementCounter( + type: string, + id: string, + counterFields: Array, + options?: SavedObjectsIncrementCounterOptions + ): Promise>; + + /** + * Opens a Point In Time (PIT) against the indices for the specified Saved Object types. + * The returned `id` can then be passed to `SavedObjects.find` to search against that PIT. + * + * Only use this API if you have an advanced use case that's not solved by the + * {@link SavedObjectsRepository.createPointInTimeFinder} method. + * + * @example + * ```ts + * const { id } = await savedObjectsClient.openPointInTimeForType( + * type: 'visualization', + * { keepAlive: '5m' }, + * ); + * const page1 = await savedObjectsClient.find({ + * type: 'visualization', + * sortField: 'updated_at', + * sortOrder: 'asc', + * pit: { id, keepAlive: '2m' }, + * }); + * const lastHit = page1.saved_objects[page1.saved_objects.length - 1]; + * const page2 = await savedObjectsClient.find({ + * type: 'visualization', + * sortField: 'updated_at', + * sortOrder: 'asc', + * pit: { id: page1.pit_id }, + * searchAfter: lastHit.sort, + * }); + * await savedObjectsClient.closePointInTime(page2.pit_id); + * ``` + * + * @param {string|Array} type + * @param {object} [options] - {@link SavedObjectsOpenPointInTimeOptions} + * @property {string} [options.keepAlive] + * @property {string} [options.preference] + * @returns {promise} - { id: string } + */ + openPointInTimeForType( + type: string | string[], + options?: SavedObjectsOpenPointInTimeOptions + ): Promise; + + /** + * Closes a Point In Time (PIT) by ID. This simply proxies the request to ES + * via the Elasticsearch client, and is included in the Saved Objects Client + * as a convenience for consumers who are using `openPointInTimeForType`. + * + * Only use this API if you have an advanced use case that's not solved by the + * {@link SavedObjectsRepository.createPointInTimeFinder} method. + * + * @remarks + * While the `keepAlive` that is provided will cause a PIT to automatically close, + * it is highly recommended to explicitly close a PIT when you are done with it + * in order to avoid consuming unneeded resources in Elasticsearch. + * + * @example + * ```ts + * const repository = coreStart.savedObjects.createInternalRepository(); + * + * const { id } = await repository.openPointInTimeForType( + * type: 'index-pattern', + * { keepAlive: '2m' }, + * ); + * + * const response = await repository.find({ + * type: 'index-pattern', + * search: 'foo*', + * sortField: 'name', + * sortOrder: 'desc', + * pit: { + * id: 'abc123', + * keepAlive: '2m', + * }, + * searchAfter: [1234, 'abcd'], + * }); + * + * await repository.closePointInTime(response.pit_id); + * ``` + * + * @param {string} id + * @param {object} [options] - {@link SavedObjectsClosePointInTimeOptions} + * @returns {promise} - {@link SavedObjectsClosePointInTimeResponse} + */ + closePointInTime( + id: string, + options?: SavedObjectsClosePointInTimeOptions + ): Promise; + + /** + * Returns a {@link ISavedObjectsPointInTimeFinder} to help page through + * large sets of saved objects. We strongly recommend using this API for + * any `find` queries that might return more than 1000 saved objects, + * however this API is only intended for use in server-side "batch" + * processing of objects where you are collecting all objects in memory + * or streaming them back to the client. + * + * Do NOT use this API in a route handler to facilitate paging through + * saved objects on the client-side unless you are streaming all of the + * results back to the client at once. Because the returned generator is + * stateful, you cannot rely on subsequent http requests retrieving new + * pages from the same Kibana server in multi-instance deployments. + * + * This generator wraps calls to {@link SavedObjectsRepository.find} and + * iterates over multiple pages of results using `_pit` and `search_after`. + * This will open a new Point-In-Time (PIT), and continue paging until a + * set of results is received that's smaller than the designated `perPage`. + * + * Once you have retrieved all of the results you need, it is recommended + * to call `close()` to clean up the PIT and prevent Elasticsearch from + * consuming resources unnecessarily. This is only required if you are + * done iterating and have not yet paged through all of the results: the + * PIT will automatically be closed for you once you reach the last page + * of results, or if the underlying call to `find` fails for any reason. + * + * @example + * ```ts + * const findOptions: SavedObjectsCreatePointInTimeFinderOptions = { + * type: 'visualization', + * search: 'foo*', + * perPage: 100, + * }; + * + * const finder = savedObjectsClient.createPointInTimeFinder(findOptions); + * + * const responses: SavedObjectFindResponse[] = []; + * for await (const response of finder.find()) { + * responses.push(...response); + * if (doneSearching) { + * await finder.close(); + * } + * } + * ``` + */ + createPointInTimeFinder( + findOptions: SavedObjectsCreatePointInTimeFinderOptions, + dependencies?: SavedObjectsCreatePointInTimeFinderDependencies + ): ISavedObjectsPointInTimeFinder; +} diff --git a/packages/core/saved-objects/core-saved-objects-api-server/tsconfig.json b/packages/core/saved-objects/core-saved-objects-api-server/tsconfig.json new file mode 100644 index 0000000000000..39d3c7097814a --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-api-server/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/core/saved-objects/core-saved-objects-common/BUILD.bazel b/packages/core/saved-objects/core-saved-objects-common/BUILD.bazel new file mode 100644 index 0000000000000..a83830f79b345 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-common/BUILD.bazel @@ -0,0 +1,106 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "core-saved-objects-common" +PKG_REQUIRE_NAME = "@kbn/core-saved-objects-common" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +RUNTIME_DEPS = [ + "@npm//react" +] + +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest" +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/core/saved-objects/core-saved-objects-common/README.md b/packages/core/saved-objects/core-saved-objects-common/README.md new file mode 100644 index 0000000000000..98319ddf05071 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-common/README.md @@ -0,0 +1,3 @@ +# @kbn/core-saved-objects-common + +This package contains the common types shared between the browser and server-side savedObjects APIs. diff --git a/packages/core/saved-objects/core-saved-objects-common/jest.config.js b/packages/core/saved-objects/core-saved-objects-common/jest.config.js new file mode 100644 index 0000000000000..9770705e1c49a --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-common/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../../..', + roots: ['/packages/core/saved-objects/core-saved-objects-common'], +}; diff --git a/packages/core/saved-objects/core-saved-objects-common/package.json b/packages/core/saved-objects/core-saved-objects-common/package.json new file mode 100644 index 0000000000000..b138bcd269def --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-common/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/core-saved-objects-common", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/core/saved-objects/core-saved-objects-common/src/index.ts b/packages/core/saved-objects/core-saved-objects-common/src/index.ts new file mode 100644 index 0000000000000..a04646e401b9b --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-common/src/index.ts @@ -0,0 +1,35 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type { + SavedObject, + SavedObjectsNamespaceType, + SavedObjectAttributeSingle, + SavedObjectAttribute, + SavedObjectAttributes, + SavedObjectError, + SavedObjectReference, + SavedObjectsMigrationVersion, +} from './saved_objects'; + +export type { + SavedObjectsImportResponse, + SavedObjectsImportSuccess, + SavedObjectsImportFailure, + SavedObjectsImportRetry, + SavedObjectsImportWarning, + SavedObjectsImportSimpleWarning, + SavedObjectsImportAmbiguousConflictError, + SavedObjectsImportUnsupportedTypeError, + SavedObjectsImportMissingReferencesError, + SavedObjectsImportUnknownError, + SavedObjectsImportActionRequiredWarning, + SavedObjectsImportConflictError, +} from './saved_objects_imports'; + +export type { SavedObjectTypeIdTuple } from './types'; diff --git a/src/core/types/saved_objects.ts b/packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts similarity index 76% rename from src/core/types/saved_objects.ts rename to packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts index 3a97c2fd6f010..2b8f6d66e67ac 100644 --- a/src/core/types/saved_objects.ts +++ b/packages/core/saved-objects/core-saved-objects-common/src/saved_objects.ts @@ -98,6 +98,20 @@ export interface SavedObject { originId?: string; } +/** + * The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: + * * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace. + * * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces. + * * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be + * unique across all namespaces. This is intended to be an intermediate step when objects with a "single" namespace type are being + * converted to a "multiple" namespace type. In other words, objects with a "multiple-isolated" namespace type will be *share-capable*, + * but will not actually be shareable until the namespace type is changed to "multiple". + * * agnostic: This type of saved object is global. + * + * @public + */ +export type SavedObjectsNamespaceType = 'single' | 'multiple' | 'multiple-isolated' | 'agnostic'; + export interface SavedObjectError { error: string; message: string; diff --git a/packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts b/packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts new file mode 100644 index 0000000000000..7d6700ed3b47c --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-common/src/saved_objects_imports.ts @@ -0,0 +1,181 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +/** + * Describes a retry operation for importing a saved object. + * @public + */ +export interface SavedObjectsImportRetry { + type: string; + id: string; + overwrite: boolean; + /** + * The object ID that will be created or overwritten. If not specified, the `id` field will be used. + */ + destinationId?: string; + replaceReferences: Array<{ + type: string; + from: string; + to: string; + }>; + /** + * If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where + * `createNewCopies` mode is disabled and ambiguous source conflicts are detected. + */ + createNewCopy?: boolean; + /** + * If `ignoreMissingReferences` is specified, reference validation will be skipped for this object. + */ + ignoreMissingReferences?: boolean; +} + +/** + * Represents a failure to import due to a conflict. + * @public + */ +export interface SavedObjectsImportConflictError { + type: 'conflict'; + destinationId?: string; +} + +/** + * Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite. + * @public + */ +export interface SavedObjectsImportAmbiguousConflictError { + type: 'ambiguous_conflict'; + destinations: Array<{ id: string; title?: string; updatedAt?: string }>; +} + +/** + * Represents a failure to import due to having an unsupported saved object type. + * @public + */ +export interface SavedObjectsImportUnsupportedTypeError { + type: 'unsupported_type'; +} + +/** + * Represents a failure to import due to an unknown reason. + * @public + */ +export interface SavedObjectsImportUnknownError { + type: 'unknown'; + message: string; + statusCode: number; +} + +/** + * Represents a failure to import due to missing references. + * @public + */ +export interface SavedObjectsImportMissingReferencesError { + type: 'missing_references'; + references: Array<{ type: string; id: string }>; +} + +/** + * Represents a failure to import. + * @public + */ +export interface SavedObjectsImportFailure { + id: string; + type: string; + meta: { title?: string; icon?: string }; + /** + * If `overwrite` is specified, an attempt was made to overwrite an existing object. + */ + overwrite?: boolean; + error: + | SavedObjectsImportConflictError + | SavedObjectsImportAmbiguousConflictError + | SavedObjectsImportUnsupportedTypeError + | SavedObjectsImportMissingReferencesError + | SavedObjectsImportUnknownError; +} + +/** + * Represents a successful import. + * @public + */ +export interface SavedObjectsImportSuccess { + id: string; + type: string; + /** + * If `destinationId` is specified, the new object has a new ID that is different from the import ID. + */ + destinationId?: string; + /** + * @deprecated Can be removed when https://github.com/elastic/kibana/issues/91615 is done. + * If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where + * `createNewCopies` mode is disabled and ambiguous source conflicts are detected. When `createNewCopies` mode is permanently enabled, + * this field will be redundant and can be removed. + */ + createNewCopy?: boolean; + meta: { + title?: string; + icon?: string; + }; + /** + * If `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution). + */ + overwrite?: boolean; +} + +/** + * A simple informative warning that will be displayed to the user. + * + * @public + */ +export interface SavedObjectsImportSimpleWarning { + type: 'simple'; + /** The translated message to display to the user */ + message: string; +} + +/** + * A warning meant to notify that a specific user action is required to finalize the import + * of some type of object. + * + * @remark The `actionUrl` must be a path relative to the basePath, and not include it. + * + * @public + */ +export interface SavedObjectsImportActionRequiredWarning { + type: 'action_required'; + /** The translated message to display to the user. */ + message: string; + /** The path (without the basePath) that the user should be redirect to address this warning. */ + actionPath: string; + /** An optional label to use for the link button. If unspecified, a default label will be used. */ + buttonLabel?: string; +} + +/** + * Composite type of all the possible types of import warnings. + * + * See {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning} + * for more details. + * + * @public + */ +export type SavedObjectsImportWarning = + | SavedObjectsImportSimpleWarning + | SavedObjectsImportActionRequiredWarning; + +/** + * The response describing the result of an import. + * @public + */ +export interface SavedObjectsImportResponse { + success: boolean; + successCount: number; + successResults?: SavedObjectsImportSuccess[]; + warnings: SavedObjectsImportWarning[]; + errors?: SavedObjectsImportFailure[]; +} diff --git a/packages/core/saved-objects/core-saved-objects-common/src/types.ts b/packages/core/saved-objects/core-saved-objects-common/src/types.ts new file mode 100644 index 0000000000000..102de1a4cfbb6 --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-common/src/types.ts @@ -0,0 +1,19 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +/** + * An identifier for a saved object within a space. + * + * @public + */ +export interface SavedObjectTypeIdTuple { + /** The id of the saved object */ + id: string; + /** The type of the saved object */ + type: string; +} diff --git a/packages/core/saved-objects/core-saved-objects-common/tsconfig.json b/packages/core/saved-objects/core-saved-objects-common/tsconfig.json new file mode 100644 index 0000000000000..39d3c7097814a --- /dev/null +++ b/packages/core/saved-objects/core-saved-objects-common/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/home/sample_data_cards/BUILD.bazel b/packages/home/sample_data_card/BUILD.bazel similarity index 92% rename from packages/home/sample_data_cards/BUILD.bazel rename to packages/home/sample_data_card/BUILD.bazel index 0e4a5950eb92d..4eb6cf255c2eb 100644 --- a/packages/home/sample_data_cards/BUILD.bazel +++ b/packages/home/sample_data_card/BUILD.bazel @@ -2,14 +2,16 @@ load("@npm//@bazel/typescript:index.bzl", "ts_config") load("@build_bazel_rules_nodejs//:index.bzl", "js_library") load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") -PKG_DIRNAME = "sample_data_cards" -PKG_REQUIRE_NAME = "@kbn/home-sample-data-cards" +PKG_DIRNAME = "sample_data_card" +PKG_REQUIRE_NAME = "@kbn/home-sample-data-card" SOURCE_FILES = glob( [ "src/**/*.ts", "src/**/*.tsx", "src/**/*.mdx", + "src/**/*.svg", + "src/**/*.png", ], exclude = [ "**/*.test.*", @@ -67,6 +69,7 @@ TYPES_DEPS = [ "@npm//@types/react", "//packages/kbn-ambient-ui-types", "//packages/kbn-i18n:npm_module_types", + "//packages/home/sample_data_types", ] jsts_transpiler( @@ -80,6 +83,10 @@ jsts_transpiler( srcs = SRCS, build_pkg_name = package_name(), web = True, + additional_args = [ + "--copy-files", + "--quiet" + ], ) ts_config( diff --git a/packages/home/sample_data_cards/README.mdx b/packages/home/sample_data_card/README.mdx similarity index 75% rename from packages/home/sample_data_cards/README.mdx rename to packages/home/sample_data_card/README.mdx index 4603d79e59016..5e2fa83830573 100644 --- a/packages/home/sample_data_cards/README.mdx +++ b/packages/home/sample_data_card/README.mdx @@ -13,10 +13,10 @@ This package contains a pair of components. The first displays a Sample Data Se | Export | Description | |---|---| -| `SampleDataCards` | Fetches and displays a grid of Sample Data Sets as `SampleDataCard` components. | +| `SampleDataCard` | Fetches and displays a grid of Sample Data Sets as `SampleDataCard` components. | | `SampleDataCard` | A card component representing a Sample Data Set, which can install, uninstall and navigate relevant objects from a Sample Data Set. | -| `SampleDataCardsProvider` | Provides contextual services to `KibanaNoDataPage`. | -| `SampleDataCardsKibanaProvider` | Maps Kibana dependencies to provide contextual services to `KibanaNoDataPage`. | +| `SampleDataCardProvider` | Provides contextual services to `KibanaNoDataPage`. | +| `SampleDataCardKibanaProvider` | Maps Kibana dependencies to provide contextual services to `KibanaNoDataPage`. | ## EUI Promotion Status diff --git a/packages/home/sample_data_cards/jest.config.js b/packages/home/sample_data_card/jest.config.js similarity index 88% rename from packages/home/sample_data_cards/jest.config.js rename to packages/home/sample_data_card/jest.config.js index 055b762722ccf..650c7361db333 100644 --- a/packages/home/sample_data_cards/jest.config.js +++ b/packages/home/sample_data_card/jest.config.js @@ -9,5 +9,5 @@ module.exports = { preset: '@kbn/test', rootDir: '../../..', - roots: ['/packages/home/sample_data_cards'], + roots: ['/packages/home/sample_data_card'], }; diff --git a/packages/home/sample_data_cards/package.json b/packages/home/sample_data_card/package.json similarity index 79% rename from packages/home/sample_data_cards/package.json rename to packages/home/sample_data_card/package.json index cf29ca9525d63..6eb1711b5052e 100644 --- a/packages/home/sample_data_cards/package.json +++ b/packages/home/sample_data_card/package.json @@ -1,8 +1,8 @@ { - "name": "@kbn/home-sample-data-cards", + "name": "@kbn/home-sample-data-card", "private": true, "version": "1.0.0", "main": "./target_node/index.js", "browser": "./target_web/index.js", "license": "SSPL-1.0 OR Elastic License 2.0" -} +} \ No newline at end of file diff --git a/packages/home/sample_data_cards/src/__snapshots__/sample_data_card.test.tsx.snap b/packages/home/sample_data_card/src/__snapshots__/sample_data_card.test.tsx.snap similarity index 100% rename from packages/home/sample_data_cards/src/__snapshots__/sample_data_card.test.tsx.snap rename to packages/home/sample_data_card/src/__snapshots__/sample_data_card.test.tsx.snap diff --git a/packages/home/sample_data_cards/src/constants.ts b/packages/home/sample_data_card/src/constants.ts similarity index 100% rename from packages/home/sample_data_cards/src/constants.ts rename to packages/home/sample_data_card/src/constants.ts diff --git a/packages/home/sample_data_cards/src/footer/__snapshots__/disabled_footer.test.tsx.snap b/packages/home/sample_data_card/src/footer/__snapshots__/disabled_footer.test.tsx.snap similarity index 100% rename from packages/home/sample_data_cards/src/footer/__snapshots__/disabled_footer.test.tsx.snap rename to packages/home/sample_data_card/src/footer/__snapshots__/disabled_footer.test.tsx.snap diff --git a/packages/home/sample_data_cards/src/footer/__snapshots__/install_footer.test.tsx.snap b/packages/home/sample_data_card/src/footer/__snapshots__/install_footer.test.tsx.snap similarity index 100% rename from packages/home/sample_data_cards/src/footer/__snapshots__/install_footer.test.tsx.snap rename to packages/home/sample_data_card/src/footer/__snapshots__/install_footer.test.tsx.snap diff --git a/packages/home/sample_data_cards/src/footer/__snapshots__/remove_footer.test.tsx.snap b/packages/home/sample_data_card/src/footer/__snapshots__/remove_footer.test.tsx.snap similarity index 100% rename from packages/home/sample_data_cards/src/footer/__snapshots__/remove_footer.test.tsx.snap rename to packages/home/sample_data_card/src/footer/__snapshots__/remove_footer.test.tsx.snap diff --git a/packages/home/sample_data_cards/src/footer/__snapshots__/view_button.test.tsx.snap b/packages/home/sample_data_card/src/footer/__snapshots__/view_button.test.tsx.snap similarity index 100% rename from packages/home/sample_data_cards/src/footer/__snapshots__/view_button.test.tsx.snap rename to packages/home/sample_data_card/src/footer/__snapshots__/view_button.test.tsx.snap diff --git a/packages/home/sample_data_cards/src/footer/disabled_footer.test.tsx b/packages/home/sample_data_card/src/footer/disabled_footer.test.tsx similarity index 86% rename from packages/home/sample_data_cards/src/footer/disabled_footer.test.tsx rename to packages/home/sample_data_card/src/footer/disabled_footer.test.tsx index 579ea9b8a5c0f..b1ec8736bf53a 100644 --- a/packages/home/sample_data_cards/src/footer/disabled_footer.test.tsx +++ b/packages/home/sample_data_card/src/footer/disabled_footer.test.tsx @@ -10,7 +10,7 @@ import React from 'react'; import { renderWithIntl } from '@kbn/test-jest-helpers'; import { DisabledFooter, Props } from './disabled_footer'; -import { SampleDataCardsProvider } from '../services'; +import { SampleDataCardProvider } from '../services'; import { getMockServices } from '../mocks'; describe('install footer', () => { @@ -22,7 +22,7 @@ describe('install footer', () => { const render = (element: React.ReactElement) => renderWithIntl( - {element} + {element} ); test('should render', () => { diff --git a/packages/home/sample_data_cards/src/footer/disabled_footer.tsx b/packages/home/sample_data_card/src/footer/disabled_footer.tsx similarity index 96% rename from packages/home/sample_data_cards/src/footer/disabled_footer.tsx rename to packages/home/sample_data_card/src/footer/disabled_footer.tsx index d6543006b1083..7b67bf6f46196 100644 --- a/packages/home/sample_data_cards/src/footer/disabled_footer.tsx +++ b/packages/home/sample_data_card/src/footer/disabled_footer.tsx @@ -11,7 +11,7 @@ import React from 'react'; import { EuiButton, EuiFlexGroup, EuiFlexItem, EuiToolTip } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; -import { SampleDataSet } from '../types'; +import { SampleDataSet } from '@kbn/home-sample-data-types'; /** * Props for the `DisabledFooter` component. diff --git a/packages/home/sample_data_cards/src/footer/footer.stories.tsx b/packages/home/sample_data_card/src/footer/footer.stories.tsx similarity index 86% rename from packages/home/sample_data_cards/src/footer/footer.stories.tsx rename to packages/home/sample_data_card/src/footer/footer.stories.tsx index e95417a1c2a74..62d1c559bb907 100644 --- a/packages/home/sample_data_cards/src/footer/footer.stories.tsx +++ b/packages/home/sample_data_card/src/footer/footer.stories.tsx @@ -10,12 +10,11 @@ import React from 'react'; import { ComponentMeta } from '@storybook/react'; import { action } from '@storybook/addon-actions'; +import type { SampleDataSet } from '@kbn/home-sample-data-types'; import { Params, getStoryArgTypes, getStoryServices, mockDataSet } from '../mocks'; -import { SampleDataCardsProvider } from '../services'; +import { SampleDataCardProvider } from '../services'; import { Footer as Component } from '.'; -import type { SampleDataSet } from '../types'; - import mdx from '../../README.mdx'; export default { @@ -41,9 +40,9 @@ export const CardFooter = (params: Params) => { }; return ( - + - + ); }; diff --git a/packages/home/sample_data_cards/src/footer/index.tsx b/packages/home/sample_data_card/src/footer/index.tsx similarity index 94% rename from packages/home/sample_data_cards/src/footer/index.tsx rename to packages/home/sample_data_card/src/footer/index.tsx index 4bb77e2a39b14..3ef415d07c507 100644 --- a/packages/home/sample_data_cards/src/footer/index.tsx +++ b/packages/home/sample_data_card/src/footer/index.tsx @@ -7,9 +7,9 @@ */ import React from 'react'; +import { SampleDataSet, InstalledStatus } from '@kbn/home-sample-data-types'; import { INSTALLED_STATUS, UNINSTALLED_STATUS } from '../constants'; -import { SampleDataSet, InstalledStatus } from '../types'; import { DisabledFooter } from './disabled_footer'; import { InstallFooter } from './install_footer'; import { RemoveFooter } from './remove_footer'; diff --git a/packages/home/sample_data_cards/src/footer/install_footer.test.tsx b/packages/home/sample_data_card/src/footer/install_footer.test.tsx similarity index 88% rename from packages/home/sample_data_cards/src/footer/install_footer.test.tsx rename to packages/home/sample_data_card/src/footer/install_footer.test.tsx index 02b9496c927f5..298b91ee13829 100644 --- a/packages/home/sample_data_cards/src/footer/install_footer.test.tsx +++ b/packages/home/sample_data_card/src/footer/install_footer.test.tsx @@ -11,7 +11,7 @@ import { renderWithIntl, mountWithIntl } from '@kbn/test-jest-helpers'; import { act } from 'react-dom/test-utils'; import { InstallFooter, Props } from './install_footer'; -import { SampleDataCardsProvider, Services } from '../services'; +import { SampleDataCardProvider, Services } from '../services'; import { getMockServices } from '../mocks'; describe('install footer', () => { @@ -33,14 +33,14 @@ describe('install footer', () => { const render = (element: React.ReactElement) => renderWithIntl( - {element} + {element} ); const mount = (element: React.ReactElement, params?: Partial) => mountWithIntl( - + {element} - + ); test('should render', () => { diff --git a/packages/home/sample_data_cards/src/footer/install_footer.tsx b/packages/home/sample_data_card/src/footer/install_footer.tsx similarity index 96% rename from packages/home/sample_data_cards/src/footer/install_footer.tsx rename to packages/home/sample_data_card/src/footer/install_footer.tsx index 79b559ff16cfa..cf9ddc8ba2211 100644 --- a/packages/home/sample_data_cards/src/footer/install_footer.tsx +++ b/packages/home/sample_data_card/src/footer/install_footer.tsx @@ -10,8 +10,8 @@ import React from 'react'; import { EuiButton, EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; +import type { SampleDataSet } from '@kbn/home-sample-data-types'; import { useInstall } from '../hooks'; -import type { SampleDataSet } from '../types'; import type { UseInstallParams } from '../hooks'; /** diff --git a/packages/home/sample_data_cards/src/footer/remove_footer.test.tsx b/packages/home/sample_data_card/src/footer/remove_footer.test.tsx similarity index 88% rename from packages/home/sample_data_cards/src/footer/remove_footer.test.tsx rename to packages/home/sample_data_card/src/footer/remove_footer.test.tsx index dd8ee4fb98e3d..77505f58ca114 100644 --- a/packages/home/sample_data_cards/src/footer/remove_footer.test.tsx +++ b/packages/home/sample_data_card/src/footer/remove_footer.test.tsx @@ -11,7 +11,7 @@ import { renderWithIntl, mountWithIntl } from '@kbn/test-jest-helpers'; import { act } from 'react-dom/test-utils'; import { RemoveFooter, Props } from './remove_footer'; -import { SampleDataCardsProvider, Services } from '../services'; +import { SampleDataCardProvider, Services } from '../services'; import { getMockServices } from '../mocks'; describe('install footer', () => { @@ -35,14 +35,14 @@ describe('install footer', () => { const render = (element: React.ReactElement) => renderWithIntl( - {element} + {element} ); const mount = (element: React.ReactElement, params?: Partial) => mountWithIntl( - + {element} - + ); test('should render', () => { diff --git a/packages/home/sample_data_cards/src/footer/remove_footer.tsx b/packages/home/sample_data_card/src/footer/remove_footer.tsx similarity index 97% rename from packages/home/sample_data_cards/src/footer/remove_footer.tsx rename to packages/home/sample_data_card/src/footer/remove_footer.tsx index 4ff5f71d1d457..f1210895c05a6 100644 --- a/packages/home/sample_data_cards/src/footer/remove_footer.tsx +++ b/packages/home/sample_data_card/src/footer/remove_footer.tsx @@ -9,8 +9,8 @@ import React from 'react'; import { EuiButtonEmpty, EuiFlexGroup, EuiFlexItem } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; +import type { SampleDataSet } from '@kbn/home-sample-data-types'; import { useRemove } from '../hooks'; -import type { SampleDataSet } from '../types'; import { ViewButton } from './view_button'; import type { UseRemoveParams } from '../hooks'; import type { Props as ViewButtonProps } from './view_button'; diff --git a/packages/home/sample_data_cards/src/footer/view_button.test.tsx b/packages/home/sample_data_card/src/footer/view_button.test.tsx similarity index 92% rename from packages/home/sample_data_cards/src/footer/view_button.test.tsx rename to packages/home/sample_data_card/src/footer/view_button.test.tsx index ad3b8f2ced00c..20ba9f6d3479b 100644 --- a/packages/home/sample_data_cards/src/footer/view_button.test.tsx +++ b/packages/home/sample_data_card/src/footer/view_button.test.tsx @@ -10,13 +10,11 @@ import React from 'react'; import { renderWithIntl } from '@kbn/test-jest-helpers'; import { ViewButton } from './view_button'; -import { SampleDataCardsProvider } from '../services'; +import { SampleDataCardProvider } from '../services'; import { getMockServices } from '../mocks'; const render = (element: React.ReactElement) => - renderWithIntl( - {element} - ); + renderWithIntl({element}); test('should render simple button when appLinks is empty', () => { const component = render( diff --git a/packages/home/sample_data_cards/src/footer/view_button.tsx b/packages/home/sample_data_card/src/footer/view_button.tsx similarity index 98% rename from packages/home/sample_data_cards/src/footer/view_button.tsx rename to packages/home/sample_data_card/src/footer/view_button.tsx index 6cb55a5a703b9..730b7300654f0 100644 --- a/packages/home/sample_data_cards/src/footer/view_button.tsx +++ b/packages/home/sample_data_card/src/footer/view_button.tsx @@ -17,8 +17,8 @@ import { } from '@elastic/eui'; import { i18n } from '@kbn/i18n'; +import type { SampleDataSet } from '@kbn/home-sample-data-types'; import { useServices } from '../services'; -import type { SampleDataSet } from '../types'; /** * Props for the `ViewButton` component. diff --git a/packages/home/sample_data_cards/src/hooks/index.ts b/packages/home/sample_data_card/src/hooks/index.ts similarity index 93% rename from packages/home/sample_data_cards/src/hooks/index.ts rename to packages/home/sample_data_card/src/hooks/index.ts index ce89f51d4d4f4..5cea4e78859fd 100644 --- a/packages/home/sample_data_cards/src/hooks/index.ts +++ b/packages/home/sample_data_card/src/hooks/index.ts @@ -6,8 +6,6 @@ * Side Public License, v 1. */ -export { useList } from './use_list'; - export { useInstall } from './use_install'; export type { Params as UseInstallParams } from './use_install'; diff --git a/packages/home/sample_data_cards/src/hooks/use_install.ts b/packages/home/sample_data_card/src/hooks/use_install.ts similarity index 96% rename from packages/home/sample_data_cards/src/hooks/use_install.ts rename to packages/home/sample_data_card/src/hooks/use_install.ts index d8d806d3a533b..4431042031b9e 100644 --- a/packages/home/sample_data_cards/src/hooks/use_install.ts +++ b/packages/home/sample_data_card/src/hooks/use_install.ts @@ -9,8 +9,8 @@ import React, { useCallback } from 'react'; import { i18n } from '@kbn/i18n'; +import type { SampleDataSet } from '@kbn/home-sample-data-types'; import { useServices } from '../services'; -import type { SampleDataSet } from '../types'; /** * Parameters for the `useInstall` React hook. diff --git a/packages/home/sample_data_cards/src/hooks/use_remove.ts b/packages/home/sample_data_card/src/hooks/use_remove.ts similarity index 96% rename from packages/home/sample_data_cards/src/hooks/use_remove.ts rename to packages/home/sample_data_card/src/hooks/use_remove.ts index fb3f27d4eaa20..f8b937abf796e 100644 --- a/packages/home/sample_data_cards/src/hooks/use_remove.ts +++ b/packages/home/sample_data_card/src/hooks/use_remove.ts @@ -9,8 +9,8 @@ import React, { useCallback } from 'react'; import { i18n } from '@kbn/i18n'; +import type { SampleDataSet } from '@kbn/home-sample-data-types'; import { useServices } from '../services'; -import type { SampleDataSet } from '../types'; /** * Parameters for the `useRemove` React hook. diff --git a/packages/home/sample_data_card/src/index.ts b/packages/home/sample_data_card/src/index.ts new file mode 100644 index 0000000000000..47bb9696ff87f --- /dev/null +++ b/packages/home/sample_data_card/src/index.ts @@ -0,0 +1,24 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { SampleDataCard } from './sample_data_card'; +export type { Props as SampleDataCardProps } from './sample_data_card'; + +export { SampleDataCardKibanaProvider, SampleDataCardProvider } from './services'; +export type { + Services as SampleDataCardServices, + KibanaDependencies as SampleDataCardKibanaDependencies, +} from './services'; + +// TODO: clintandrewhall - convert to new Storybook mock when published. +export { + getStoryArgTypes as getSampleDataCardStoryArgTypes, + getStoryServices as getSampleDataCardStoryServices, + getMockDataSet as getSampleDataCardMockDataSet, +} from './mocks'; +export type { Params as SampleDataCardStorybookParams } from './mocks'; diff --git a/packages/home/sample_data_cards/src/mocks/dashboard.png b/packages/home/sample_data_card/src/mocks/dashboard.png similarity index 100% rename from packages/home/sample_data_cards/src/mocks/dashboard.png rename to packages/home/sample_data_card/src/mocks/dashboard.png diff --git a/packages/home/sample_data_cards/src/mocks/dashboard_dark.png b/packages/home/sample_data_card/src/mocks/dashboard_dark.png similarity index 100% rename from packages/home/sample_data_cards/src/mocks/dashboard_dark.png rename to packages/home/sample_data_card/src/mocks/dashboard_dark.png diff --git a/packages/home/sample_data_cards/src/mocks/icon.svg b/packages/home/sample_data_card/src/mocks/icon.svg similarity index 100% rename from packages/home/sample_data_cards/src/mocks/icon.svg rename to packages/home/sample_data_card/src/mocks/icon.svg diff --git a/packages/home/sample_data_cards/src/mocks/index.ts b/packages/home/sample_data_card/src/mocks/index.ts similarity index 93% rename from packages/home/sample_data_cards/src/mocks/index.ts rename to packages/home/sample_data_card/src/mocks/index.ts index 426ecfcdf7df8..31ae1bb6c6afd 100644 --- a/packages/home/sample_data_cards/src/mocks/index.ts +++ b/packages/home/sample_data_card/src/mocks/index.ts @@ -8,12 +8,12 @@ import { action } from '@storybook/addon-actions'; +import { SampleDataSet } from '@kbn/home-sample-data-types'; import previewImagePath from './dashboard.png'; import darkPreviewImagePath from './dashboard_dark.png'; import iconPath from './icon.svg'; import { Services } from '../services'; -import { SampleDataSet } from '../types'; /** * A set of e-commerce images for use in Storybook stories. @@ -57,7 +57,7 @@ export const getMockDataSet = (params: Partial = {}) => ({ export type Params = Record, any>; /** - * Returns Storybook-compatible service abstractions for the `SampleDataCards` Provider. + * Returns Storybook-compatible service abstractions for the `SampleDataCard` Provider. */ export const getStoryServices = (params: Params) => { const { simulateErrors } = params; @@ -67,9 +67,6 @@ export const getStoryServices = (params: Params) => { action('addBasePath')(path); return path; }, - fetchSampleDataSets: async () => { - return []; - }, getAppNavigationHandler: (path) => () => action('getAppNavigationHandler')(path), installSampleDataSet: async (id, defaultIndex) => { if (simulateErrors) { @@ -91,7 +88,7 @@ export const getStoryServices = (params: Params) => { }; /** - * Returns the Storybook arguments for `SampleDataCards`, for its stories and for + * Returns the Storybook arguments for `SampleDataCard`, for its stories and for * consuming component stories. */ export const getStoryArgTypes = () => ({ @@ -128,7 +125,6 @@ export const getStoryArgTypes = () => ({ export const getMockServices = (params: Partial = {}) => { const services: Services = { addBasePath: (path) => path, - fetchSampleDataSets: jest.fn(), getAppNavigationHandler: jest.fn(), installSampleDataSet: jest.fn(), notifyError: jest.fn(), diff --git a/packages/home/sample_data_cards/src/sample_data_card.component.tsx b/packages/home/sample_data_card/src/sample_data_card.component.tsx similarity index 90% rename from packages/home/sample_data_cards/src/sample_data_card.component.tsx rename to packages/home/sample_data_card/src/sample_data_card.component.tsx index 0c9cca19c7fff..65712271faff2 100644 --- a/packages/home/sample_data_cards/src/sample_data_card.component.tsx +++ b/packages/home/sample_data_card/src/sample_data_card.component.tsx @@ -9,9 +9,9 @@ import React from 'react'; import { EuiCard } from '@elastic/eui'; +import type { SampleDataSet, InstalledStatus } from '@kbn/home-sample-data-types'; import { INSTALLED_STATUS } from './constants'; -import type { SampleDataSet, InstalledStatus } from './types'; import { Footer } from './footer'; export interface Props { @@ -26,7 +26,7 @@ export interface Props { /** * A pure implementation of the `SampleDataCard` component that itself * does not depend on any Kibana services. Still requires a - * `SampleDataCardsProvider` for its dependencies to render and function. + * `SampleDataCardProvider` for its dependencies to render and function. */ export const SampleDataCard = ({ sampleDataSet, diff --git a/packages/home/sample_data_cards/src/sample_data_card.stories.tsx b/packages/home/sample_data_card/src/sample_data_card.stories.tsx similarity index 87% rename from packages/home/sample_data_cards/src/sample_data_card.stories.tsx rename to packages/home/sample_data_card/src/sample_data_card.stories.tsx index 623f0e9f6d109..e6de69e0f05ed 100644 --- a/packages/home/sample_data_cards/src/sample_data_card.stories.tsx +++ b/packages/home/sample_data_card/src/sample_data_card.stories.tsx @@ -10,12 +10,11 @@ import React from 'react'; import { ComponentMeta } from '@storybook/react'; import { action } from '@storybook/addon-actions'; +import type { SampleDataSet } from '@kbn/home-sample-data-types'; import { Params, getStoryArgTypes, getStoryServices, mockDataSet } from './mocks'; -import { SampleDataCardsProvider } from './services'; +import { SampleDataCardProvider } from './services'; import { SampleDataCard } from './sample_data_card'; -import type { SampleDataSet } from './types'; - import mdx from '../README.mdx'; export default { @@ -41,9 +40,9 @@ export const Card = (params: Params) => { }; return ( - + - + ); }; diff --git a/packages/home/sample_data_cards/src/sample_data_card.test.tsx b/packages/home/sample_data_card/src/sample_data_card.test.tsx similarity index 91% rename from packages/home/sample_data_cards/src/sample_data_card.test.tsx rename to packages/home/sample_data_card/src/sample_data_card.test.tsx index 4968527871550..86420abae20d7 100644 --- a/packages/home/sample_data_cards/src/sample_data_card.test.tsx +++ b/packages/home/sample_data_card/src/sample_data_card.test.tsx @@ -11,7 +11,7 @@ import { renderWithIntl, mountWithIntl } from '@kbn/test-jest-helpers'; import { act } from 'react-dom/test-utils'; import { SampleDataCard } from './sample_data_card'; -import { SampleDataCardsProvider } from './services'; +import { SampleDataCardProvider } from './services'; import { getMockServices, getMockDataSet } from './mocks'; import { Services } from './services'; import { INSTALLED_STATUS, UNINSTALLED_STATUS } from './constants'; @@ -24,12 +24,12 @@ describe('SampleDataCard', () => { const render = (element: React.ReactElement, services: Partial = {}) => renderWithIntl( - {element} + {element} ); const mount = (element: React.ReactElement, services: Partial = {}) => mountWithIntl( - {element} + {element} ); describe('not installed', () => { diff --git a/packages/home/sample_data_cards/src/sample_data_card.tsx b/packages/home/sample_data_card/src/sample_data_card.tsx similarity index 94% rename from packages/home/sample_data_cards/src/sample_data_card.tsx rename to packages/home/sample_data_card/src/sample_data_card.tsx index 8c096a9c68523..a8da0a7494da4 100644 --- a/packages/home/sample_data_cards/src/sample_data_card.tsx +++ b/packages/home/sample_data_card/src/sample_data_card.tsx @@ -9,11 +9,10 @@ import React, { useMemo } from 'react'; import { useEuiTheme } from '@elastic/eui'; +import type { SampleDataSet } from '@kbn/home-sample-data-types'; import { useServices } from './services'; import { SampleDataCard as Component, Props as ComponentProps } from './sample_data_card.component'; -import type { SampleDataSet } from './types'; - /** * Props for the `SampleDataCard` component. */ @@ -24,7 +23,7 @@ export interface Props extends Pick { /** * A card representing a Sample Data Set that can be installed. Uses Kibana services to - * display and install the data set. Requires a `SampleDataCardsProvider` to render and + * display and install the data set. Requires a `SampleDataCardProvider` to render and * function. */ export const SampleDataCard = ({ sampleDataSet, onStatusChange }: Props) => { diff --git a/packages/home/sample_data_cards/src/services.tsx b/packages/home/sample_data_card/src/services.tsx similarity index 87% rename from packages/home/sample_data_cards/src/services.tsx rename to packages/home/sample_data_card/src/services.tsx index 35b1e0b7d178e..919e248875725 100644 --- a/packages/home/sample_data_cards/src/services.tsx +++ b/packages/home/sample_data_card/src/services.tsx @@ -10,7 +10,6 @@ import React, { FC, MouseEventHandler, useContext } from 'react'; import { EuiGlobalToastListToast as EuiToast } from '@elastic/eui'; import { SAMPLE_DATA_API } from './constants'; -import type { SampleDataSet } from './types'; type NavigateToUrl = (url: string) => Promise | void; type UnmountCallback = () => void; @@ -30,7 +29,6 @@ type NotifyFn = (notification: NotifyInput) => void; */ export interface Services { addBasePath: (path: string) => string; - fetchSampleDataSets: () => Promise; getAppNavigationHandler: (path: string) => MouseEventHandler; installSampleDataSet: (id: string, defaultIndex: string) => Promise; notifyError: NotifyFn; @@ -43,10 +41,9 @@ const Context = React.createContext(null); /** * A Context Provider that provides services to the component and its dependencies. */ -export const SampleDataCardsProvider: FC = ({ children, ...services }) => { +export const SampleDataCardProvider: FC = ({ children, ...services }) => { const { addBasePath, - fetchSampleDataSets, getAppNavigationHandler, installSampleDataSet, notifyError, @@ -58,7 +55,6 @@ export const SampleDataCardsProvider: FC = ({ children, ...services }) = ({ children, ...services }) ); }; -interface KibanaDependencies { +export interface KibanaDependencies { coreStart: { application: { navigateToUrl: NavigateToUrl; @@ -81,7 +77,6 @@ interface KibanaDependencies { prepend: (path: string) => string; }; delete: (path: string) => Promise; - get: (path: string) => Promise; post: (path: string) => Promise; }; notifications: { @@ -104,7 +99,7 @@ interface KibanaDependencies { /** * Kibana-specific Provider that maps dependencies to services. */ -export const SampleDataCardsKibanaProvider: FC = ({ +export const SampleDataCardKibanaProvider: FC = ({ children, ...dependencies }) => { @@ -113,7 +108,6 @@ export const SampleDataCardsKibanaProvider: FC = ({ const value: Services = { addBasePath: http.basePath.prepend, - fetchSampleDataSets: async () => (await http.get(SAMPLE_DATA_API)) as SampleDataSet[], getAppNavigationHandler: (targetUrl) => (event) => { if (event.altKey || event.metaKey || event.ctrlKey) { return; @@ -157,7 +151,7 @@ export function useServices() { if (!context) { throw new Error( - 'SampleDataCards Context is missing. Ensure your component or React root is wrapped with SampleDataCardsContext.' + 'SampleDataCard Context is missing. Ensure your component or React root is wrapped with SampleDataCardContext.' ); } diff --git a/packages/home/sample_data_cards/tsconfig.json b/packages/home/sample_data_card/tsconfig.json similarity index 100% rename from packages/home/sample_data_cards/tsconfig.json rename to packages/home/sample_data_card/tsconfig.json diff --git a/packages/home/sample_data_tab/BUILD.bazel b/packages/home/sample_data_tab/BUILD.bazel new file mode 100644 index 0000000000000..9304ee3353c4f --- /dev/null +++ b/packages/home/sample_data_tab/BUILD.bazel @@ -0,0 +1,140 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "sample_data_tab" +PKG_REQUIRE_NAME = "@kbn/home-sample-data-tab" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + "src/**/*.tsx", + "src/**/*.mdx", + "src/**/*.png", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ + "@npm//react", + "@npm//@elastic/eui", + "//packages/kbn-i18n", + "//packages/home/sample_data_card", +] + +# In this array place dependencies necessary to build the types, which will include the +# :npm_module_types target of other packages and packages from NPM, including @types/* +# packages. +# +# To reference the types for another package use: +# "//repo/relative/path/to/package:npm_module_types" +# eg. "//packages/kbn-utils:npm_module_types" +# +# References to NPM packages work the same as RUNTIME_DEPS +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//@types/react", + "@npm//@elastic/eui", + "//packages/kbn-i18n:npm_module_types", + "//packages/kbn-ambient-ui-types", + "//packages/home/sample_data_types", + "//packages/home/sample_data_card:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +jsts_transpiler( + name = "target_web", + srcs = SRCS, + build_pkg_name = package_name(), + web = True, + additional_args = [ + "--copy-files", + "--quiet" + ], +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node", ":target_web"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/home/sample_data_tab/README.mdx b/packages/home/sample_data_tab/README.mdx new file mode 100644 index 0000000000000..7ad4ad5dab3e0 --- /dev/null +++ b/packages/home/sample_data_tab/README.mdx @@ -0,0 +1,22 @@ +--- +id: home/SampleData/Tab +slug: /home/sample-data/tab +title: Sample Data Tab +summary: A component that displays the content of the Sample Data tab in the `home` plugin. +tags: ['home', 'component', 'sample-data'] +date: 2022-06-30 +--- + +This package contains the components and layout for the Sample Data tab in the `home` plugin. + +## API + +| Export | Description | +|---|---| +| `SampleDataTab` | The Sample Data tab. | +| `SampleDataTabProvider` | Provides contextual services to `SampleDataTab`. | +| `SampleDataTabKibanaProvider` | Maps Kibana dependencies to provide contextual services to `SampleDataTab`. | + +## EUI Promotion Status + +This component is not currently considered for promotion to EUI. diff --git a/packages/home/sample_data_tab/jest.config.js b/packages/home/sample_data_tab/jest.config.js new file mode 100644 index 0000000000000..8a6e5c786580e --- /dev/null +++ b/packages/home/sample_data_tab/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test', + rootDir: '../../..', + roots: ['/packages/home/sample_data_tab'], +}; diff --git a/packages/home/sample_data_tab/package.json b/packages/home/sample_data_tab/package.json new file mode 100644 index 0000000000000..15c15f137361a --- /dev/null +++ b/packages/home/sample_data_tab/package.json @@ -0,0 +1,8 @@ +{ + "name": "@kbn/home-sample-data-tab", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "browser": "./target_web/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} \ No newline at end of file diff --git a/packages/home/sample_data_tab/src/assets/welcome_dark.png b/packages/home/sample_data_tab/src/assets/welcome_dark.png new file mode 100644 index 0000000000000..2337453a57d29 Binary files /dev/null and b/packages/home/sample_data_tab/src/assets/welcome_dark.png differ diff --git a/packages/home/sample_data_tab/src/assets/welcome_light.png b/packages/home/sample_data_tab/src/assets/welcome_light.png new file mode 100644 index 0000000000000..ea18328608525 Binary files /dev/null and b/packages/home/sample_data_tab/src/assets/welcome_light.png differ diff --git a/packages/home/sample_data_tab/src/constants.ts b/packages/home/sample_data_tab/src/constants.ts new file mode 100644 index 0000000000000..7708a3cce1f0d --- /dev/null +++ b/packages/home/sample_data_tab/src/constants.ts @@ -0,0 +1,38 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +// Corresponds to src/plugins/home/server/services/sample_data/routes +export const URL_SAMPLE_DATA_API = '/api/sample_data'; + +// TODO: clintandrewhall pull from config +export const URL_DEMO_ENV = 'https://ela.st/demo'; + +/** + * Test Subject name for the Demo Environment button. + */ +export const DATA_TEST_SUBJ_DEMO_ENV_BUTTON = 'goToDemoEnvButton'; + +/** + * Test Subject name for the sample data accordion button. + */ +export const DATA_TEST_SUBJ_SHOW_SAMPLE_DATA_BUTTON = 'showSampleDataButton'; + +/** + * Test Subject name for the sample data accordion button. + */ +export const DATA_TEST_SUBJ_SHOW_SAMPLE_DATA_ACCORDION = 'showSampleDataAccordion'; + +/** + * Metric name for counting number of clicks of the Demo Environment button. + */ +export const METRIC_CLICK_DEMO_ENV_BUTTON = 'sample_data__demo_env_button'; + +/** + * Metric name for counting number of clicks of the sample data accordion button. + */ +export const METRIC_CLICK_SHOW_SAMPLE_DATA_BUTTON = 'sample_data__show_sample_data_button'; diff --git a/packages/home/sample_data_tab/src/demo_env_panel.stories.tsx b/packages/home/sample_data_tab/src/demo_env_panel.stories.tsx new file mode 100644 index 0000000000000..bf522d39fee5f --- /dev/null +++ b/packages/home/sample_data_tab/src/demo_env_panel.stories.tsx @@ -0,0 +1,27 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import { ComponentMeta } from '@storybook/react'; + +import { DemoEnvironmentPanel } from './demo_env_panel'; + +import mdx from '../README.mdx'; + +export default { + title: 'Sample Data/Demo Panel', + description: '', + parameters: { + docs: { + page: mdx, + }, + }, + decorators: [(Story) =>

{Story()}
], +} as ComponentMeta; + +export const DemoPanel = () => ; diff --git a/packages/home/sample_data_tab/src/demo_env_panel.tsx b/packages/home/sample_data_tab/src/demo_env_panel.tsx new file mode 100644 index 0000000000000..51e720e768558 --- /dev/null +++ b/packages/home/sample_data_tab/src/demo_env_panel.tsx @@ -0,0 +1,105 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React, { useEffect, useRef, useState } from 'react'; +import { + EuiPanel, + EuiFlexGroup, + EuiFlexItem, + EuiButton, + EuiText, + EuiImage, + useEuiTheme, +} from '@elastic/eui'; +import { i18n } from '@kbn/i18n'; + +import { DATA_TEST_SUBJ_DEMO_ENV_BUTTON } from './constants'; + +const title = i18n.translate('homePackages.demoEnvironmentPanel.welcomeTitle', { + defaultMessage: 'Explore our live demo environment', +}); + +const message = i18n.translate('homePackages.demoEnvironmentPanel.welcomeMessage', { + defaultMessage: + 'Browse real-world data in a demo environment where you can explore search, observability, and security use cases like yours.', +}); + +const alt = i18n.translate('homePackages.demoEnvironmentPanel.welcomeImageAlt', { + defaultMessage: 'Illustration of Elastic data integrations', +}); + +const useSVG: () => [string | null, boolean] = () => { + const { colorMode } = useEuiTheme(); + const ref = useRef(null); + const [loading, setLoading] = useState(false); + const isDark = colorMode === 'DARK'; + + useEffect(() => { + setLoading(true); + const load = async () => { + try { + if (isDark) { + const { default: svg } = await import('./assets/welcome_dark.png'); + ref.current = svg; + } else { + const { default: svg } = await import('./assets/welcome_light.png'); + ref.current = svg; + } + } catch (e) { + throw e; + } finally { + setLoading(false); + } + }; + load(); + }, [isDark]); + + return [ref.current, loading]; +}; + +export interface Props { + demoUrl: string; + onClick?: () => void; +} + +export const DemoEnvironmentPanel = ({ demoUrl, onClick: onClickProp = () => {} }: Props) => { + const [imageSrc] = useSVG(); + + const image = imageSrc ? : null; + + const onClick = () => { + onClickProp(); + window.open(demoUrl, '_blank'); + }; + + return ( + + + + +

{title}

+

{message}

+ + Start exploring + + + + + {image} + + + + ); +}; diff --git a/packages/home/sample_data_tab/src/hooks/index.ts b/packages/home/sample_data_tab/src/hooks/index.ts new file mode 100644 index 0000000000000..e4dced254492d --- /dev/null +++ b/packages/home/sample_data_tab/src/hooks/index.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { useList } from './use_list'; diff --git a/packages/home/sample_data_cards/src/hooks/use_list.ts b/packages/home/sample_data_tab/src/hooks/use_list.ts similarity index 96% rename from packages/home/sample_data_cards/src/hooks/use_list.ts rename to packages/home/sample_data_tab/src/hooks/use_list.ts index 5649754f46d0e..460eb97694671 100644 --- a/packages/home/sample_data_cards/src/hooks/use_list.ts +++ b/packages/home/sample_data_tab/src/hooks/use_list.ts @@ -9,8 +9,8 @@ import { useCallback, useState, useEffect } from 'react'; import { i18n } from '@kbn/i18n'; +import type { SampleDataSet } from '@kbn/home-sample-data-types'; import { useServices } from '../services'; -import type { SampleDataSet } from '../types'; /** * A React hook that fetches a list of Sample Data Sets from Kibana, as well as failure diff --git a/packages/home/sample_data_tab/src/index.ts b/packages/home/sample_data_tab/src/index.ts new file mode 100644 index 0000000000000..9bc321aee31c5 --- /dev/null +++ b/packages/home/sample_data_tab/src/index.ts @@ -0,0 +1,15 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { SampleDataTab } from './sample_data_tab'; +export { SampleDataTabKibanaProvider, SampleDataTabProvider } from './services'; +export { + DATA_TEST_SUBJ_DEMO_ENV_BUTTON, + DATA_TEST_SUBJ_SHOW_SAMPLE_DATA_BUTTON, + DATA_TEST_SUBJ_SHOW_SAMPLE_DATA_ACCORDION, +} from './constants'; diff --git a/packages/home/sample_data_tab/src/mocks.ts b/packages/home/sample_data_tab/src/mocks.ts new file mode 100644 index 0000000000000..129549ef23507 --- /dev/null +++ b/packages/home/sample_data_tab/src/mocks.ts @@ -0,0 +1,51 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { + getSampleDataCardStoryArgTypes, + getSampleDataCardStoryServices, + getSampleDataCardMockDataSet, +} from '@kbn/home-sample-data-card'; + +import { SampleDataTabServices } from './services'; + +/** + * Parameters drawn from the Storybook arguments collection that customize a component story. + */ +export type Params = Record, any>; + +/** + * Returns Storybook-compatible service abstractions for the `SampleDataCard` Provider. + */ +export const getStoryServices = (params: Params) => { + const services: SampleDataTabServices = { + fetchSampleDataSets: async () => { + const data = getSampleDataCardMockDataSet(params); + return [data, data, data]; + }, + logClick: () => {}, + ...getSampleDataCardStoryServices(params), + }; + + return services; +}; + +/** + * Returns the Storybook arguments for `SampleDataCard`, for its stories and for + * consuming component stories. + */ +export const getStoryArgTypes = () => ({ + ...getSampleDataCardStoryArgTypes(), +}); diff --git a/packages/home/sample_data_cards/src/sample_data_cards.tsx b/packages/home/sample_data_tab/src/sample_data_cards.tsx similarity index 87% rename from packages/home/sample_data_cards/src/sample_data_cards.tsx rename to packages/home/sample_data_tab/src/sample_data_cards.tsx index d97634c8b3735..5057c2ea4ae6b 100644 --- a/packages/home/sample_data_cards/src/sample_data_cards.tsx +++ b/packages/home/sample_data_tab/src/sample_data_cards.tsx @@ -9,9 +9,9 @@ import React from 'react'; import { EuiFlexGrid, EuiFlexItem } from '@elastic/eui'; import { FlexGridColumns } from '@elastic/eui/src/components/flex/flex_grid'; +import { SampleDataCard } from '@kbn/home-sample-data-card'; import { useList } from './hooks'; -import { SampleDataCard } from './sample_data_card'; /** * Props for the `SampleDataCards` component. @@ -33,5 +33,9 @@ export const SampleDataCards = ({ columns = 3 }: Props) => { )); - return {cards}; + return ( + + {cards} + + ); }; diff --git a/packages/home/sample_data_tab/src/sample_data_tab.stories.tsx b/packages/home/sample_data_tab/src/sample_data_tab.stories.tsx new file mode 100644 index 0000000000000..e56a6fd981fa6 --- /dev/null +++ b/packages/home/sample_data_tab/src/sample_data_tab.stories.tsx @@ -0,0 +1,35 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import { ComponentMeta } from '@storybook/react'; + +import { SampleDataTab } from './sample_data_tab'; + +import mdx from '../README.mdx'; +import { SampleDataTabProvider } from './services'; +import { getStoryServices, getStoryArgTypes, Params } from './mocks'; + +export default { + title: 'Sample Data/Tab Content', + description: '', + parameters: { + docs: { + page: mdx, + }, + }, + decorators: [(Story) =>
{Story()}
], +} as ComponentMeta; + +export const TabContent = (params: Params) => ( + + + +); + +TabContent.argTypes = getStoryArgTypes(); diff --git a/packages/home/sample_data_tab/src/sample_data_tab.tsx b/packages/home/sample_data_tab/src/sample_data_tab.tsx new file mode 100644 index 0000000000000..17d30b19bffca --- /dev/null +++ b/packages/home/sample_data_tab/src/sample_data_tab.tsx @@ -0,0 +1,65 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React from 'react'; +import { i18n } from '@kbn/i18n'; +import { EuiAccordion, EuiPanel, EuiSpacer } from '@elastic/eui'; + +import { DemoEnvironmentPanel } from './demo_env_panel'; +import { SampleDataCards } from './sample_data_cards'; + +// TODO: clintandrewhall - pull from config. +import { + URL_DEMO_ENV, + METRIC_CLICK_DEMO_ENV_BUTTON, + METRIC_CLICK_SHOW_SAMPLE_DATA_BUTTON, + DATA_TEST_SUBJ_SHOW_SAMPLE_DATA_BUTTON, + DATA_TEST_SUBJ_SHOW_SAMPLE_DATA_ACCORDION, +} from './constants'; +import { useServices } from './services'; + +const sampleDataLabel = i18n.translate('homePackages.tutorials.sampleData.sampleDataLabel', { + defaultMessage: 'Other sample data sets', +}); + +/** + * The content for the Sample Data Tab in the `home` plugin. + */ +export const SampleDataTab = () => { + const { logClick } = useServices(); + const onClick = () => { + logClick(METRIC_CLICK_DEMO_ENV_BUTTON); + }; + + const onToggle = (isOpen: boolean) => { + if (isOpen) { + logClick(METRIC_CLICK_SHOW_SAMPLE_DATA_BUTTON); + } + }; + + return ( + <> + + + + + + + + + + ); +}; diff --git a/packages/home/sample_data_tab/src/services.tsx b/packages/home/sample_data_tab/src/services.tsx new file mode 100644 index 0000000000000..b78c0f3507a0d --- /dev/null +++ b/packages/home/sample_data_tab/src/services.tsx @@ -0,0 +1,122 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import React, { FC, useContext } from 'react'; +import type { EuiGlobalToastListToast as EuiToast } from '@elastic/eui'; +import type { SampleDataSet } from '@kbn/home-sample-data-types'; +import { + SampleDataCardServices, + SampleDataCardKibanaDependencies, + SampleDataCardProvider, + SampleDataCardKibanaProvider, +} from '@kbn/home-sample-data-card'; + +import { URL_SAMPLE_DATA_API } from './constants'; + +type UnmountCallback = () => void; +type MountPoint = (element: T) => UnmountCallback; +type ValidNotifyString = string | MountPoint; + +type NotifyInputFields = Pick> & { + title?: ValidNotifyString; + text?: ValidNotifyString; +}; + +type NotifyInput = string | NotifyInputFields; +type NotifyFn = (notification: NotifyInput) => void; + +interface Services { + fetchSampleDataSets: () => Promise; + notifyError: NotifyFn; + logClick: (metric: string) => void; +} + +/** + * A list of services that are consumed by this component. + */ +export type SampleDataTabServices = Services & SampleDataCardServices; + +const Context = React.createContext(null); + +/** + * A Context Provider that provides services to the component and its dependencies. + */ +export const SampleDataTabProvider: FC = ({ children, ...services }) => { + const { fetchSampleDataSets, notifyError, logClick } = services; + + return ( + + {children} + + ); +}; + +interface KibanaDependencies { + coreStart: { + http: { + get: (path: string) => Promise; + }; + notifications: { + toasts: { + addDanger: NotifyFn; + }; + }; + }; + // TODO: clintandrewhall - This is using a type from the home plugin. I'd prefer we + // use the type directly from Kibana instead. + trackUiMetric: (type: string, eventNames: string | string[], count?: number) => void; +} + +/** + * Services that are consumed by this component and its dependencies. + */ +export type SampleDataTabKibanaDependencies = KibanaDependencies & SampleDataCardKibanaDependencies; + +/** + * Kibana-specific Provider that maps dependencies to services. + */ +export const SampleDataTabKibanaProvider: FC = ({ + children, + ...dependencies +}) => { + const { coreStart, trackUiMetric } = dependencies; + const { http, notifications } = coreStart; + + const value: Services = { + fetchSampleDataSets: async () => (await http.get(URL_SAMPLE_DATA_API)) as SampleDataSet[], + notifyError: (input) => notifications.toasts.addDanger(input), + logClick: (eventName) => trackUiMetric('click', eventName), + }; + + return ( + + {children} + + ); +}; + +/** + * React hook for accessing pre-wired services. + */ +export function useServices() { + const context = useContext(Context); + + if (!context) { + throw new Error( + 'SampleDataTab Context is missing. Ensure your component or React root is wrapped with SampleDataTabContext.' + ); + } + + return context; +} diff --git a/packages/home/sample_data_tab/tsconfig.json b/packages/home/sample_data_tab/tsconfig.json new file mode 100644 index 0000000000000..80b4b1882cb33 --- /dev/null +++ b/packages/home/sample_data_tab/tsconfig.json @@ -0,0 +1,20 @@ +{ + "extends": "../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node", + "react", + "@kbn/ambient-ui-types" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/home/sample_data_types/BUILD.bazel b/packages/home/sample_data_types/BUILD.bazel new file mode 100644 index 0000000000000..574f07ca11e66 --- /dev/null +++ b/packages/home/sample_data_types/BUILD.bazel @@ -0,0 +1,58 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "sample_data_types" +PKG_REQUIRE_NAME = "@kbn/home-sample-data-types" +SRCS = glob( + [ + "*.d.ts", + ] +) + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ +] + +js_library( + name = PKG_DIRNAME, + srcs = SRCS + NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS, + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +alias( + name = "npm_module_types", + actual = ":" + PKG_DIRNAME, + visibility = ["//visibility:public"], +) diff --git a/packages/home/sample_data_types/README.mdx b/packages/home/sample_data_types/README.mdx new file mode 100644 index 0000000000000..1fdf5cddca36a --- /dev/null +++ b/packages/home/sample_data_types/README.mdx @@ -0,0 +1,3 @@ +# @kbn/home-sample-data-types + +Common types for packages concerning Sample Data in the `home` plugin. diff --git a/packages/home/sample_data_cards/src/types.ts b/packages/home/sample_data_types/index.d.ts similarity index 89% rename from packages/home/sample_data_cards/src/types.ts rename to packages/home/sample_data_types/index.d.ts index f1a1bc3fa03dc..1bb92d0628427 100644 --- a/packages/home/sample_data_cards/src/types.ts +++ b/packages/home/sample_data_types/index.d.ts @@ -6,8 +6,6 @@ * Side Public License, v 1. */ -import { INSTALLED_STATUS, UNINSTALLED_STATUS } from './constants'; - /** * A relevant subset of the `AppLinkData` type. * @@ -24,7 +22,7 @@ export interface AppLink { /** * @see src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types */ -export type InstalledStatus = typeof INSTALLED_STATUS | typeof UNINSTALLED_STATUS | 'unknown'; +export type InstalledStatus = 'installed' | 'not_installed' | 'unknown'; /** * A subset of properties from a Sample Data Set that are relevant to these components. diff --git a/packages/home/sample_data_types/jest.config.js b/packages/home/sample_data_types/jest.config.js new file mode 100644 index 0000000000000..e1af2a7ca7846 --- /dev/null +++ b/packages/home/sample_data_types/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../..', + roots: ['/packages/home/sample_data_types'], +}; diff --git a/packages/home/sample_data_types/package.json b/packages/home/sample_data_types/package.json new file mode 100644 index 0000000000000..dd42a0e0a1934 --- /dev/null +++ b/packages/home/sample_data_types/package.json @@ -0,0 +1,7 @@ +{ + "name": "@kbn/home-sample-data-types", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0" +} diff --git a/packages/home/sample_data_types/tsconfig.json b/packages/home/sample_data_types/tsconfig.json new file mode 100644 index 0000000000000..6f94a41f6eb89 --- /dev/null +++ b/packages/home/sample_data_types/tsconfig.json @@ -0,0 +1,14 @@ +{ + "extends": "../../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "stripInternal": false, + "types": [] + }, + "include": [ + "*.d.ts" + ] +} diff --git a/packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts b/packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts index ecc6221250bec..cd967a7219b78 100644 --- a/packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts +++ b/packages/kbn-ci-stats-reporter/src/ci_stats_reporter.ts @@ -244,6 +244,7 @@ export class CiStatsReporter { body: { buildId, defaultMeta: options?.defaultMeta, + buildkiteJobId: process.env.BUILDKITE_JOB_ID, metrics, }, bodyDesc: `metrics: ${metrics diff --git a/packages/kbn-doc-links/src/get_doc_links.ts b/packages/kbn-doc-links/src/get_doc_links.ts index e98929ce88f03..8344bf88cb36a 100644 --- a/packages/kbn-doc-links/src/get_doc_links.ts +++ b/packages/kbn-doc-links/src/get_doc_links.ts @@ -114,7 +114,12 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => { webCrawlerReference: `${APP_SEARCH_DOCS}web-crawler-reference.html`, }, enterpriseSearch: { + bulkApi: `${ELASTICSEARCH_DOCS}docs-bulk.html`, configuration: `${ENTERPRISE_SEARCH_DOCS}configuration.html`, + crawlerGettingStarted: `${ENTERPRISE_SEARCH_DOCS}crawler-getting-started.html`, + crawlerManaging: `${ENTERPRISE_SEARCH_DOCS}crawler-managing.html`, + crawlerOverview: `${ENTERPRISE_SEARCH_DOCS}crawler.html`, + languageAnalyzers: `${ELASTICSEARCH_DOCS}analysis-lang-analyzer.html`, licenseManagement: `${ENTERPRISE_SEARCH_DOCS}license-management.html`, mailService: `${ENTERPRISE_SEARCH_DOCS}mailer-configuration.html`, troubleshootSetup: `${ENTERPRISE_SEARCH_DOCS}troubleshoot-setup.html`, @@ -343,6 +348,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => { policyResponseTroubleshooting: { full_disk_access: `${SECURITY_SOLUTION_DOCS}deploy-elastic-endpoint.html#enable-fda-endpoint`, macos_system_ext: `${SECURITY_SOLUTION_DOCS}deploy-elastic-endpoint.html#system-extension-endpoint`, + linux_deadlock: `${SECURITY_SOLUTION_DOCS}ts-management.html`, }, }, query: { @@ -617,6 +623,7 @@ export const getDocLinks = ({ kibanaBranch }: GetDocLinkOptions): DocLinks => { learnMoreBlog: `${ELASTIC_WEBSITE_URL}blog/elastic-agent-and-fleet-make-it-easier-to-integrate-your-systems-with-elastic`, apiKeysLearnMore: `${KIBANA_DOCS}api-keys.html`, onPremRegistry: `${FLEET_DOCS}air-gapped.html`, + packageSignatures: `${FLEET_DOCS}package-signatures.html`, secureLogstash: `${FLEET_DOCS}secure-logstash-connections.html`, agentPolicy: `${FLEET_DOCS}agent-policy.html`, }, diff --git a/packages/kbn-doc-links/src/types.ts b/packages/kbn-doc-links/src/types.ts index bf3132a8c0e94..da96bb00805aa 100644 --- a/packages/kbn-doc-links/src/types.ts +++ b/packages/kbn-doc-links/src/types.ts @@ -101,7 +101,12 @@ export interface DocLinks { readonly webCrawlerReference: string; }; readonly enterpriseSearch: { + readonly bulkApi: string; readonly configuration: string; + readonly crawlerGettingStarted: string; + readonly crawlerManaging: string; + readonly crawlerOverview: string; + readonly languageAnalyzers: string; readonly licenseManagement: string; readonly mailService: string; readonly troubleshootSetup: string; @@ -248,6 +253,7 @@ export interface DocLinks { readonly policyResponseTroubleshooting: { full_disk_access: string; macos_system_ext: string; + linux_deadlock: string; }; readonly threatIntelInt: string; }; @@ -369,6 +375,7 @@ export interface DocLinks { datastreamsNamingScheme: string; installElasticAgent: string; installElasticAgentStandalone: string; + packageSignatures: string; upgradeElasticAgent: string; learnMoreBlog: string; apiKeysLearnMore: string; diff --git a/packages/kbn-es-query/grammar/grammar.peggy b/packages/kbn-es-query/grammar/grammar.peggy index 20db010e1ccac..f75a3f4201206 100644 --- a/packages/kbn-es-query/grammar/grammar.peggy +++ b/packages/kbn-es-query/grammar/grammar.peggy @@ -183,8 +183,7 @@ NotListOfValues Value "value" = value:QuotedString { if (value.type === 'cursor') return value; - const isPhrase = buildLiteralNode(true); - return (field) => buildFunctionNode('is', [field, value, isPhrase]); + return (field) => buildFunctionNode('is', [field, value]); } / value:UnquotedLiteral { if (value.type === 'cursor') return value; @@ -193,8 +192,7 @@ Value "value" error('Leading wildcards are disabled. See query:allowLeadingWildcards in Advanced Settings.'); } - const isPhrase = buildLiteralNode(false); - return (field) => buildFunctionNode('is', [field, value, isPhrase]); + return (field) => buildFunctionNode('is', [field, value]); } Or "OR" @@ -222,7 +220,7 @@ QuotedString }; } / '"' chars:QuotedCharacter* '"' { - return buildLiteralNode(chars.join('')); + return buildLiteralNode(chars.join(''), true); } QuotedCharacter diff --git a/packages/kbn-es-query/src/es_query/build_es_query.ts b/packages/kbn-es-query/src/es_query/build_es_query.ts index 62172fa5aa4d8..1a0ac9cef15ee 100644 --- a/packages/kbn-es-query/src/es_query/build_es_query.ts +++ b/packages/kbn-es-query/src/es_query/build_es_query.ts @@ -11,11 +11,13 @@ import { SerializableRecord } from '@kbn/utility-types'; import { buildQueryFromKuery } from './from_kuery'; import { buildQueryFromFilters } from './from_filters'; import { buildQueryFromLucene } from './from_lucene'; -import { Filter, Query } from '../filters'; +import { Filter, Query, AggregateQuery } from '../filters'; +import { isOfQueryType } from './es_query_sql'; import { BoolQuery, DataViewBase } from './types'; import type { KueryQueryOptions } from '../kuery'; import type { EsQueryFiltersConfig } from './from_filters'; +type AnyQuery = Query | AggregateQuery; /** * Configurations to be used while constructing an ES query. * @public @@ -44,7 +46,7 @@ function removeMatchAll(filters: T[]) { */ export function buildEsQuery( indexPattern: DataViewBase | undefined, - queries: Query | Query[], + queries: AnyQuery | AnyQuery[], filters: Filter | Filter[], config: EsQueryConfig = { allowLeadingWildcards: false, @@ -55,7 +57,7 @@ export function buildEsQuery( queries = Array.isArray(queries) ? queries : [queries]; filters = Array.isArray(filters) ? filters : [filters]; - const validQueries = queries.filter((query) => has(query, 'query')); + const validQueries = queries.filter(isOfQueryType).filter((query) => has(query, 'query')); const queriesByLanguage = groupBy(validQueries, 'language'); const kueryQuery = buildQueryFromKuery( indexPattern, diff --git a/packages/kbn-es-query/src/es_query/es_query_sql.test.ts b/packages/kbn-es-query/src/es_query/es_query_sql.test.ts new file mode 100644 index 0000000000000..da909c6e5f9b4 --- /dev/null +++ b/packages/kbn-es-query/src/es_query/es_query_sql.test.ts @@ -0,0 +1,84 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { + isOfQueryType, + isOfAggregateQueryType, + getAggregateQueryMode, + getIndexPatternFromSQLQuery, +} from './es_query_sql'; + +describe('sql query helpers', () => { + describe('isOfQueryType', () => { + it('should return true for a Query type query', () => { + const flag = isOfQueryType({ query: 'foo', language: 'test' }); + expect(flag).toBe(true); + }); + + it('should return false for an Aggregate type query', () => { + const flag = isOfQueryType({ sql: 'SELECT * FROM foo' }); + expect(flag).toBe(false); + }); + }); + + describe('isOfAggregateQueryType', () => { + it('should return false for a Query type query', () => { + const flag = isOfAggregateQueryType({ query: 'foo', language: 'test' }); + expect(flag).toBe(false); + }); + + it('should return true for an Aggregate type query', () => { + const flag = isOfAggregateQueryType({ sql: 'SELECT * FROM foo' }); + expect(flag).toBe(true); + }); + }); + + describe('getAggregateQueryMode', () => { + it('should return sql for an SQL AggregateQuery type', () => { + const mode = getAggregateQueryMode({ sql: 'SELECT * FROM foo' }); + expect(mode).toBe('sql'); + }); + + it('should return esql for an ESQL AggregateQuery type', () => { + const mode = getAggregateQueryMode({ esql: 'foo | where field > 100' }); + expect(mode).toBe('esql'); + }); + }); + + describe('getIndexPatternFromSQLQuery', () => { + it('should return the index pattern string from sql queries', () => { + const idxPattern1 = getIndexPatternFromSQLQuery('SELECT * FROM foo'); + expect(idxPattern1).toBe('foo'); + + const idxPattern2 = getIndexPatternFromSQLQuery('SELECT woof, meow FROM "foo"'); + expect(idxPattern2).toBe('foo'); + + const idxPattern3 = getIndexPatternFromSQLQuery('SELECT woof, meow FROM "the_index_pattern"'); + expect(idxPattern3).toBe('the_index_pattern'); + + const idxPattern4 = getIndexPatternFromSQLQuery('SELECT woof, meow FROM "the-index-pattern"'); + expect(idxPattern4).toBe('the-index-pattern'); + + const idxPattern5 = getIndexPatternFromSQLQuery('SELECT woof, meow from "the-index-pattern"'); + expect(idxPattern5).toBe('the-index-pattern'); + + const idxPattern6 = getIndexPatternFromSQLQuery('SELECT woof, meow from "logstash-*"'); + expect(idxPattern6).toBe('logstash-*'); + + const idxPattern7 = getIndexPatternFromSQLQuery( + 'SELECT woof, meow from logstash-1234! WHERE field > 100' + ); + expect(idxPattern7).toBe('logstash-1234!'); + + const idxPattern8 = getIndexPatternFromSQLQuery( + 'SELECT * FROM (SELECT woof, miaou FROM "logstash-1234!" GROUP BY woof)' + ); + expect(idxPattern8).toBe('logstash-1234!'); + }); + }); +}); diff --git a/packages/kbn-es-query/src/es_query/es_query_sql.ts b/packages/kbn-es-query/src/es_query/es_query_sql.ts new file mode 100644 index 0000000000000..46de33dc04e86 --- /dev/null +++ b/packages/kbn-es-query/src/es_query/es_query_sql.ts @@ -0,0 +1,46 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ +import type { Query, AggregateQuery } from '../filters'; + +type Language = keyof AggregateQuery; + +// Checks if the query is of type Query +export function isOfQueryType(arg?: Query | AggregateQuery): arg is Query { + return Boolean(arg && 'query' in arg); +} + +// Checks if the query is of type AggregateQuery +// currently only supports the sql query type +// should be enhanced to support other query types +export function isOfAggregateQueryType( + query: AggregateQuery | Query | { [key: string]: any } +): query is AggregateQuery { + return Boolean(query && ('sql' in query || 'esql' in query)); +} + +// returns the language of the aggregate Query, sql, esql etc +export function getAggregateQueryMode(query: AggregateQuery): Language { + return Object.keys(query)[0] as Language; +} + +// retrieves the index pattern from the aggregate query +export function getIndexPatternFromSQLQuery(sqlQuery?: string): string { + let sql = sqlQuery?.replaceAll('"', '').replaceAll("'", ''); + const splitFroms = sql?.split(new RegExp(/FROM\s/, 'ig')); + const fromsLength = splitFroms?.length ?? 0; + if (splitFroms && splitFroms?.length > 2) { + sql = `${splitFroms[fromsLength - 2]} FROM ${splitFroms[fromsLength - 1]}`; + } + // case insensitive match for the index pattern + const regex = new RegExp(/FROM\s+([\w*-.!@$^()~;]+)/, 'i'); + const matches = sql?.match(regex); + if (matches) { + return matches[1]; + } + return ''; +} diff --git a/packages/kbn-es-query/src/es_query/index.ts b/packages/kbn-es-query/src/es_query/index.ts index d4e45b35728f6..5f14b1f03769e 100644 --- a/packages/kbn-es-query/src/es_query/index.ts +++ b/packages/kbn-es-query/src/es_query/index.ts @@ -13,6 +13,12 @@ export { buildEsQuery } from './build_es_query'; export { buildQueryFromFilters } from './from_filters'; export { luceneStringToDsl } from './lucene_string_to_dsl'; export { decorateQuery } from './decorate_query'; +export { + isOfQueryType, + isOfAggregateQueryType, + getAggregateQueryMode, + getIndexPatternFromSQLQuery, +} from './es_query_sql'; export type { IFieldSubType, BoolQuery, diff --git a/packages/kbn-es-query/src/filters/build_filters/types.ts b/packages/kbn-es-query/src/filters/build_filters/types.ts index 30d44fd0b1cba..5e920d11bcab5 100644 --- a/packages/kbn-es-query/src/filters/build_filters/types.ts +++ b/packages/kbn-es-query/src/filters/build_filters/types.ts @@ -82,6 +82,8 @@ export type Query = { language: string; }; +export type AggregateQuery = { sql: string } | { esql: string }; + /** * An interface for a latitude-longitude pair * @public diff --git a/packages/kbn-es-query/src/filters/index.ts b/packages/kbn-es-query/src/filters/index.ts index 765a4a68d2aea..820559d5f9069 100644 --- a/packages/kbn-es-query/src/filters/index.ts +++ b/packages/kbn-es-query/src/filters/index.ts @@ -59,6 +59,7 @@ export { export type { Query, + AggregateQuery, Filter, LatLon, FieldFilter, diff --git a/packages/kbn-es-query/src/index.ts b/packages/kbn-es-query/src/index.ts index aadec300b5610..d29141ab39ac9 100644 --- a/packages/kbn-es-query/src/index.ts +++ b/packages/kbn-es-query/src/index.ts @@ -29,6 +29,7 @@ export type { PhraseFilter, PhrasesFilter, Query, + AggregateQuery, QueryStringFilter, RangeFilter, RangeFilterMeta, @@ -52,6 +53,10 @@ export { decorateQuery, luceneStringToDsl, migrateFilter, + isOfQueryType, + isOfAggregateQueryType, + getAggregateQueryMode, + getIndexPatternFromSQLQuery, } from './es_query'; export { diff --git a/packages/kbn-es-query/src/kuery/ast/ast.test.ts b/packages/kbn-es-query/src/kuery/ast/ast.test.ts index fe18eb3881ecc..bfa5cf10c64f2 100644 --- a/packages/kbn-es-query/src/kuery/ast/ast.test.ts +++ b/packages/kbn-es-query/src/kuery/ast/ast.test.ts @@ -146,7 +146,7 @@ describe('kuery AST API', () => { }); test('should treat quoted values as phrases', () => { - const expected = nodeTypes.function.buildNode('is', 'foo', 'bar baz', true); + const expected = nodeTypes.function.buildNode('is', 'foo', '"bar baz"'); const actual = fromKueryExpression('foo:"bar baz"'); expect(actual).toEqual(expected); }); @@ -328,19 +328,19 @@ describe('kuery AST API', () => { test('should support double quoted strings that do not need escapes except for quotes', () => { const expected = nodeTypes.literal.buildNode('\\():<>"*'); const actual = fromLiteralExpression('"\\():<>\\"*"'); - expect(actual).toEqual(expected); + expect(actual.value).toEqual(expected.value); }); test('should support escaped backslashes inside quoted strings', () => { const expected = nodeTypes.literal.buildNode('\\'); const actual = fromLiteralExpression('"\\\\"'); - expect(actual).toEqual(expected); + expect(actual.value).toEqual(expected.value); }); test('should support escaped unicode sequences inside quoted strings', () => { const expected = nodeTypes.literal.buildNode('\\u00A0'); const actual = fromLiteralExpression('"\\\\u00A0"'); - expect(actual).toEqual(expected); + expect(actual.value).toEqual(expected.value); }); test('should detect wildcards and build wildcard AST nodes', () => { diff --git a/packages/kbn-es-query/src/kuery/functions/is.test.ts b/packages/kbn-es-query/src/kuery/functions/is.test.ts index d30a9132fe3d6..87870cb1497b8 100644 --- a/packages/kbn-es-query/src/kuery/functions/is.test.ts +++ b/packages/kbn-es-query/src/kuery/functions/is.test.ts @@ -51,16 +51,16 @@ describe('kuery functions', () => { test('should default to a non-phrase query', () => { const { - arguments: [, , isPhrase], + arguments: [, value], } = is.buildNodeParams('response', 200); - expect(isPhrase.value).toBe(false); + expect(value.isQuoted).toBe(false); }); test('should allow specification of a phrase query', () => { const { - arguments: [, , isPhrase], - } = is.buildNodeParams('response', 200, true); - expect(isPhrase.value).toBe(true); + arguments: [, value], + } = is.buildNodeParams('response', '"200"'); + expect(value.isQuoted).toBe(true); }); }); @@ -180,7 +180,7 @@ describe('kuery functions', () => { minimum_should_match: 1, }, }; - const node = nodeTypes.function.buildNode('is', 'extension', 'jpg', true); + const node = nodeTypes.function.buildNode('is', 'extension', '"jpg"'); const result = is.toElasticsearchQuery(node, indexPattern); expect(result).toEqual(expected); diff --git a/packages/kbn-es-query/src/kuery/functions/is.ts b/packages/kbn-es-query/src/kuery/functions/is.ts index 31f3c3acc7628..df1a9bb18bb8a 100644 --- a/packages/kbn-es-query/src/kuery/functions/is.ts +++ b/packages/kbn-es-query/src/kuery/functions/is.ts @@ -19,7 +19,7 @@ import * as ast from '../ast'; import * as literal from '../node_types/literal'; import * as wildcard from '../node_types/wildcard'; -export function buildNodeParams(fieldName: string, value: any, isPhrase: boolean = false) { +export function buildNodeParams(fieldName: string, value: any) { if (isUndefined(fieldName)) { throw new Error('fieldName is a required argument'); } @@ -32,9 +32,8 @@ export function buildNodeParams(fieldName: string, value: any, isPhrase: boolean : literal.buildNode(fieldName); const valueNode = typeof value === 'string' ? ast.fromLiteralExpression(value) : literal.buildNode(value); - const isPhraseNode = literal.buildNode(isPhrase); return { - arguments: [fieldNode, valueNode, isPhraseNode], + arguments: [fieldNode, valueNode], }; } @@ -45,7 +44,7 @@ export function toElasticsearchQuery( context: KqlContext = {} ): estypes.QueryDslQueryContainer { const { - arguments: [fieldNameArg, valueArg, isPhraseArg], + arguments: [fieldNameArg, valueArg], } = node; const isExistsQuery = wildcard.isNode(valueArg) && wildcard.isLoneWildcard(valueArg); @@ -62,7 +61,7 @@ export function toElasticsearchQuery( context?.nested ? context.nested.path : undefined ); const value = !isUndefined(valueArg) ? ast.toElasticsearchQuery(valueArg) : valueArg; - const type = isPhraseArg.value ? 'phrase' : 'best_fields'; + const type = valueArg.isQuoted ? 'phrase' : 'best_fields'; if (fullFieldNameArg.value === null) { if (wildcard.isNode(valueArg)) { return { diff --git a/packages/kbn-es-query/src/kuery/grammar/__mocks__/grammar.js b/packages/kbn-es-query/src/kuery/grammar/__mocks__/grammar.js index 418788052a5a3..de6d508872bb2 100644 --- a/packages/kbn-es-query/src/kuery/grammar/__mocks__/grammar.js +++ b/packages/kbn-es-query/src/kuery/grammar/__mocks__/grammar.js @@ -367,8 +367,7 @@ function peg$parse(input, options) { }; var peg$f15 = function(value) { if (value.type === 'cursor') return value; - const isPhrase = buildLiteralNode(true); - return (field) => buildFunctionNode('is', [field, value, isPhrase]); + return (field) => buildFunctionNode('is', [field, value]); }; var peg$f16 = function(value) { if (value.type === 'cursor') return value; @@ -377,8 +376,7 @@ function peg$parse(input, options) { error('Leading wildcards are disabled. See query:allowLeadingWildcards in Advanced Settings.'); } - const isPhrase = buildLiteralNode(false); - return (field) => buildFunctionNode('is', [field, value, isPhrase]); + return (field) => buildFunctionNode('is', [field, value]); }; var peg$f17 = function() { return parseCursor; }; var peg$f18 = function(prefix, cursor, suffix) { @@ -393,7 +391,7 @@ function peg$parse(input, options) { }; }; var peg$f19 = function(chars) { - return buildLiteralNode(chars.join('')); + return buildLiteralNode(chars.join(''), true); }; var peg$f20 = function(char) { return char; }; var peg$f21 = function(chars) { diff --git a/packages/kbn-es-query/src/kuery/node_types/literal.ts b/packages/kbn-es-query/src/kuery/node_types/literal.ts index 029c740d42237..8f0028cb0d19e 100644 --- a/packages/kbn-es-query/src/kuery/node_types/literal.ts +++ b/packages/kbn-es-query/src/kuery/node_types/literal.ts @@ -15,16 +15,18 @@ export type KqlLiteralType = null | boolean | number | string; export interface KqlLiteralNode extends KueryNode { type: typeof KQL_NODE_TYPE_LITERAL; value: KqlLiteralType; + isQuoted: boolean; } export function isNode(node: KueryNode): node is KqlLiteralNode { return node.type === KQL_NODE_TYPE_LITERAL; } -export function buildNode(value: KqlLiteralType): KqlLiteralNode { +export function buildNode(value: KqlLiteralType, isQuoted: boolean = false): KqlLiteralNode { return { type: KQL_NODE_TYPE_LITERAL, value, + isQuoted, }; } diff --git a/packages/kbn-es-query/src/kuery/node_types/node_builder.ts b/packages/kbn-es-query/src/kuery/node_types/node_builder.ts index 6f300551b9ea0..a575bb2d75c67 100644 --- a/packages/kbn-es-query/src/kuery/node_types/node_builder.ts +++ b/packages/kbn-es-query/src/kuery/node_types/node_builder.ts @@ -13,7 +13,6 @@ export const nodeBuilder = { return nodeTypes.function.buildNodeWithArgumentNodes('is', [ nodeTypes.literal.buildNode(fieldName), typeof value === 'string' ? nodeTypes.literal.buildNode(value) : value, - nodeTypes.literal.buildNode(false), ]); }, or: (nodes: KueryNode[]): KueryNode => { diff --git a/packages/kbn-eslint-config/.eslintrc.js b/packages/kbn-eslint-config/.eslintrc.js index 7eeafb720670d..6ebaf807fcafb 100644 --- a/packages/kbn-eslint-config/.eslintrc.js +++ b/packages/kbn-eslint-config/.eslintrc.js @@ -248,6 +248,7 @@ module.exports = { }, ]], + '@kbn/disable/no_protected_eslint_disable': 'error', '@kbn/disable/no_naked_eslint_disable': 'error', '@kbn/eslint/no_async_promise_body': 'error', '@kbn/eslint/no_async_foreach': 'error', diff --git a/packages/kbn-eslint-plugin-disable/BUILD.bazel b/packages/kbn-eslint-plugin-disable/BUILD.bazel index a5e1cc6b04fde..20d6e6d01e71f 100644 --- a/packages/kbn-eslint-plugin-disable/BUILD.bazel +++ b/packages/kbn-eslint-plugin-disable/BUILD.bazel @@ -49,6 +49,7 @@ RUNTIME_DEPS = [ # # References to NPM packages work the same as RUNTIME_DEPS TYPES_DEPS = [ + "@npm//tslib", "@npm//@types/eslint", "@npm//@types/jest", "@npm//@types/node", diff --git a/packages/kbn-eslint-plugin-disable/README.mdx b/packages/kbn-eslint-plugin-disable/README.mdx index 6f9abdfb7474b..3bd66f8767b47 100644 --- a/packages/kbn-eslint-plugin-disable/README.mdx +++ b/packages/kbn-eslint-plugin-disable/README.mdx @@ -10,4 +10,8 @@ tags: ['kibana', 'dev', 'contributor', 'operations', 'eslint', 'disable'] ## `@kbn/disable/no_naked_eslint_disable` -Disallows the usage of naked eslint-disable comments without being specific about each rule to disable. \ No newline at end of file +Disallows the usage of naked eslint-disable comments without being specific about each rule to disable. + +## `@kbn/disable/no_protected_eslint_disable` + +Disallows the eslint-disable comments with specific protected rules that were built to not be disabled. Please contact the Kibana Operations team if you have a justifiable use case for disabling one of them. \ No newline at end of file diff --git a/packages/kbn-eslint-plugin-disable/src/helpers/index.ts b/packages/kbn-eslint-plugin-disable/src/helpers/index.ts new file mode 100644 index 0000000000000..327612eaa4918 --- /dev/null +++ b/packages/kbn-eslint-plugin-disable/src/helpers/index.ts @@ -0,0 +1,11 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export * from './protected_rules'; +export * from './regex'; +export * from './report'; diff --git a/packages/kbn-eslint-plugin-disable/src/helpers/protected_rules.ts b/packages/kbn-eslint-plugin-disable/src/helpers/protected_rules.ts new file mode 100644 index 0000000000000..7e5f5b4b42028 --- /dev/null +++ b/packages/kbn-eslint-plugin-disable/src/helpers/protected_rules.ts @@ -0,0 +1,14 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +// this configures the protected eslint rules on our codebase that can't be disabled +export const PROTECTED_RULES = new Set([ + '@kbn/disable/no_protected_eslint_disable', + '@kbn/disable/no_naked_eslint_disable', + '@kbn/imports/no_unused_imports', +]); diff --git a/packages/kbn-eslint-plugin-disable/src/helpers/regex.ts b/packages/kbn-eslint-plugin-disable/src/helpers/regex.ts new file mode 100644 index 0000000000000..b2627654c1b65 --- /dev/null +++ b/packages/kbn-eslint-plugin-disable/src/helpers/regex.ts @@ -0,0 +1,61 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type Eslint from 'eslint'; + +const ESLINT_DISABLE_RE = /^eslint-disable(?:-next-line|-line)?(?.*)/; + +export enum ESLINT_DISABLE_VALUE { + DISABLE = 'eslint-disable', + DISABLE_NEXT_LINE = 'eslint-disable-next-line', + DISABLE_LINE = 'eslint-disable-line', +} + +export interface ParsedEslintDisableComment { + type: Eslint.AST.Program['comments'][0]['type']; + range: Eslint.AST.Program['comments'][0]['range']; + loc: Eslint.AST.Program['comments'][0]['loc']; + value: Eslint.AST.Program['comments'][0]['value']; + disableValueType: ESLINT_DISABLE_VALUE; + rules: string[]; +} + +export function parseEslintDisableComment( + comment: Eslint.AST.Program['comments'][0] +): ParsedEslintDisableComment | undefined { + const commentVal = comment.value.trim(); + const nakedESLintRegexResult = commentVal.match(ESLINT_DISABLE_RE); + const rulesBlock = nakedESLintRegexResult?.groups?.rulesBlock; + + // no regex match + if (!nakedESLintRegexResult) { + return; + } + + const disableValueType = commentVal.includes(ESLINT_DISABLE_VALUE.DISABLE_NEXT_LINE) + ? ESLINT_DISABLE_VALUE.DISABLE_NEXT_LINE + : commentVal.includes(ESLINT_DISABLE_VALUE.DISABLE_LINE) + ? ESLINT_DISABLE_VALUE.DISABLE_LINE + : ESLINT_DISABLE_VALUE.DISABLE; + + const rules = rulesBlock + ? rulesBlock + .trim() + .split(',') + .map((r) => r.trim()) + : []; + + return { + type: comment.type, + range: comment.range, + loc: comment.loc, + value: comment.value, + disableValueType, + rules, + }; +} diff --git a/packages/kbn-eslint-plugin-disable/src/helpers/report.ts b/packages/kbn-eslint-plugin-disable/src/helpers/report.ts new file mode 100644 index 0000000000000..a497cefb9d148 --- /dev/null +++ b/packages/kbn-eslint-plugin-disable/src/helpers/report.ts @@ -0,0 +1,36 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type Eslint from 'eslint'; +import { ESLINT_DISABLE_VALUE, ParsedEslintDisableComment } from './regex'; + +export function getReportLocFromComment( + comment: ParsedEslintDisableComment +): Eslint.AST.SourceLocation | undefined { + const cStart = comment?.loc?.start; + const cEnd = comment?.loc?.end; + const cStartLine = comment?.loc?.start?.line; + + // start or end loc is undefined, exit early + if (cStart === undefined || cEnd === undefined || cStartLine === undefined) { + return; + } + + const disableStartsOnNextLine = + comment.disableValueType === ESLINT_DISABLE_VALUE.DISABLE_NEXT_LINE; + const disableStartsInline = comment.disableValueType === ESLINT_DISABLE_VALUE.DISABLE_LINE; + const cStartColumn = comment?.loc?.start?.column ?? 0; + return disableStartsOnNextLine + ? { start: cStart, end: cEnd } + : { + // At this point we could have eslint-disable block or an eslint-disable-line. + // If we have an inline disable we need to report the column as -1 in order to get the report + start: { line: cStartLine, column: disableStartsInline ? -1 : cStartColumn - 1 }, + end: cEnd, + }; +} diff --git a/packages/kbn-eslint-plugin-disable/src/index.ts b/packages/kbn-eslint-plugin-disable/src/index.ts index 0e42d6325e42f..59f20998357d6 100644 --- a/packages/kbn-eslint-plugin-disable/src/index.ts +++ b/packages/kbn-eslint-plugin-disable/src/index.ts @@ -7,6 +7,7 @@ */ import { NoNakedESLintDisableRule } from './rules/no_naked_eslint_disable'; +import { NoProtectedESLintDisableRule } from './rules/no_protected_eslint_disable'; /** * Custom ESLint rules, add `'@kbn/eslint-plugin-disable'` to your eslint config to use them @@ -14,4 +15,5 @@ import { NoNakedESLintDisableRule } from './rules/no_naked_eslint_disable'; */ export const rules = { no_naked_eslint_disable: NoNakedESLintDisableRule, + no_protected_eslint_disable: NoProtectedESLintDisableRule, }; diff --git a/packages/kbn-eslint-plugin-disable/src/rules/no_naked_eslint_disable.ts b/packages/kbn-eslint-plugin-disable/src/rules/no_naked_eslint_disable.ts index 7fdc7ec851771..45660dbf20a6d 100644 --- a/packages/kbn-eslint-plugin-disable/src/rules/no_naked_eslint_disable.ts +++ b/packages/kbn-eslint-plugin-disable/src/rules/no_naked_eslint_disable.ts @@ -7,6 +7,7 @@ */ import Eslint from 'eslint'; +import { getReportLocFromComment, parseEslintDisableComment } from '../helpers'; export const NAKED_DISABLE_MSG_ID = 'no-naked-eslint-disable'; const messages = { @@ -24,57 +25,38 @@ const meta: Eslint.Rule.RuleMetaData = { messages, }; -const ESLINT_DISABLE_RE = - /^eslint-disable(?:-next-line|-line)?(?$|(?:\s+(?:@(?:[\w-]+\/){1,2})?[\w-]+)?)/; - const create = (context: Eslint.Rule.RuleContext): Eslint.Rule.RuleListener => { return { Program(node) { const nodeComments = node.comments || []; nodeComments.forEach((comment) => { - const commentVal = comment.value.trim(); - const nakedESLintRegexResult = commentVal.match(ESLINT_DISABLE_RE); - const ruleName = nakedESLintRegexResult?.groups?.ruleName; + // get parsedEslintDisable from comment + const parsedEslintDisable = parseEslintDisableComment(comment); // no regex match, exit early - if (!nakedESLintRegexResult) { + if (!parsedEslintDisable) { return; } - // we have a rule name, exit early - if (ruleName) { + // we have a rule name so we can exit early + if (parsedEslintDisable.rules.length > 0) { return; } - const cStart = comment?.loc?.start; - const cEnd = comment?.loc?.end; - const cStartLine = comment?.loc?.start?.line; - - // start or end loc is undefined, exit early - if (cStart === undefined || cEnd === undefined || cStartLine === undefined) { + // collect position to report + const reportLoc = getReportLocFromComment(parsedEslintDisable); + if (!reportLoc) { return; } - const disableStartsOnNextLine = comment.value.includes('disable-next-line'); - const disableStartsInline = comment.value.includes('disable-line'); - const cStartColumn = comment?.loc?.start?.column ?? 0; - const reportLoc = disableStartsOnNextLine - ? { start: cStart, end: cEnd } - : { - // At this point we could have eslint-disable block or an eslint-disable-line. - // If we have an inline disable we need to report the column as -1 in order to get the report - start: { line: cStartLine, column: disableStartsInline ? -1 : cStartColumn - 1 }, - end: cEnd, - }; - // At this point we have a regex match, no rule name and a valid loc so lets report here context.report({ node, loc: reportLoc, messageId: NAKED_DISABLE_MSG_ID, fix(fixer) { - return fixer.removeRange(comment.range as Eslint.AST.Range); + return fixer.removeRange(parsedEslintDisable.range as Eslint.AST.Range); }, }); }); diff --git a/packages/kbn-eslint-plugin-disable/src/rules/no_protected_eslint_disable.test.ts b/packages/kbn-eslint-plugin-disable/src/rules/no_protected_eslint_disable.test.ts new file mode 100644 index 0000000000000..ef2f7aa3c61ab --- /dev/null +++ b/packages/kbn-eslint-plugin-disable/src/rules/no_protected_eslint_disable.test.ts @@ -0,0 +1,514 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import dedent from 'dedent'; +import { RuleTester } from 'eslint'; +import { + NoProtectedESLintDisableRule, + PROTECTED_DISABLE_MSG_ID, +} from './no_protected_eslint_disable'; + +jest.mock('../helpers/protected_rules', () => { + return { + PROTECTED_RULES: new Set(['@kbn/disable/no_protected_eslint_disable', 'no-console']), + }; +}); + +const tsTester = [ + '@typescript-eslint/parser', + new RuleTester({ + parser: require.resolve('@typescript-eslint/parser'), + parserOptions: { + sourceType: 'module', + ecmaVersion: 2018, + ecmaFeatures: { + jsx: true, + }, + }, + }), +] as const; + +const babelTester = [ + '@babel/eslint-parser', + new RuleTester({ + parser: require.resolve('@babel/eslint-parser'), + parserOptions: { + sourceType: 'module', + ecmaVersion: 2018, + requireConfigFile: false, + babelOptions: { + presets: ['@kbn/babel-preset/node_preset'], + }, + }, + }), +] as const; + +for (const [name, tester] of [tsTester, babelTester]) { + describe(name, () => { + tester.run('@kbn/disable/no_protected_eslint_disable', NoProtectedESLintDisableRule, { + valid: [ + { + filename: 'foo.ts', + code: dedent` + // eslint-disable no-var + `, + }, + { + filename: 'foo.ts', + code: dedent` + // eslint-disable-next-line no-use-before-define + `, + }, + { + filename: 'foo.ts', + code: dedent` + // eslint-disable-line no-use-before-define + `, + }, + { + filename: 'foo.ts', + code: dedent` + /* eslint-disable no-var */ + `, + }, + { + filename: 'foo.ts', + code: dedent` + /* eslint-disable no-var, no-control-regex*/ + `, + }, + { + filename: 'foo.ts', + code: dedent` + alert('foo'); // eslint-disable-line no-alert + `, + }, + { + filename: 'foo.ts', + code: dedent` + const foo = 'foo'; + let bar = 'ba'; + /* eslint-disable no-alert */ + alert(foo); + /* eslint-enable no-alert */ + bar += 'r'; + `, + }, + { + filename: 'foo.ts', + code: dedent` + const foo = 'foo'; + let bar = 'ba'; + /* eslint-disable-next-line no-alert */ + alert(foo); + bar += 'r'; + `, + }, + { + filename: 'foo.ts', + code: dedent` + const foo = 'foo'; + let bar = 'ba'; + alert(foo);/* eslint-disable-line no-alert */ + bar += 'r'; + `, + }, + ], + + invalid: [ + { + filename: 'foo.ts', + code: dedent` + /* eslint-disable no-var,no-console */ + const a = 1; + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: dedent` + /* eslint-disable no-var */ + const a = 1; + `, + }, + { + filename: 'foo.ts', + code: dedent` + /* eslint-disable no-var,no-console*/ + const a = 1; + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: dedent` + /* eslint-disable no-var */ + const a = 1; + `, + }, + { + filename: 'foo.ts', + code: dedent` + /*eslint-disable no-var,no-console*/ + const a = 1; + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: dedent` + /* eslint-disable no-var */ + const a = 1; + `, + }, + { + filename: 'foo.ts', + code: dedent` + // eslint-disable no-var,no-console + const a = 1; + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: dedent` + // eslint-disable no-var + const a = 1; + `, + }, + { + filename: 'foo.ts', + code: dedent` + //eslint-disable no-var,no-console + const a = 1; + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: dedent` + // eslint-disable no-var + const a = 1; + `, + }, + { + filename: 'foo.ts', + code: dedent` + /* eslint-disable no-var,@kbn/disable/no_protected_eslint_disable */ + const a = 1; + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: '@kbn/disable/no_protected_eslint_disable', + }, + }, + ], + output: dedent` + /* eslint-disable no-var */ + const a = 1; + `, + }, + { + filename: 'foo.ts', + code: dedent` + /* eslint-disable no-var, @kbn/disable/no_protected_eslint_disable */ + const a = 1; + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: '@kbn/disable/no_protected_eslint_disable', + }, + }, + ], + output: dedent` + /* eslint-disable no-var */ + const a = 1; + `, + }, + { + filename: 'foo.ts', + code: dedent` + /* eslint-disable @kbn/disable/no_protected_eslint_disable, no-var */ + const a = 1; + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: '@kbn/disable/no_protected_eslint_disable', + }, + }, + ], + output: dedent` + /* eslint-disable no-var */ + const a = 1; + `, + }, + { + filename: 'foo.ts', + code: dedent` + /* eslint-disable prefer-const, @kbn/disable/no_protected_eslint_disable, no-var */ + const a = 1; + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: '@kbn/disable/no_protected_eslint_disable', + }, + }, + ], + output: dedent` + /* eslint-disable prefer-const, no-var */ + const a = 1; + `, + }, + { + filename: 'foo.ts', + code: dedent` + /* eslint-disable no-var, @kbn/disable/no_protected_eslint_disable, prefer-const */ + const a = 1; + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: '@kbn/disable/no_protected_eslint_disable', + }, + }, + ], + output: dedent` + /* eslint-disable no-var, prefer-const */ + const a = 1; + `, + }, + // generic invalid tests for disable comments + { + filename: 'foo.ts', + code: dedent` + /* eslint-disable no-console */ + const a = 1; + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: '\nconst a = 1;', + }, + { + filename: 'foo.ts', + code: dedent` + // eslint-disable-next-line no-console + const a = 1; + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: `\nconst a = 1;`, + }, + { + filename: 'foo.ts', + code: dedent` + /* eslint-disable no-console*/ + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: '', + }, + { + filename: 'foo.ts', + code: dedent` + // eslint-disable-next-line no-console + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: '', + }, + { + filename: 'foo.ts', + code: dedent` + alert('foo');// eslint-disable-line no-console + `, + errors: [ + { + line: 1, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: `alert('foo');`, + }, + { + filename: 'foo.ts', + code: dedent` + const foo = 'foo'; + let bar = 'ba'; + /* eslint-disable no-console */ + alert(foo); + /* eslint-enable */ + bar += 'r'; + `, + errors: [ + { + line: 3, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: dedent` + const foo = 'foo'; + let bar = 'ba'; + + alert(foo); + /* eslint-enable */ + bar += 'r'; + `, + }, + { + filename: 'foo.ts', + code: dedent` + const foo = 'foo'; + let bar = 'ba'; + /* eslint-disable no-console */ + alert(foo); + bar += 'r'; + `, + errors: [ + { + line: 3, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: dedent` + const foo = 'foo'; + let bar = 'ba'; + + alert(foo); + bar += 'r'; + `, + }, + { + filename: 'foo.ts', + code: dedent` + const foo = 'foo'; + let bar = 'ba'; + /* eslint-disable-next-line no-console */ + alert(foo); + bar += 'r'; + `, + errors: [ + { + line: 3, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: dedent` + const foo = 'foo'; + let bar = 'ba'; + + alert(foo); + bar += 'r'; + `, + }, + { + filename: 'foo.ts', + code: dedent` + const foo = 'foo'; + let bar = 'ba'; + alert(foo);/* eslint-disable-line no-console */ + bar += 'r'; + `, + errors: [ + { + line: 3, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: 'no-console', + }, + }, + ], + output: dedent` + const foo = 'foo'; + let bar = 'ba'; + alert(foo); + bar += 'r'; + `, + }, + ], + }); + }); +} diff --git a/packages/kbn-eslint-plugin-disable/src/rules/no_protected_eslint_disable.ts b/packages/kbn-eslint-plugin-disable/src/rules/no_protected_eslint_disable.ts new file mode 100644 index 0000000000000..bffcd5c2febc0 --- /dev/null +++ b/packages/kbn-eslint-plugin-disable/src/rules/no_protected_eslint_disable.ts @@ -0,0 +1,99 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import Eslint from 'eslint'; +import { PROTECTED_RULES, getReportLocFromComment, parseEslintDisableComment } from '../helpers'; + +export const PROTECTED_DISABLE_MSG_ID = 'no-protected-eslint-disable'; +const messages = { + [PROTECTED_DISABLE_MSG_ID]: + "The rule '{{ disabledRuleName }}' is protected and disabling it is not allowed. Please remove it from the statement.", +}; + +const meta: Eslint.Rule.RuleMetaData = { + type: 'problem', + fixable: 'code', + docs: { + description: 'Prevents the disabling of protected rules within eslint-disable* comments.', + }, + messages, +}; + +const create = (context: Eslint.Rule.RuleContext): Eslint.Rule.RuleListener => { + return { + Program(node) { + const nodeComments = node.comments || []; + + nodeComments.forEach((comment) => { + // get parsedEslintDisable from comment + const parsedEslintDisable = parseEslintDisableComment(comment); + + // no regex match, exit early + if (!parsedEslintDisable) { + return; + } + + // we do not have a rule block, exit early + if (parsedEslintDisable.rules.length === 0) { + return; + } + + const disabledRules = parsedEslintDisable.rules; + const disabledProtectedRule = disabledRules.find((r) => PROTECTED_RULES.has(r)); + + // no protected rule was disabled, exit early + if (!disabledProtectedRule) { + return; + } + + // at this point we'll collect the disabled rule position to report + const reportLoc = getReportLocFromComment(parsedEslintDisable); + if (!reportLoc) { + return; + } + + // At this point we have a regex match, no rule name and a valid loc so lets report here + context.report({ + node, + loc: reportLoc, + messageId: PROTECTED_DISABLE_MSG_ID, + data: { + disabledRuleName: disabledProtectedRule, + }, + fix(fixer) { + // if we only have a single disabled rule and that is protected, we can remove the entire comment + if (disabledRules.length === 1) { + return fixer.removeRange(parsedEslintDisable.range as Eslint.AST.Range); + } + + // it's impossible to fix as we don't have a range + if (!parsedEslintDisable.range) { + return null; + } + + const remainingRules = disabledRules.filter((rule) => !PROTECTED_RULES.has(rule)); + const fixedComment = ` ${parsedEslintDisable.disableValueType} ${remainingRules.join( + ', ' + )}${parsedEslintDisable.type === 'Block' ? ' ' : ''}`; + const rangeToFix: Eslint.AST.Range = + parsedEslintDisable.type === 'Line' + ? [parsedEslintDisable.range[0] + 2, parsedEslintDisable.range[1]] + : [parsedEslintDisable.range[0] + 2, parsedEslintDisable.range[1] - 2]; + + return fixer.replaceTextRange(rangeToFix, fixedComment); + }, + }); + }); + }, + }; +}; + +export const NoProtectedESLintDisableRule: Eslint.Rule.RuleModule = { + meta, + create, +}; diff --git a/packages/kbn-eslint-plugin-imports/BUILD.bazel b/packages/kbn-eslint-plugin-imports/BUILD.bazel index 8e878d4f595a0..73badddbcb281 100644 --- a/packages/kbn-eslint-plugin-imports/BUILD.bazel +++ b/packages/kbn-eslint-plugin-imports/BUILD.bazel @@ -57,6 +57,7 @@ TYPES_DEPS = [ "//packages/kbn-utils:npm_module_types", "//packages/kbn-dev-utils:npm_module_types", # only required for the tests, which are excluded except on windows "//packages/kbn-import-resolver:npm_module_types", + "//packages/kbn-repo-source-classifier:npm_module_types", "@npm//dedent", # only required for the tests, which are excluded except on windows "@npm//@types/eslint", "@npm//@types/jest", diff --git a/packages/kbn-eslint-plugin-imports/src/helpers/repo_source_classifier.ts b/packages/kbn-eslint-plugin-imports/src/helpers/repo_source_classifier.ts new file mode 100644 index 0000000000000..9fd7e7e541a7a --- /dev/null +++ b/packages/kbn-eslint-plugin-imports/src/helpers/repo_source_classifier.ts @@ -0,0 +1,31 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { ImportResolver } from '@kbn/import-resolver'; +import { RepoSourceClassifier } from '@kbn/repo-source-classifier'; + +const cache = new WeakMap(); + +/** + * Gets the instance of RepoSourceClassifier that should be used. We cache these instances + * key'd off of ImportResolver instances because the caches maintained by the RepoSourceClassifer + * should live the same amount of time. Both classes assume that the files on disk are + * relatively "stable" for the lifetime of the object and once the files are assumed + * to have change that a new object will be created and the old version with the old + * caches will be thrown away and garbage collected. + */ +export function getRepoSourceClassifier(resolver: ImportResolver) { + const cached = cache.get(resolver); + if (cached) { + return cached; + } + + const classifier = new RepoSourceClassifier(resolver); + cache.set(resolver, classifier); + return classifier; +} diff --git a/packages/kbn-eslint-plugin-imports/src/helpers/source.ts b/packages/kbn-eslint-plugin-imports/src/helpers/source.ts new file mode 100644 index 0000000000000..8bb98832f3118 --- /dev/null +++ b/packages/kbn-eslint-plugin-imports/src/helpers/source.ts @@ -0,0 +1,24 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { Rule } from 'eslint'; + +/** + * Get the path of the sourcefile being linted + */ +export function getSourcePath(context: Rule.RuleContext) { + const sourceFilename = context.getPhysicalFilename + ? context.getPhysicalFilename() + : context.getFilename(); + + if (!sourceFilename) { + throw new Error('unable to determine sourceFilename for file being linted'); + } + + return sourceFilename; +} diff --git a/packages/kbn-eslint-plugin-imports/src/index.ts b/packages/kbn-eslint-plugin-imports/src/index.ts index ca1050f9ba406..64ae97ca76001 100644 --- a/packages/kbn-eslint-plugin-imports/src/index.ts +++ b/packages/kbn-eslint-plugin-imports/src/index.ts @@ -11,6 +11,7 @@ import { NoUnresolvableImportsRule } from './rules/no_unresolvable_imports'; import { UniformImportsRule } from './rules/uniform_imports'; import { ExportsMovedPackagesRule } from './rules/exports_moved_packages'; import { NoUnusedImportsRule } from './rules/no_unused_imports'; +import { NoBoundaryCrossingRule } from './rules/no_boundary_crossing'; /** * Custom ESLint rules, add `'@kbn/eslint-plugin-imports'` to your eslint config to use them @@ -21,4 +22,5 @@ export const rules = { uniform_imports: UniformImportsRule, exports_moved_packages: ExportsMovedPackagesRule, no_unused_imports: NoUnusedImportsRule, + no_boundary_crossing: NoBoundaryCrossingRule, }; diff --git a/packages/kbn-eslint-plugin-imports/src/rules/exports_moved_packages.ts b/packages/kbn-eslint-plugin-imports/src/rules/exports_moved_packages.ts index 2962ab4a5cb12..1dfde85dc1f2e 100644 --- a/packages/kbn-eslint-plugin-imports/src/rules/exports_moved_packages.ts +++ b/packages/kbn-eslint-plugin-imports/src/rules/exports_moved_packages.ts @@ -220,7 +220,7 @@ export const ExportsMovedPackagesRule: Rule.RuleModule = { }, ], docs: { - url: 'https://github.com/elastic/kibana/blob/main/packages/kbn-eslint-plugin-imports/README.md#kbnimportsexports_moved_packages', + url: 'https://github.com/elastic/kibana/blob/main/packages/kbn-eslint-plugin-imports/README.mdx#kbnimportsexports_moved_packages', }, }, diff --git a/packages/kbn-eslint-plugin-imports/src/rules/no_boundary_crossing.test.ts b/packages/kbn-eslint-plugin-imports/src/rules/no_boundary_crossing.test.ts new file mode 100644 index 0000000000000..7830b01f68f8e --- /dev/null +++ b/packages/kbn-eslint-plugin-imports/src/rules/no_boundary_crossing.test.ts @@ -0,0 +1,159 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { RuleTester } from 'eslint'; +import { NoBoundaryCrossingRule } from './no_boundary_crossing'; +import { ModuleType } from '@kbn/repo-source-classifier'; +import dedent from 'dedent'; + +const make = (from: ModuleType, to: ModuleType, imp = 'import') => ({ + filename: `${from}.ts`, + code: dedent` + ${imp} '${to}' + `, +}); + +jest.mock('../get_import_resolver', () => { + return { + getImportResolver() { + return { + resolve(req: string) { + return { + type: 'file', + absolute: { + type: req, + }, + }; + }, + }; + }, + }; +}); + +jest.mock('../helpers/repo_source_classifier', () => { + return { + getRepoSourceClassifier() { + return { + classify(r: string | { type: string }) { + return { + type: typeof r === 'string' ? (r.endsWith('.ts') ? r.slice(0, -3) : r) : r.type, + }; + }, + }; + }, + }; +}); + +const tsTester = [ + '@typescript-eslint/parser', + new RuleTester({ + parser: require.resolve('@typescript-eslint/parser'), + parserOptions: { + sourceType: 'module', + ecmaVersion: 2018, + ecmaFeatures: { + jsx: true, + }, + }, + }), +] as const; + +const babelTester = [ + '@babel/eslint-parser', + new RuleTester({ + parser: require.resolve('@babel/eslint-parser'), + parserOptions: { + sourceType: 'module', + ecmaVersion: 2018, + requireConfigFile: false, + babelOptions: { + presets: ['@kbn/babel-preset/node_preset'], + }, + }, + }), +] as const; + +for (const [name, tester] of [tsTester, babelTester]) { + describe(name, () => { + tester.run('@kbn/imports/no_boundary_crossing', NoBoundaryCrossingRule, { + valid: [ + make('common package', 'common package'), + make('server package', 'common package'), + make('browser package', 'common package'), + make('server package', 'server package'), + make('browser package', 'browser package'), + make('tests or mocks', 'common package'), + make('tests or mocks', 'browser package'), + make('tests or mocks', 'server package'), + make('tests or mocks', 'tests or mocks'), + make('browser package', 'server package', 'import type { Foo } from'), + make('server package', 'browser package', 'import type { Foo } from'), + make('common package', 'browser package', 'import type { Foo } from'), + ], + + invalid: [ + { + ...make('common package', 'server package'), + errors: [ + { + line: 1, + messageId: 'TYPE_MISMATCH', + data: { + importedType: 'server package', + ownType: 'common package', + suggestion: ` ${dedent` + Suggestions: + - Remove the import statement. + - Limit your imports to "common package" or "static" code. + - Covert to a type-only import. + - Reach out to #kibana-operations for help. + `}`, + }, + }, + ], + }, + { + ...make('server package', 'tests or mocks'), + errors: [ + { + line: 1, + messageId: 'TYPE_MISMATCH', + }, + ], + }, + { + ...make('browser package', 'tests or mocks'), + errors: [ + { + line: 1, + messageId: 'TYPE_MISMATCH', + }, + ], + }, + { + ...make('common package', 'server package'), + errors: [ + { + line: 1, + messageId: 'TYPE_MISMATCH', + }, + ], + }, + { + ...make('common package', 'browser package'), + errors: [ + { + line: 1, + messageId: 'TYPE_MISMATCH', + }, + ], + }, + ], + }); + }); +} diff --git a/packages/kbn-eslint-plugin-imports/src/rules/no_boundary_crossing.ts b/packages/kbn-eslint-plugin-imports/src/rules/no_boundary_crossing.ts new file mode 100644 index 0000000000000..4f3defc21d296 --- /dev/null +++ b/packages/kbn-eslint-plugin-imports/src/rules/no_boundary_crossing.ts @@ -0,0 +1,146 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import Path from 'path'; + +import { TSESTree } from '@typescript-eslint/typescript-estree'; +import * as Bt from '@babel/types'; +import { Rule } from 'eslint'; +import ESTree from 'estree'; +import { ModuleType } from '@kbn/repo-source-classifier'; + +import { visitAllImportStatements, Importer } from '../helpers/visit_all_import_statements'; +import { getSourcePath } from '../helpers/source'; +import { getRepoSourceClassifier } from '../helpers/repo_source_classifier'; +import { getImportResolver } from '../get_import_resolver'; + +const IMPORTABLE_FROM: Record = { + 'non-package': ['non-package', 'server package', 'browser package', 'common package', 'static'], + 'server package': ['common package', 'server package', 'static'], + 'browser package': ['common package', 'browser package', 'static'], + 'common package': ['common package', 'static'], + + static: [], + 'tests or mocks': '*', + tooling: '*', +}; + +const toList = (strings: string[]) => { + const items = strings.map((s) => `"${s}"`); + const list = items.slice(0, -1).join(', '); + const last = items.at(-1); + return !list.length ? last ?? '' : `${list} or ${last}`; +}; + +const formatSuggestions = (suggestions: string[]) => { + const s = suggestions.map((l) => l.trim()).filter(Boolean); + if (!s.length) { + return ''; + } + + return ` Suggestions:\n - ${s.join('\n - ')}`; +}; + +const isTypeOnlyImport = (importer: Importer) => { + // handle babel nodes + if (Bt.isImportDeclaration(importer)) { + return ( + importer.importKind === 'type' || + importer.specifiers.some((s) => ('importKind' in s ? s.importKind === 'type' : false)) + ); + } + + if (importer.type === TSESTree.AST_NODE_TYPES.ImportDeclaration) { + return ( + importer.importKind === 'type' || + importer.specifiers.some( + (s) => s.type === TSESTree.AST_NODE_TYPES.ImportSpecifier && s.importKind === 'type' + ) + ); + } + + if (Bt.isExportNamedDeclaration(importer)) { + return ( + importer.exportKind === 'type' || + importer.specifiers.some((s) => (Bt.isExportSpecifier(s) ? s.exportKind === 'type' : false)) + ); + } + + if (importer.type === TSESTree.AST_NODE_TYPES.ExportNamedDeclaration) { + return ( + importer.exportKind === 'type' || importer.specifiers.some((s) => s.exportKind === 'type') + ); + } + + return false; +}; + +export const NoBoundaryCrossingRule: Rule.RuleModule = { + meta: { + docs: { + url: 'https://github.com/elastic/kibana/blob/main/packages/kbn-eslint-plugin-imports/README.mdx#kbnimportsno_unused_imports', + }, + messages: { + TYPE_MISMATCH: `"{{importedType}}" code can not be imported from "{{ownType}}" code.{{suggestion}}`, + }, + }, + create(context) { + const resolver = getImportResolver(context); + const classifier = getRepoSourceClassifier(resolver); + const sourcePath = getSourcePath(context); + const ownDirname = Path.dirname(sourcePath); + + const self = classifier.classify(sourcePath); + const importable = IMPORTABLE_FROM[self.type]; + + if (importable === '*') { + // don't check imports in files which can import anything + return {}; + } + + return visitAllImportStatements((req, { node, importer }) => { + if ( + req === null || + // we can ignore imports using the raw-loader, they will need to be resolved but can be managed on a case by case basis + req.startsWith('!!raw-loader') || + // type only imports can stretch across all the boundaries + isTypeOnlyImport(importer) + ) { + return; + } + + const result = resolver.resolve(req, ownDirname); + if (result?.type !== 'file' || result.nodeModule) { + return; + } + + const imported = classifier.classify(result.absolute); + + if (!importable.includes(imported.type)) { + context.report({ + node: node as ESTree.Node, + messageId: 'TYPE_MISMATCH', + data: { + ownType: self.type, + importedType: imported.type, + suggestion: formatSuggestions([ + self.type.endsWith(' package') && imported.type === 'tests or mocks' + ? 'To expose mocks to other packages, they should be in their own package that is consumed by this package.' + : '', + `Remove the import statement.`, + importable.length > 0 ? `Limit your imports to ${toList(importable)} code.` : '', + `Covert to a type-only import.`, + `Reach out to #kibana-operations for help.`, + ]), + }, + }); + return; + } + }); + }, +}; diff --git a/packages/kbn-eslint-plugin-imports/src/rules/no_unresolvable_imports.ts b/packages/kbn-eslint-plugin-imports/src/rules/no_unresolvable_imports.ts index e5b324ea0a3e8..9990ec38530e5 100644 --- a/packages/kbn-eslint-plugin-imports/src/rules/no_unresolvable_imports.ts +++ b/packages/kbn-eslint-plugin-imports/src/rules/no_unresolvable_imports.ts @@ -10,28 +10,22 @@ import Path from 'path'; import { Rule } from 'eslint'; import { report } from '../helpers/report'; +import { getSourcePath } from '../helpers/source'; import { getImportResolver } from '../get_import_resolver'; import { visitAllImportStatements } from '../helpers/visit_all_import_statements'; export const NoUnresolvableImportsRule: Rule.RuleModule = { meta: { docs: { - url: 'https://github.com/elastic/kibana/blob/main/packages/kbn-eslint-plugin-imports/README.md#kbnimportsno_unresolvable_imports', + url: 'https://github.com/elastic/kibana/blob/main/packages/kbn-eslint-plugin-imports/README.mdx#kbnimportsno_unresolvable_imports', }, }, create(context) { const resolver = getImportResolver(context); - - const sourceFilename = context.getPhysicalFilename - ? context.getPhysicalFilename() - : context.getFilename(); - - if (!sourceFilename) { - throw new Error('unable to determine sourceFilename for file being linted'); - } + const sourcePath = getSourcePath(context); return visitAllImportStatements((req, { node }) => { - if (req !== null && !resolver.resolve(req, Path.dirname(sourceFilename))) { + if (req !== null && !resolver.resolve(req, Path.dirname(sourcePath))) { report(context, { node, message: `Unable to resolve import [${req}]`, diff --git a/packages/kbn-eslint-plugin-imports/src/rules/no_unused_imports.ts b/packages/kbn-eslint-plugin-imports/src/rules/no_unused_imports.ts index 88153f6f914e5..e3c196c5d560e 100644 --- a/packages/kbn-eslint-plugin-imports/src/rules/no_unused_imports.ts +++ b/packages/kbn-eslint-plugin-imports/src/rules/no_unused_imports.ts @@ -80,7 +80,7 @@ export const NoUnusedImportsRule: Rule.RuleModule = { meta: { fixable: 'code', docs: { - url: 'https://github.com/elastic/kibana/blob/main/packages/kbn-eslint-plugin-imports/README.md#kbnimportsno_unused_imports', + url: 'https://github.com/elastic/kibana/blob/main/packages/kbn-eslint-plugin-imports/README.mdx#kbnimportsno_unused_imports', }, }, create(context) { diff --git a/packages/kbn-eslint-plugin-imports/src/rules/uniform_imports.ts b/packages/kbn-eslint-plugin-imports/src/rules/uniform_imports.ts index 75487e62cd613..5d6daad4cfdee 100644 --- a/packages/kbn-eslint-plugin-imports/src/rules/uniform_imports.ts +++ b/packages/kbn-eslint-plugin-imports/src/rules/uniform_imports.ts @@ -14,6 +14,7 @@ import { getRelativeImportReq, getPackageRelativeImportReq } from '@kbn/import-r import { report } from '../helpers/report'; import { visitAllImportStatements } from '../helpers/visit_all_import_statements'; +import { getSourcePath } from '../helpers/source'; import { getImportResolver } from '../get_import_resolver'; // TODO: get rid of all the special cases in here by moving more things to packages @@ -27,19 +28,15 @@ export const UniformImportsRule: Eslint.Rule.RuleModule = { meta: { fixable: 'code', docs: { - url: 'https://github.com/elastic/kibana/blob/main/packages/kbn-eslint-plugin-imports/README.md#kbnimportsuniform_imports', + url: 'https://github.com/elastic/kibana/blob/main/packages/kbn-eslint-plugin-imports/README.mdx#kbnimportsuniform_imports', }, }, create(context) { const resolver = getImportResolver(context); - const sourceFilename = context.getPhysicalFilename - ? context.getPhysicalFilename() - : context.getFilename(); - - const sourceDirname = Path.dirname(sourceFilename); - - const ownPackageId = resolver.getPackageIdForPath(sourceFilename); + const sourcePath = getSourcePath(context); + const sourceDirname = Path.dirname(sourcePath); + const ownPackageId = resolver.getPackageIdForPath(sourcePath); return visitAllImportStatements((req, { node, type }) => { if (!req) { diff --git a/packages/kbn-get-repo-files/BUILD.bazel b/packages/kbn-get-repo-files/BUILD.bazel new file mode 100644 index 0000000000000..ac476aa075744 --- /dev/null +++ b/packages/kbn-get-repo-files/BUILD.bazel @@ -0,0 +1,118 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "kbn-get-repo-files" +PKG_REQUIRE_NAME = "@kbn/get-repo-files" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ +] + +# In this array place dependencies necessary to build the types, which will include the +# :npm_module_types target of other packages and packages from NPM, including @types/* +# packages. +# +# To reference the types for another package use: +# "//repo/relative/path/to/package:npm_module_types" +# eg. "//packages/kbn-utils:npm_module_types" +# +# References to NPM packages work the same as RUNTIME_DEPS +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//execa", + "//packages/kbn-utils:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/kbn-get-repo-files/README.mdx b/packages/kbn-get-repo-files/README.mdx new file mode 100644 index 0000000000000..9ec3f1bb0128d --- /dev/null +++ b/packages/kbn-get-repo-files/README.mdx @@ -0,0 +1,10 @@ +--- +id: kibDevDocsOpsGetRepoFiles +slug: /kibana-dev-docs/ops/get-repo-files +title: "@kbn/get-repo-files" +description: 'A tool which lists the files under source-control' +date: 2022-07-25 +tags: ['kibana', 'dev', 'contributor', 'operations', 'packages', 'scripts', 'repo', 'files'] +--- + +This package exposes a helper to retreive a list of the files checked into the repository. It does this using the `git ls-files` CLI with some post processing to detemine if unstaged changes represent files which are modified (have edits) or deleted. diff --git a/packages/kbn-get-repo-files/jest.config.js b/packages/kbn-get-repo-files/jest.config.js new file mode 100644 index 0000000000000..d1b290f59a7ae --- /dev/null +++ b/packages/kbn-get-repo-files/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../..', + roots: ['/packages/kbn-get-repo-files'], +}; diff --git a/packages/kbn-get-repo-files/package.json b/packages/kbn-get-repo-files/package.json new file mode 100644 index 0000000000000..8cd19049fd197 --- /dev/null +++ b/packages/kbn-get-repo-files/package.json @@ -0,0 +1,10 @@ +{ + "name": "@kbn/get-repo-files", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0", + "kibana": { + "devOnly": true + } +} diff --git a/packages/kbn-get-repo-files/src/get_repo_files.ts b/packages/kbn-get-repo-files/src/get_repo_files.ts new file mode 100644 index 0000000000000..f63018b99e0d7 --- /dev/null +++ b/packages/kbn-get-repo-files/src/get_repo_files.ts @@ -0,0 +1,67 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import Path from 'path'; +import Fs from 'fs'; + +import execa from 'execa'; +import { REPO_ROOT } from '@kbn/utils'; + +interface RepoPath { + /** repo-relative path to the file */ + repoRel: string; + /** absolute path to the file */ + abs: string; +} + +/** + * List the files in the repo, only including files which are manged by version + * control or "untracked" (new, not committed, and not ignored). + * @param include limit the list to specfic absolute paths + * @param exclude exclude specific absolute paths + */ +export async function getRepoFiles(include?: string[], exclude?: string[]) { + const flags = [ + include?.map((p) => Path.relative(REPO_ROOT, p)) ?? [], + exclude?.map((p) => `--exclude=${Path.relative(REPO_ROOT, p)}`) ?? [], + ].flat(); + + const proc = await execa('git', ['ls-files', '-comt', '--exclude-standard', ...flags], { + cwd: REPO_ROOT, + stdio: ['ignore', 'pipe', 'pipe'], + buffer: true, + }); + + const paths = new Map(); + const files = new Set(); + + for (const line of proc.stdout.split('\n').map((l) => l.trim())) { + if (!line) { + continue; + } + + const repoRel = line.slice(2); // trim the single char status and separating space from the line + const existingPath = paths.get(repoRel); + const path = existingPath ?? { repoRel, abs: Path.resolve(REPO_ROOT, repoRel) }; + if (!existingPath) { + paths.set(repoRel, path); + } + + if (line.startsWith('C ')) { + // this line indicates that the previous path is changed in the working + // tree, so we need to determine if it was deleted and remove it if so + if (!Fs.existsSync(path.abs)) { + files.delete(path); + } + } else { + files.add(path); + } + } + + return files; +} diff --git a/packages/kbn-get-repo-files/src/index.ts b/packages/kbn-get-repo-files/src/index.ts new file mode 100644 index 0000000000000..7e633d1c9b381 --- /dev/null +++ b/packages/kbn-get-repo-files/src/index.ts @@ -0,0 +1,9 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export { getRepoFiles } from './get_repo_files'; diff --git a/packages/kbn-get-repo-files/tsconfig.json b/packages/kbn-get-repo-files/tsconfig.json new file mode 100644 index 0000000000000..789c6b3111115 --- /dev/null +++ b/packages/kbn-get-repo-files/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/kbn-logging/src/ecs/base.ts b/packages/kbn-logging/src/ecs/base.ts index 382770f6a59de..df633aa882c3a 100644 --- a/packages/kbn-logging/src/ecs/base.ts +++ b/packages/kbn-logging/src/ecs/base.ts @@ -13,7 +13,7 @@ */ export interface EcsBase { ['@timestamp']: string; - labels?: Record; + labels?: Record; message?: string; tags?: string[]; } diff --git a/packages/kbn-logging/src/ecs/container.ts b/packages/kbn-logging/src/ecs/container.ts index ecd8575f5b75d..52997b9e0ec55 100644 --- a/packages/kbn-logging/src/ecs/container.ts +++ b/packages/kbn-logging/src/ecs/container.ts @@ -15,9 +15,11 @@ export interface EcsContainer { cpu?: { usage?: number }; disk?: Disk; id?: string; - image?: { name?: string; tag?: string[] }; - labels?: Record; + image?: Image; + labels?: Record; + memory?: { usage?: number }; name?: string; + network?: Network; runtime?: string; } @@ -25,3 +27,14 @@ interface Disk { read?: { bytes?: number }; write?: { bytes?: number }; } + +interface Image { + hash?: { all: string[] }; + name?: string; + tag?: string[]; +} + +interface Network { + egress?: { bytes?: number }; + ingress?: { bytes?: number }; +} diff --git a/packages/kbn-logging/src/ecs/dll.ts b/packages/kbn-logging/src/ecs/dll.ts index 3440afa9cfad2..863afda6453ee 100644 --- a/packages/kbn-logging/src/ecs/dll.ts +++ b/packages/kbn-logging/src/ecs/dll.ts @@ -8,12 +8,10 @@ import { EcsCodeSignature } from './code_signature'; import { EcsHash } from './hash'; -import { EcsPe } from './pe'; interface NestedFields { code_signature?: EcsCodeSignature; hash?: EcsHash; - pe?: EcsPe; } /** diff --git a/packages/kbn-logging/src/ecs/dns.ts b/packages/kbn-logging/src/ecs/dns.ts index b271999295fe7..efca3750127d0 100644 --- a/packages/kbn-logging/src/ecs/dns.ts +++ b/packages/kbn-logging/src/ecs/dns.ts @@ -13,7 +13,7 @@ */ export interface EcsDns { answers?: Answer[]; - header_flags?: string[]; + header_flags?: HeaderFlags[]; id?: number; op_code?: string; question?: Question; @@ -22,6 +22,8 @@ export interface EcsDns { type?: string; } +type HeaderFlags = 'AA' | 'TC' | 'RD' | 'RA' | 'AD' | 'CD' | 'DO'; + interface Answer { data: string; class?: string; diff --git a/packages/kbn-logging/src/ecs/event.ts b/packages/kbn-logging/src/ecs/event.ts index ab4aed15c87e4..212a04526c709 100644 --- a/packages/kbn-logging/src/ecs/event.ts +++ b/packages/kbn-logging/src/ecs/event.ts @@ -48,6 +48,7 @@ export type EcsEventCategory = | 'configuration' | 'database' | 'driver' + | 'email' | 'file' | 'host' | 'iam' diff --git a/packages/kbn-logging/src/ecs/faas.ts b/packages/kbn-logging/src/ecs/faas.ts new file mode 100644 index 0000000000000..0fd4048955d3c --- /dev/null +++ b/packages/kbn-logging/src/ecs/faas.ts @@ -0,0 +1,26 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +/** + * https://www.elastic.co/guide/en/ecs/master/ecs-faas.html + * + * @internal + */ +export interface EcsFaas { + coldstart?: boolean; + execution?: string; + id?: string; + name?: string; + trigger?: Trigger; + version?: string; +} + +interface Trigger { + request_id?: string; + type?: 'http' | 'pubsub' | 'datasource' | 'timer' | 'other'; +} diff --git a/packages/kbn-logging/src/ecs/file.ts b/packages/kbn-logging/src/ecs/file.ts index e406a4f8b1664..09a7d33f0105d 100644 --- a/packages/kbn-logging/src/ecs/file.ts +++ b/packages/kbn-logging/src/ecs/file.ts @@ -9,14 +9,12 @@ import { EcsCodeSignature } from './code_signature'; import { EcsElf } from './elf'; import { EcsHash } from './hash'; -import { EcsPe } from './pe'; import { EcsX509 } from './x509'; interface NestedFields { code_signature?: EcsCodeSignature; elf?: EcsElf; hash?: EcsHash; - pe?: EcsPe; x509?: EcsX509; } diff --git a/packages/kbn-logging/src/ecs/hash.ts b/packages/kbn-logging/src/ecs/hash.ts index ead7fc012df81..84b0216765b00 100644 --- a/packages/kbn-logging/src/ecs/hash.ts +++ b/packages/kbn-logging/src/ecs/hash.ts @@ -15,6 +15,8 @@ export interface EcsHash { md5?: string; sha1?: string; sha256?: string; + sha384?: string; sha512?: string; ssdeep?: string; + tlsh?: string; } diff --git a/packages/kbn-logging/src/ecs/host.ts b/packages/kbn-logging/src/ecs/host.ts index 2c5563120806a..a500367ced841 100644 --- a/packages/kbn-logging/src/ecs/host.ts +++ b/packages/kbn-logging/src/ecs/host.ts @@ -21,6 +21,7 @@ interface NestedFields { */ export interface EcsHost extends NestedFields { architecture?: string; + boot?: { id: string }; cpu?: { usage: number }; disk?: Disk; domain?: string; @@ -30,6 +31,7 @@ export interface EcsHost extends NestedFields { mac?: string[]; name?: string; network?: Network; + pid_ns_ino?: string; type?: string; uptime?: number; } diff --git a/packages/kbn-logging/src/ecs/index.ts b/packages/kbn-logging/src/ecs/index.ts index 4de36e25018a8..693e16c73a434 100644 --- a/packages/kbn-logging/src/ecs/index.ts +++ b/packages/kbn-logging/src/ecs/index.ts @@ -19,6 +19,7 @@ import { EcsDns } from './dns'; import { EcsEmail } from './email'; import { EcsError } from './error'; import { EcsEvent } from './event'; +import { EcsFaas } from './faas'; import { EcsFile } from './file'; import { EcsGroup } from './group'; import { EcsHost } from './host'; @@ -48,13 +49,13 @@ export type { EcsEventCategory, EcsEventKind, EcsEventOutcome, EcsEventType } fr interface EcsField { /** - * These typings were written as of ECS 8.0.0. + * These typings were written as of ECS 8.4.0. * Don't change this value without checking the rest * of the types to conform to that ECS version. * * https://www.elastic.co/guide/en/ecs/master/index.html */ - version: '8.0.0'; + version: '8.4.0'; } /** @@ -77,6 +78,7 @@ export type Ecs = EcsBase & email?: EcsEmail; error?: EcsError; event?: EcsEvent; + faas?: EcsFaas; file?: EcsFile; group?: EcsGroup; host?: EcsHost; diff --git a/packages/kbn-logging/src/ecs/log.ts b/packages/kbn-logging/src/ecs/log.ts index 4f796d25fa407..13b7654fdeded 100644 --- a/packages/kbn-logging/src/ecs/log.ts +++ b/packages/kbn-logging/src/ecs/log.ts @@ -25,7 +25,13 @@ interface Origin { } interface Syslog { + appname?: string; facility?: { code?: number; name?: string }; + hostname?: string; + msgid?: string; priority?: number; + procid?: string; severity?: { code?: number; name?: string }; + structured_data?: Record; + version?: string; } diff --git a/packages/kbn-logging/src/ecs/network.ts b/packages/kbn-logging/src/ecs/network.ts index c736cdeec248a..9f225eb73c40b 100644 --- a/packages/kbn-logging/src/ecs/network.ts +++ b/packages/kbn-logging/src/ecs/network.ts @@ -22,7 +22,7 @@ export interface EcsNetwork extends NestedFields { application?: string; bytes?: number; community_id?: string; - direction?: string; + direction?: Direction; forwarded_ip?: string; iana_number?: string; name?: string; @@ -31,3 +31,12 @@ export interface EcsNetwork extends NestedFields { transport?: string; type?: string; } + +type Direction = + | 'ingress' + | 'egress' + | 'inbound' + | 'outbound' + | 'internal' + | 'external' + | 'unknown'; diff --git a/packages/kbn-logging/src/ecs/orchestrator.ts b/packages/kbn-logging/src/ecs/orchestrator.ts index bfc9656f869c6..87ede628bdeb9 100644 --- a/packages/kbn-logging/src/ecs/orchestrator.ts +++ b/packages/kbn-logging/src/ecs/orchestrator.ts @@ -21,12 +21,16 @@ export interface EcsOrchestrator { } interface Cluster { + id?: string; name?: string; url?: string; version?: string; } interface Resource { + id?: string; + ip?: string[]; name?: string; + parent?: { type: string }; type?: string; } diff --git a/packages/kbn-logging/src/ecs/os.ts b/packages/kbn-logging/src/ecs/os.ts index f0fda34606dcc..d4830df618ed2 100644 --- a/packages/kbn-logging/src/ecs/os.ts +++ b/packages/kbn-logging/src/ecs/os.ts @@ -17,6 +17,6 @@ export interface EcsOs { kernel?: string; name?: string; platform?: string; - type?: string; + type?: 'linux' | 'macos' | 'unix' | 'windows'; version?: string; } diff --git a/packages/kbn-logging/src/ecs/pe.ts b/packages/kbn-logging/src/ecs/pe.ts index 53a21ce7662ce..b4b8be422a97d 100644 --- a/packages/kbn-logging/src/ecs/pe.ts +++ b/packages/kbn-logging/src/ecs/pe.ts @@ -18,5 +18,6 @@ export interface EcsPe { file_version?: string; imphash?: string; original_file_name?: string; + pehash?: string; product?: string; } diff --git a/packages/kbn-logging/src/ecs/process.ts b/packages/kbn-logging/src/ecs/process.ts index 317d50453d9d5..8a83875025d84 100644 --- a/packages/kbn-logging/src/ecs/process.ts +++ b/packages/kbn-logging/src/ecs/process.ts @@ -8,16 +8,32 @@ import { EcsCodeSignature } from './code_signature'; import { EcsElf } from './elf'; +import { EcsGroup } from './group'; import { EcsHash } from './hash'; -import { EcsPe } from './pe'; +import { EcsSource } from './source'; +import { EcsUser } from './user'; interface NestedFields { code_signature?: EcsCodeSignature; elf?: EcsElf; + entry_leader?: EcsProcess; + group?: EcsGroup; + group_leader?: EcsProcess; hash?: EcsHash; parent?: EcsProcess; - pe?: EcsPe; - target?: EcsProcess; + previous?: EcsProcess; + real_group?: EcsGroup; + real_user?: EcsUser; + saved_group?: EcsGroup; + saved_user?: EcsUser; + session_leader?: EcsProcess & { entry_meta?: EntryMeta }; + supplemental_groups?: EcsGroup; + user?: EcsUser; +} + +interface EntryMeta { + type?: string; + source?: EcsSource; } /** @@ -31,6 +47,7 @@ export interface EcsProcess extends NestedFields { command_line?: string; end?: string; entity_id?: string; + env_vars?: Record; executable?: string; exit_code?: number; name?: string; diff --git a/packages/kbn-logging/src/ecs/service.ts b/packages/kbn-logging/src/ecs/service.ts index 1d81077f21ed1..52ab6f117c22a 100644 --- a/packages/kbn-logging/src/ecs/service.ts +++ b/packages/kbn-logging/src/ecs/service.ts @@ -17,8 +17,13 @@ export interface EcsService { ephemeral_id?: string; id?: string; name?: string; - node?: { name: string }; + node?: Node; state?: string; type?: string; version?: string; } + +interface Node { + name?: string; + roles?: string[]; +} diff --git a/packages/kbn-logging/src/ecs/threat.ts b/packages/kbn-logging/src/ecs/threat.ts index 7c01808a316ba..bba86fdbf128f 100644 --- a/packages/kbn-logging/src/ecs/threat.ts +++ b/packages/kbn-logging/src/ecs/threat.ts @@ -30,6 +30,7 @@ interface IndicatorNestedFields { export interface EcsThreat { enrichments?: Enrichment[]; indicator?: Indicator; + feed?: Feed; framework?: string; group?: Group; software?: Software; @@ -43,20 +44,31 @@ interface Enrichment { } interface Indicator extends IndicatorNestedFields { - confidence?: string; + confidence?: 'Not Specified' | 'None' | 'Low' | 'Medium' | 'High'; description?: string; email?: { address?: string }; first_seen?: string; ip?: string; last_seen?: string; - marking?: { tlp?: string }; + marking?: Marking; modified_at?: string; port?: number; provider?: string; reference?: string; scanner_stats?: number; sightings?: number; - type?: string; + type?: IndicatorType; +} + +interface Feed { + dashboard_id?: string; + description?: string; + name?: string; + reference?: string; +} + +interface Marking { + tlp?: 'WHITE' | 'GREEN' | 'AMBER' | 'RED'; } interface Matched { @@ -77,11 +89,23 @@ interface Group { interface Software { id?: string; name?: string; - platforms?: string[]; + platforms?: SoftwarePlatforms[]; reference?: string; - type?: string; + type?: 'Malware' | 'Tool'; } +type SoftwarePlatforms = + | 'AWS' + | 'Azure' + | 'Azure AD' + | 'GCP' + | 'Linux' + | 'macOS' + | 'Network' + | 'Office 365' + | 'SaaS' + | 'Windows'; + interface Tactic { id?: string[]; name?: string[]; @@ -94,3 +118,22 @@ interface Technique { reference?: string[]; subtechnique?: Technique; } + +type IndicatorType = + | 'autonomous-system' + | 'artifact' + | 'directory' + | 'domain-name' + | 'email-addr' + | 'file' + | 'ipv4-addr' + | 'ipv6-addr' + | 'mac-addr' + | 'mutex' + | 'port' + | 'process' + | 'software' + | 'url' + | 'user-account' + | 'windows-registry-key' + | 'x509-certificate'; diff --git a/packages/kbn-mapbox-gl/src/index.ts b/packages/kbn-mapbox-gl/src/index.ts index 481702b15771b..815dbe0b604d7 100644 --- a/packages/kbn-mapbox-gl/src/index.ts +++ b/packages/kbn-mapbox-gl/src/index.ts @@ -12,6 +12,7 @@ import type { Source, GeoJSONSource, VectorTileSource, + RasterTileSource, StyleSpecification, MapEvent, MapOptions, @@ -48,6 +49,7 @@ export type { Source, GeoJSONSource, VectorTileSource, + RasterTileSource, MapEvent, MapOptions, MapMouseEvent, diff --git a/packages/kbn-optimizer/limits.yml b/packages/kbn-optimizer/limits.yml index 1044cae862fe0..955ec123c1626 100644 --- a/packages/kbn-optimizer/limits.yml +++ b/packages/kbn-optimizer/limits.yml @@ -32,7 +32,7 @@ pageLoadAssetSize: inputControlVis: 172675 inspector: 148711 kibanaOverview: 56279 - lens: 35000 + lens: 36000 licenseManagement: 41817 licensing: 29004 lists: 22900 diff --git a/packages/kbn-repo-source-classifier-cli/BUILD.bazel b/packages/kbn-repo-source-classifier-cli/BUILD.bazel new file mode 100644 index 0000000000000..6f4db611221cd --- /dev/null +++ b/packages/kbn-repo-source-classifier-cli/BUILD.bazel @@ -0,0 +1,128 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "kbn-repo-source-classifier-cli" +PKG_REQUIRE_NAME = "@kbn/repo-source-classifier-cli" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ + "//packages/kbn-dev-cli-runner", + "//packages/kbn-dev-cli-errors", + "//packages/kbn-import-resolver", + "//packages/kbn-repo-source-classifier", + "//packages/kbn-get-repo-files", + "//packages/kbn-utils", +] + +# In this array place dependencies necessary to build the types, which will include the +# :npm_module_types target of other packages and packages from NPM, including @types/* +# packages. +# +# To reference the types for another package use: +# "//repo/relative/path/to/package:npm_module_types" +# eg. "//packages/kbn-utils:npm_module_types" +# +# References to NPM packages work the same as RUNTIME_DEPS +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "//packages/kbn-dev-cli-runner:npm_module_types", + "//packages/kbn-dev-cli-errors:npm_module_types", + "//packages/kbn-import-resolver:npm_module_types", + "//packages/kbn-repo-source-classifier:npm_module_types", + "//packages/kbn-get-repo-files:npm_module_types", + "//packages/kbn-utils:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/kbn-repo-source-classifier-cli/README.md b/packages/kbn-repo-source-classifier-cli/README.md new file mode 100644 index 0000000000000..bd85562b70251 --- /dev/null +++ b/packages/kbn-repo-source-classifier-cli/README.md @@ -0,0 +1,3 @@ +# @kbn/repo-source-classifier-cli + +CLI for debugging the repo source classifier, run to see how the classifier identifies your files. Use `node scripts/classify_source --help` for more info. \ No newline at end of file diff --git a/packages/kbn-repo-source-classifier-cli/jest.config.js b/packages/kbn-repo-source-classifier-cli/jest.config.js new file mode 100644 index 0000000000000..4fd0edec3b7a7 --- /dev/null +++ b/packages/kbn-repo-source-classifier-cli/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../..', + roots: ['/packages/kbn-repo-source-classifier-cli'], +}; diff --git a/packages/kbn-repo-source-classifier-cli/package.json b/packages/kbn-repo-source-classifier-cli/package.json new file mode 100644 index 0000000000000..47ca9f6598f93 --- /dev/null +++ b/packages/kbn-repo-source-classifier-cli/package.json @@ -0,0 +1,10 @@ +{ + "name": "@kbn/repo-source-classifier-cli", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0", + "kibana": { + "devOnly": true + } +} diff --git a/packages/kbn-repo-source-classifier-cli/src/index.ts b/packages/kbn-repo-source-classifier-cli/src/index.ts new file mode 100644 index 0000000000000..0e741b98bb6d6 --- /dev/null +++ b/packages/kbn-repo-source-classifier-cli/src/index.ts @@ -0,0 +1,90 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import Path from 'path'; + +import { RepoSourceClassifier } from '@kbn/repo-source-classifier'; +import { ImportResolver } from '@kbn/import-resolver'; +import { REPO_ROOT } from '@kbn/utils'; +import { getRepoFiles } from '@kbn/get-repo-files'; +import { run } from '@kbn/dev-cli-runner'; +import { createFlagError } from '@kbn/dev-cli-errors'; + +import { TypeTree } from './type_tree'; + +run( + async ({ flags }) => { + const resolver = ImportResolver.create(REPO_ROOT); + const classifier = new RepoSourceClassifier(resolver); + + const include = flags._.length ? flags._ : [process.cwd()]; + let exclude; + if (flags.exclude) { + if (Array.isArray(flags.exclude)) { + exclude = flags.exclude; + } else if (typeof flags.exclude === 'string') { + exclude = [flags.exclude]; + } else { + throw createFlagError('expected --exclude value to be a string'); + } + } + + const typeFlags = String(flags.types) + .split(',') + .map((f) => f.trim()) + .filter(Boolean); + + const includeTypes: string[] = []; + const excludeTypes: string[] = []; + for (const type of typeFlags) { + if (type.startsWith('!')) { + excludeTypes.push(type.slice(1)); + } else { + includeTypes.push(type); + } + } + + const tree = new TypeTree(); + const cwd = process.cwd(); + for (const { abs } of await getRepoFiles(include, exclude)) { + const { type } = classifier.classify(abs); + if ((includeTypes.length && !includeTypes.includes(type)) || excludeTypes.includes(type)) { + continue; + } + + tree.add(type, Path.relative(cwd, abs)); + } + + if (!!flags.flat) { + for (const file of tree.toList()) { + process.stdout.write(`${file}\n`); + } + } else { + process.stdout.write(tree.print({ expand: !!flags.expand })); + } + }, + { + description: 'run the repo-source-classifier on the source files and produce a report', + usage: `node scripts/classify_source <...paths>`, + flags: { + string: ['exclude', 'types'], + boolean: ['expand', 'flat'], + help: ` + <...paths> include paths to select specific files which should be reported + by default all files in the cwd are classified. Can be specified + multiple times + --exclude exclude specific paths from the classification. Can be specified + multiple times + --types limit the types reported to the types in this comma separated list + to exclude a type prefix it with ! + --expand prevent collapsing entries that are of the same type + --flat just print file names + `, + }, + } +); diff --git a/packages/kbn-repo-source-classifier-cli/src/type_tree.ts b/packages/kbn-repo-source-classifier-cli/src/type_tree.ts new file mode 100644 index 0000000000000..749a9057de478 --- /dev/null +++ b/packages/kbn-repo-source-classifier-cli/src/type_tree.ts @@ -0,0 +1,104 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { ModuleType } from '@kbn/repo-source-classifier'; +import normalizePath from 'normalize-path'; + +type RecursiveTypes = Map; + +interface PrintOpts { + expand: boolean; +} + +export class TypeTree { + private dirs = new Map(); + private files = new Map(); + + constructor(public readonly path: string[] = []) {} + + add(type: ModuleType, rel: string) { + const segs = normalizePath(rel).split('/').filter(Boolean); + + let node: TypeTree = this; + const path = []; + for (const dirSeg of segs.slice(0, -1)) { + path.push(dirSeg); + const existing = node.dirs.get(dirSeg); + if (existing) { + node = existing; + } else { + const newDir = new TypeTree([...node.path, dirSeg]); + node.dirs.set(dirSeg, newDir); + node = newDir; + } + } + + const filename = segs.at(-1); + if (!filename) { + throw new Error(`invalid rel path [${rel}]`); + } + + node.files.set(filename, type); + } + + flatten(options: PrintOpts): ModuleType | RecursiveTypes { + const entries: RecursiveTypes = new Map([ + ...[...this.dirs].map(([name, dir]) => [name, dir.flatten(options)] as const), + ...this.files, + ]); + + if (!options.expand) { + const types = new Set(entries.values()); + const [firstType] = types; + if (types.size === 1 && typeof firstType === 'string') { + return firstType; + } + } + + return entries; + } + + print(options: PrintOpts) { + const tree = this.flatten(options); + + if (typeof tree === 'string') { + return `${this.path.join('/')}: ${tree}`; + } + + const lines: string[] = []; + const print = (prefix: string, types: RecursiveTypes) => { + for (const [name, childTypes] of types) { + if (typeof childTypes === 'string') { + lines.push(`${prefix}${name}: ${childTypes}`); + } else { + lines.push(`${prefix}${name}/`); + print(` ${prefix}`, childTypes); + } + } + }; + + print('', tree); + return lines.join('\n') + '\n'; + } + + toList() { + const files: string[] = []; + const getFiles = (tree: TypeTree) => { + for (const dir of tree.dirs.values()) { + getFiles(dir); + } + for (const filename of tree.files.keys()) { + files.push([...tree.path, filename].join('/')); + } + }; + + getFiles(this); + + return files.sort((a, b) => a.localeCompare(b)); + } +} diff --git a/packages/kbn-repo-source-classifier-cli/tsconfig.json b/packages/kbn-repo-source-classifier-cli/tsconfig.json new file mode 100644 index 0000000000000..789c6b3111115 --- /dev/null +++ b/packages/kbn-repo-source-classifier-cli/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/packages/kbn-repo-source-classifier/BUILD.bazel b/packages/kbn-repo-source-classifier/BUILD.bazel new file mode 100644 index 0000000000000..f3b1b08026b68 --- /dev/null +++ b/packages/kbn-repo-source-classifier/BUILD.bazel @@ -0,0 +1,119 @@ +load("@npm//@bazel/typescript:index.bzl", "ts_config") +load("@build_bazel_rules_nodejs//:index.bzl", "js_library") +load("//src/dev/bazel:index.bzl", "jsts_transpiler", "pkg_npm", "pkg_npm_types", "ts_project") + +PKG_DIRNAME = "kbn-repo-source-classifier" +PKG_REQUIRE_NAME = "@kbn/repo-source-classifier" + +SOURCE_FILES = glob( + [ + "src/**/*.ts", + ], + exclude = [ + "**/*.test.*", + "**/*.stories.*", + ], +) + +SRCS = SOURCE_FILES + +filegroup( + name = "srcs", + srcs = SRCS, +) + +NPM_MODULE_EXTRA_FILES = [ + "package.json", +] + +# In this array place runtime dependencies, including other packages and NPM packages +# which must be available for this code to run. +# +# To reference other packages use: +# "//repo/relative/path/to/package" +# eg. "//packages/kbn-utils" +# +# To reference a NPM package use: +# "@npm//name-of-package" +# eg. "@npm//lodash" +RUNTIME_DEPS = [ +] + +# In this array place dependencies necessary to build the types, which will include the +# :npm_module_types target of other packages and packages from NPM, including @types/* +# packages. +# +# To reference the types for another package use: +# "//repo/relative/path/to/package:npm_module_types" +# eg. "//packages/kbn-utils:npm_module_types" +# +# References to NPM packages work the same as RUNTIME_DEPS +TYPES_DEPS = [ + "@npm//@types/node", + "@npm//@types/jest", + "@npm//normalize-path", + "//packages/kbn-import-resolver:npm_module_types", + "//packages/kbn-utils:npm_module_types", +] + +jsts_transpiler( + name = "target_node", + srcs = SRCS, + build_pkg_name = package_name(), +) + +ts_config( + name = "tsconfig", + src = "tsconfig.json", + deps = [ + "//:tsconfig.base.json", + "//:tsconfig.bazel.json", + ], +) + +ts_project( + name = "tsc_types", + args = ['--pretty'], + srcs = SRCS, + deps = TYPES_DEPS, + declaration = True, + declaration_map = True, + emit_declaration_only = True, + out_dir = "target_types", + root_dir = "src", + tsconfig = ":tsconfig", +) + +js_library( + name = PKG_DIRNAME, + srcs = NPM_MODULE_EXTRA_FILES, + deps = RUNTIME_DEPS + [":target_node"], + package_name = PKG_REQUIRE_NAME, + visibility = ["//visibility:public"], +) + +pkg_npm( + name = "npm_module", + deps = [":" + PKG_DIRNAME], +) + +filegroup( + name = "build", + srcs = [":npm_module"], + visibility = ["//visibility:public"], +) + +pkg_npm_types( + name = "npm_module_types", + srcs = SRCS, + deps = [":tsc_types"], + package_name = PKG_REQUIRE_NAME, + tsconfig = ":tsconfig", + visibility = ["//visibility:public"], +) + +filegroup( + name = "build_types", + srcs = [":npm_module_types"], + visibility = ["//visibility:public"], +) diff --git a/packages/kbn-repo-source-classifier/README.mdx b/packages/kbn-repo-source-classifier/README.mdx new file mode 100644 index 0000000000000..2f197aa83a0c8 --- /dev/null +++ b/packages/kbn-repo-source-classifier/README.mdx @@ -0,0 +1,31 @@ +--- +id: kibDevDocsOpsRepoSourceClassifier +slug: /kibana-dev-docs/ops/repo-source-classifier +title: "@kbn/repo-source-classifier" +description: 'The tool which classifies source files into categories' +date: 2022-07-25 +tags: ['kibana', 'dev', 'contributor', 'operations', 'packages', 'scripts'] +--- + +This package exposes a class which can be used to efficiently classify all of the files in the repository into one of the following groups: + +- `server package`: plugin code in the root `server/` directory, eventually this will include packages of type `server-plugin` or `server-shared` + - `browser package`: plugin code in the root `public/` directory (and a few others in specific plugins), eventually this will include packages of type `browser-plugin` or `browser-shared` + - `common packages`: includes any existing package, plugin code in root `common/` directories, (and a few others in specific plugins), Eventually this will include `common-shared` packages + - `tests or mocks`: code that is loaded by jest/storybook, and mocks/helpers intended for use by that code. These files usually live along side package code but will have a separate dependency tree and are pieces of code which should never end up in the product. + - `static`: static files, currently any .json file or things loaded via `raw-loader` in browser code + - `tooling`: scripts, config files for tools like eslint, webpack, etc. + - `non-package`: code that lives outside of packages/plugins or doesn't fit into other more specific categories. Once the package project is complete this category should be limited to just `@kbn/pm` + +This is a map of types to the types they are allowed to import: + - `non-package`: `non-package`, `server package`, `browser package`, `common package` or `static` + - `server package`: `common package`, `server package`, or `static` + - `browser package`: `common package`, `browser package`, or `static` + - `common package`: `common package` or`static` + - `static`: static files are not allowed to have dependencies + - `tests or mocks`: anything + - `tooling`: anything + +The `RepoSourceClassifier` class implements several caches to make these lookups as efficient as possible in ESLint when all imports across the entire repository are validated. This cache lasts for the lifetime of the class and to invalidate the cache the object should just be discarded and a new instance created. + +A CLI is provided for inspecting the results of the classifier, check out `node scripts/classify_source --help` for more information about usage. \ No newline at end of file diff --git a/packages/kbn-repo-source-classifier/jest.config.js b/packages/kbn-repo-source-classifier/jest.config.js new file mode 100644 index 0000000000000..f7c33b8886805 --- /dev/null +++ b/packages/kbn-repo-source-classifier/jest.config.js @@ -0,0 +1,13 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../..', + roots: ['/packages/kbn-repo-source-classifier'], +}; diff --git a/packages/kbn-repo-source-classifier/package.json b/packages/kbn-repo-source-classifier/package.json new file mode 100644 index 0000000000000..fce2be1b056ed --- /dev/null +++ b/packages/kbn-repo-source-classifier/package.json @@ -0,0 +1,10 @@ +{ + "name": "@kbn/repo-source-classifier", + "private": true, + "version": "1.0.0", + "main": "./target_node/index.js", + "license": "SSPL-1.0 OR Elastic License 2.0", + "kibana": { + "devOnly": true + } +} diff --git a/packages/kbn-repo-source-classifier/src/config.ts b/packages/kbn-repo-source-classifier/src/config.ts new file mode 100644 index 0000000000000..6f6b9251988c0 --- /dev/null +++ b/packages/kbn-repo-source-classifier/src/config.ts @@ -0,0 +1,59 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +// file names which indicate that the file is a testing file +export const RANDOM_TEST_FILE_NAMES = new Set([ + 'jest_setup', + 'test_data', + 'test_helper', + 'test_helpers', + 'stubs', + 'test_utils', + 'test_utilities', + 'rtl_helpers', + 'enzyme_helpers', + 'fixtures', + 'testbed', +]); + +// tags are found in filenames after a `.`, like `name.tag.ts` +export const TEST_TAG = new Set([ + 'test', + 'mock', + 'mocks', + 'stories', + 'story', + 'stub', + 'fixture', + 'story_decorators', + 'test_helpers', +]); + +// directories where test specific files are assumed to live, any file in a directory with these names is assumed to be test related +export const TEST_DIR = new Set([ + 'cypress', + 'test', + 'tests', + 'testing', + 'mock', + 'mocks', + '__jest__', + '__mock__', + '__test__', + '__mocks__', + '__stories__', + '__fixtures__', + '__snapshots__', + 'stub', + 'e2e', + 'ftr_e2e', + 'storybook', + '.storybook', + 'integration_tests', + ...RANDOM_TEST_FILE_NAMES, +]); diff --git a/packages/home/sample_data_cards/src/index.ts b/packages/kbn-repo-source-classifier/src/index.ts similarity index 57% rename from packages/home/sample_data_cards/src/index.ts rename to packages/kbn-repo-source-classifier/src/index.ts index 4fb818179963c..fe68410208388 100644 --- a/packages/home/sample_data_cards/src/index.ts +++ b/packages/kbn-repo-source-classifier/src/index.ts @@ -6,8 +6,5 @@ * Side Public License, v 1. */ -export { SampleDataCards } from './sample_data_cards'; -export { SampleDataCard } from './sample_data_card'; -export type { Props as SampleDataCardProps } from './sample_data_card'; - -export { SampleDataCardsKibanaProvider, SampleDataCardsProvider } from './services'; +export type { ModuleType } from './module_type'; +export { RepoSourceClassifier } from './repo_source_classifier'; diff --git a/packages/kbn-repo-source-classifier/src/module_id.ts b/packages/kbn-repo-source-classifier/src/module_id.ts new file mode 100644 index 0000000000000..ed79978a77994 --- /dev/null +++ b/packages/kbn-repo-source-classifier/src/module_id.ts @@ -0,0 +1,19 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { ModuleType } from './module_type'; +import { PkgInfo } from './pkg_info'; + +export interface ModuleId { + /** Type of the module */ + type: ModuleType; + /** repo relative path to the module's source file */ + repoRel: string; + /** info about the package the source file is within, in the case the file is found within a package */ + pkgInfo?: PkgInfo; +} diff --git a/packages/kbn-repo-source-classifier/src/module_type.ts b/packages/kbn-repo-source-classifier/src/module_type.ts new file mode 100644 index 0000000000000..f614e4180b8b4 --- /dev/null +++ b/packages/kbn-repo-source-classifier/src/module_type.ts @@ -0,0 +1,16 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export type ModuleType = + | 'non-package' + | 'tests or mocks' + | 'static' + | 'tooling' + | 'server package' + | 'browser package' + | 'common package'; diff --git a/packages/kbn-repo-source-classifier/src/pkg_info.ts b/packages/kbn-repo-source-classifier/src/pkg_info.ts new file mode 100644 index 0000000000000..89d66092737b4 --- /dev/null +++ b/packages/kbn-repo-source-classifier/src/pkg_info.ts @@ -0,0 +1,16 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +export interface PkgInfo { + /** id of the package this file is from */ + pkgId: string; + /** Relative path to a file within a package directory */ + rel: string; + /** Absolute path to the package directory */ + pkgDir: string; +} diff --git a/packages/kbn-repo-source-classifier/src/repo_path.ts b/packages/kbn-repo-source-classifier/src/repo_path.ts new file mode 100644 index 0000000000000..05eef7105a717 --- /dev/null +++ b/packages/kbn-repo-source-classifier/src/repo_path.ts @@ -0,0 +1,102 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import Path from 'path'; + +import { REPO_ROOT } from '@kbn/utils'; +import { ImportResolver } from '@kbn/import-resolver'; +import normalizePath from 'normalize-path'; + +import { PkgInfo } from './pkg_info'; + +const getNormal = Path.sep === '/' ? (path: string) => path : normalizePath; + +/** + * A wraper around an absolute path in the repository. We create this object and bind it + * to a specific ImportResolver primarily so that we can use it as a key in WeakMap instances + * and make analysis as efficient as possible. + * + * Instead of managing many caches in a stateful class somewhere we instead write memoized + * functions which use weakmaps that are key'd off of a RepoPath instance. RepoPath instances + * are then cached by the overall classifier, and that instance can then be cached by + * the tool running analysis on the repository + */ +export class RepoPath { + constructor(public readonly absolute: string, public readonly resolver: ImportResolver) {} + + private extname: string | undefined; + /** Get the extention for this path */ + getExtname() { + if (this.extname === undefined) { + this.extname = Path.extname(this.absolute); + } + + return this.extname; + } + + private filename: string | undefined; + /** Get the filename, without the extension, for this path */ + getFilename() { + if (this.filename === undefined) { + this.filename = Path.basename(this.absolute, this.getExtname()); + } + + return this.filename; + } + + private repoRel: string | undefined; + /** get and cache the repo-relative version of the path */ + getRepoRel() { + if (this.repoRel === undefined) { + this.repoRel = getNormal(Path.relative(REPO_ROOT, this.absolute)); + } + + return this.repoRel; + } + + private segs: string[] | undefined; + /** get and cache the path segments from the repo-realtive versions of this path */ + getSegs() { + if (this.segs === undefined) { + this.segs = Path.dirname(this.getRepoRel()).split('/'); + } + + return this.segs; + } + + private pkgInfo: PkgInfo | null | undefined; + /** get and cache the package info for a path */ + getPkgInfo() { + if (this.pkgInfo === undefined) { + const pkgId = this.resolver.getPackageIdForPath(this.absolute); + if (!pkgId) { + this.pkgInfo = null; + } else { + const pkgDir = this.resolver.getAbsolutePackageDir(pkgId); + if (!pkgDir) { + throw new Error(`unable to get package directory for package [${pkgId}]`); + } + + const rel = getNormal(Path.relative(pkgDir, this.absolute)); + if (rel.startsWith(`../`)) { + throw new Error( + `path [${this.getRepoRel()}] does not apear to be within package [${pkgId}]` + ); + } + + this.pkgInfo = { + pkgDir, + pkgId, + rel, + }; + } + } + + return this.pkgInfo; + } +} diff --git a/packages/kbn-repo-source-classifier/src/repo_source_classifier.ts b/packages/kbn-repo-source-classifier/src/repo_source_classifier.ts new file mode 100644 index 0000000000000..745ca52385166 --- /dev/null +++ b/packages/kbn-repo-source-classifier/src/repo_source_classifier.ts @@ -0,0 +1,192 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { ImportResolver } from '@kbn/import-resolver'; +import { ModuleId } from './module_id'; +import { ModuleType } from './module_type'; +import { RANDOM_TEST_FILE_NAMES, TEST_DIR, TEST_TAG } from './config'; +import { RepoPath } from './repo_path'; + +export class RepoSourceClassifier { + constructor(private readonly resolver: ImportResolver) {} + + private repoPaths = new Map(); + private ids = new Map(); + + /** + * Get the cached repo path instance + */ + private getRepoPath(path: string) { + const cached = this.repoPaths.get(path); + + if (cached !== undefined) { + return cached; + } + + const rp = new RepoPath(path, this.resolver); + this.repoPaths.set(path, rp); + return rp; + } + + /** + * Is this a "test" file? + */ + private isTestFile(path: RepoPath) { + const name = path.getFilename(); + + if (name.startsWith('mock_') || RANDOM_TEST_FILE_NAMES.has(name)) { + return true; + } + + if (name.startsWith('_')) { + for (const tag of TEST_TAG) { + if (name.includes(tag)) { + return true; + } + } + } + + const tag = name.split('.').at(-1); + if (tag && TEST_TAG.has(tag)) { + return true; + } + + for (const seg of path.getSegs()) { + if (TEST_DIR.has(seg)) { + return true; + } + } + + return false; + } + + /** + * Is this a tooling file? + */ + private isToolingFile(path: RepoPath) { + const segs = path.getSegs(); + if ( + segs.includes('scripts') && + !path.getRepoRel().startsWith('src/plugins/data/server/scripts/') + ) { + return true; + } + + if (path.getFilename() === 'webpack.config' && path.getPkgInfo()?.pkgId !== '@kbn/optimizer') { + return true; + } + + return false; + } + + /** + * Apply canvas specific rules + * @param root the root dir within the canvas plugin + * @param dirs the directories after the root dir + * @returns a type, or undefined if the file should be classified as a standard file + */ + private classifyCanvas(root: string, dirs: string[]): ModuleType | undefined { + if (root === 'canvas_plugin_src') { + if (dirs[0] === 'expression_types') { + return 'common package'; + } + + const subRoot = dirs.slice(0, 2).join('/'); + if (subRoot === 'functions/external' || subRoot === 'functions/server') { + return 'server package'; + } + + return 'browser package'; + } + + if (root === 'i18n') { + return 'common package'; + } + + if (root === 'shareable_runtime') { + return 'non-package'; + } + + if (root === 'tasks') { + return 'tests or mocks'; + } + } + + /** + * Determine the "type" of a file + */ + private getType(path: RepoPath): ModuleType { + if (path.getExtname() === '.json') { + return 'static'; + } + + if (this.isTestFile(path)) { + return 'tests or mocks'; + } + + if (this.isToolingFile(path)) { + return 'tooling'; + } + + const pkgInfo = path.getPkgInfo(); + if (!pkgInfo) { + return 'non-package'; + } + + const { pkgId, rel } = pkgInfo; + const pkgIdWords = new Set(pkgId.split(/\W+/)); + // treat any package with "mocks" or "storybook" in the ID as a test-specific package + if (pkgIdWords.has('mocks') || pkgIdWords.has('storybook') || pkgIdWords.has('test')) { + return 'tests or mocks'; + } + + if (path.resolver.isBazelPackage(pkgId)) { + return 'common package'; + } + + const [root, ...dirs] = rel.split('/'); + + if (pkgId === '@kbn/core' && root === 'types') { + return 'common package'; + } + + if (pkgId === '@kbn/canvas-plugin') { + const type = this.classifyCanvas(root, dirs); + if (type) { + return type; + } + } + + if (root === 'public' || root === 'static') { + return 'browser package'; + } + + if (root === 'server') { + return 'server package'; + } + + return 'common package'; + } + + classify(absolute: string) { + const path = this.getRepoPath(absolute); + const cached = this.ids.get(path); + + if (cached) { + return cached; + } + + const id: ModuleId = { + type: this.getType(path), + repoRel: path.getRepoRel(), + pkgInfo: path.getPkgInfo() ?? undefined, + }; + this.ids.set(path, id); + return id; + } +} diff --git a/packages/kbn-repo-source-classifier/tsconfig.json b/packages/kbn-repo-source-classifier/tsconfig.json new file mode 100644 index 0000000000000..789c6b3111115 --- /dev/null +++ b/packages/kbn-repo-source-classifier/tsconfig.json @@ -0,0 +1,18 @@ +{ + "extends": "../../tsconfig.bazel.json", + "compilerOptions": { + "declaration": true, + "declarationMap": true, + "emitDeclarationOnly": true, + "outDir": "target_types", + "rootDir": "src", + "stripInternal": false, + "types": [ + "jest", + "node" + ] + }, + "include": [ + "src/**/*" + ] +} diff --git a/src/plugins/chart_expressions/expression_metric/public/utils/format.ts b/packages/kbn-securitysolution-es-utils/src/delete_index_template/index.ts similarity index 50% rename from src/plugins/chart_expressions/expression_metric/public/utils/format.ts rename to packages/kbn-securitysolution-es-utils/src/delete_index_template/index.ts index 80f5dec8151f6..b1f670f1f4e32 100644 --- a/src/plugins/chart_expressions/expression_metric/public/utils/format.ts +++ b/packages/kbn-securitysolution-es-utils/src/delete_index_template/index.ts @@ -6,16 +6,18 @@ * Side Public License, v 1. */ -import { FieldFormatsContentType, IFieldFormat } from '@kbn/field-formats-plugin/common'; +import type { ElasticsearchClient } from '../elasticsearch_client'; -export const formatValue = ( - value: number | string, - fieldFormatter: IFieldFormat, - format: FieldFormatsContentType = 'text' -) => { - if (typeof value === 'number' && isNaN(value)) { - return '-'; - } - - return fieldFormatter.convert(value, format); +export const deleteIndexTemplate = async ( + esClient: ElasticsearchClient, + name: string +): Promise => { + return ( + await esClient.indices.deleteIndexTemplate( + { + name, + }, + { meta: true } + ) + ).body; }; diff --git a/packages/kbn-securitysolution-es-utils/src/get_index_template_exists/index.ts b/packages/kbn-securitysolution-es-utils/src/get_index_template_exists/index.ts new file mode 100644 index 0000000000000..9bab77380e1f8 --- /dev/null +++ b/packages/kbn-securitysolution-es-utils/src/get_index_template_exists/index.ts @@ -0,0 +1,23 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { ElasticsearchClient } from '../elasticsearch_client'; + +export const getIndexTemplateExists = async ( + esClient: ElasticsearchClient, + template: string +): Promise => { + return ( + await esClient.indices.existsIndexTemplate( + { + name: template, + }, + { meta: true } + ) + ).body; +}; diff --git a/packages/kbn-securitysolution-es-utils/src/index.ts b/packages/kbn-securitysolution-es-utils/src/index.ts index a32cf8968967c..abcd32ee5adc9 100644 --- a/packages/kbn-securitysolution-es-utils/src/index.ts +++ b/packages/kbn-securitysolution-es-utils/src/index.ts @@ -10,6 +10,7 @@ export * from './bad_request_error'; export * from './create_boostrap_index'; export * from './decode_version'; export * from './delete_all_index'; +export * from './delete_index_template'; export * from './delete_policy'; export * from './delete_template'; export * from './encode_hit_version'; @@ -17,10 +18,12 @@ export * from './get_bootstrap_index_exists'; export * from './get_index_aliases'; export * from './get_index_count'; export * from './get_index_exists'; +export * from './get_index_template_exists'; export * from './get_policy_exists'; export * from './get_template_exists'; export * from './read_index'; export * from './read_privileges'; +export * from './set_index_template'; export * from './set_policy'; export * from './set_template'; export * from './transform_error'; diff --git a/packages/kbn-securitysolution-es-utils/src/set_index_template/index.ts b/packages/kbn-securitysolution-es-utils/src/set_index_template/index.ts new file mode 100644 index 0000000000000..12d98775f1dda --- /dev/null +++ b/packages/kbn-securitysolution-es-utils/src/set_index_template/index.ts @@ -0,0 +1,25 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import type { ElasticsearchClient } from '../elasticsearch_client'; + +export const setIndexTemplate = async ( + esClient: ElasticsearchClient, + name: string, + body: Record +): Promise => { + return ( + await esClient.indices.putIndexTemplate( + { + name, + body, + }, + { meta: true } + ) + ).body; +}; diff --git a/packages/kbn-securitysolution-io-ts-types/src/default_csv_array/index.test.ts b/packages/kbn-securitysolution-io-ts-types/src/default_csv_array/index.test.ts new file mode 100644 index 0000000000000..1f927565ca626 --- /dev/null +++ b/packages/kbn-securitysolution-io-ts-types/src/default_csv_array/index.test.ts @@ -0,0 +1,214 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import * as t from 'io-ts'; +import { pipe } from 'fp-ts/lib/pipeable'; +import { left } from 'fp-ts/lib/Either'; +import { foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; +import { defaultCsvArray } from '.'; + +describe('defaultCsvArray', () => { + describe('Creates a schema of an array that works in the following way:', () => { + type TestType = t.TypeOf; + const TestType = t.union( + [t.literal('foo'), t.literal('bar'), t.literal('42'), t.null, t.undefined], + 'TestType' + ); + + const TestCsvArray = defaultCsvArray(TestType); + + describe('Name of the schema', () => { + it('has a default value', () => { + const CsvArray = defaultCsvArray(TestType); + expect(CsvArray.name).toEqual('DefaultCsvArray'); + }); + + it('can be overriden', () => { + const CsvArray = defaultCsvArray(TestType, 'CustomName'); + expect(CsvArray.name).toEqual('CustomName'); + }); + }); + + describe('Validation succeeds', () => { + describe('when input is a single valid string value', () => { + const cases = [{ input: 'foo' }, { input: 'bar' }, { input: '42' }]; + + cases.forEach(({ input }) => { + it(`${input}`, () => { + const decoded = TestCsvArray.decode(input); + const message = pipe(decoded, foldLeftRight); + const expectedOutput = [input]; // note that it's an array after decode + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(expectedOutput); + }); + }); + }); + + describe('when input is an array of valid string values', () => { + const cases = [ + { input: ['foo'] }, + { input: ['foo', 'bar'] }, + { input: ['foo', 'bar', '42'] }, + ]; + + cases.forEach(({ input }) => { + it(`${input}`, () => { + const decoded = TestCsvArray.decode(input); + const message = pipe(decoded, foldLeftRight); + const expectedOutput = input; + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(expectedOutput); + }); + }); + }); + + describe('when input is a string which is a comma-separated array of valid values', () => { + const cases = [ + { + input: 'foo,bar', + expectedOutput: ['foo', 'bar'], + }, + { + input: 'foo,bar,42', + expectedOutput: ['foo', 'bar', '42'], + }, + ]; + + cases.forEach(({ input, expectedOutput }) => { + it(`${input}`, () => { + const decoded = TestCsvArray.decode(input); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(expectedOutput); + }); + }); + }); + }); + + describe('Validation fails', () => { + describe('when input is a single invalid value', () => { + const cases = [ + { + input: 'val', + expectedErrors: ['Invalid value "val" supplied to "DefaultCsvArray"'], + }, + { + input: '5', + expectedErrors: ['Invalid value "5" supplied to "DefaultCsvArray"'], + }, + { + input: 5, + expectedErrors: ['Invalid value "5" supplied to "DefaultCsvArray"'], + }, + { + input: {}, + expectedErrors: ['Invalid value "{}" supplied to "DefaultCsvArray"'], + }, + ]; + + cases.forEach(({ input, expectedErrors }) => { + it(`${input}`, () => { + const decoded = TestCsvArray.decode(input); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual(expectedErrors); + expect(message.schema).toEqual({}); + }); + }); + }); + + describe('when input is an array of invalid values', () => { + const cases = [ + { + input: ['value 1', 5], + expectedErrors: [ + 'Invalid value "value 1" supplied to "DefaultCsvArray"', + 'Invalid value "5" supplied to "DefaultCsvArray"', + ], + }, + { + input: ['value 1', 'foo'], + expectedErrors: ['Invalid value "value 1" supplied to "DefaultCsvArray"'], + }, + { + input: ['', 5, {}], + expectedErrors: [ + 'Invalid value "" supplied to "DefaultCsvArray"', + 'Invalid value "5" supplied to "DefaultCsvArray"', + 'Invalid value "{}" supplied to "DefaultCsvArray"', + ], + }, + ]; + + cases.forEach(({ input, expectedErrors }) => { + it(`${input}`, () => { + const decoded = TestCsvArray.decode(input); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual(expectedErrors); + expect(message.schema).toEqual({}); + }); + }); + }); + + describe('when input is a string which is a comma-separated array of invalid values', () => { + const cases = [ + { + input: 'value 1,5', + expectedErrors: [ + 'Invalid value "value 1" supplied to "DefaultCsvArray"', + 'Invalid value "5" supplied to "DefaultCsvArray"', + ], + }, + { + input: 'value 1,foo', + expectedErrors: ['Invalid value "value 1" supplied to "DefaultCsvArray"'], + }, + { + input: ',5,{}', + expectedErrors: [ + 'Invalid value "" supplied to "DefaultCsvArray"', + 'Invalid value "5" supplied to "DefaultCsvArray"', + 'Invalid value "{}" supplied to "DefaultCsvArray"', + ], + }, + ]; + + cases.forEach(({ input, expectedErrors }) => { + it(`${input}`, () => { + const decoded = TestCsvArray.decode(input); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual(expectedErrors); + expect(message.schema).toEqual({}); + }); + }); + }); + }); + + describe('Validation returns default value (an empty array)', () => { + describe('when input is', () => { + const cases = [{ input: null }, { input: undefined }, { input: '' }, { input: [] }]; + + cases.forEach(({ input }) => { + it(`${input}`, () => { + const decoded = TestCsvArray.decode(input); + const message = pipe(decoded, foldLeftRight); + const expectedOutput: string[] = []; + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(expectedOutput); + }); + }); + }); + }); + }); +}); diff --git a/packages/kbn-securitysolution-io-ts-types/src/default_csv_array/index.ts b/packages/kbn-securitysolution-io-ts-types/src/default_csv_array/index.ts new file mode 100644 index 0000000000000..0f9a7b859409b --- /dev/null +++ b/packages/kbn-securitysolution-io-ts-types/src/default_csv_array/index.ts @@ -0,0 +1,48 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import * as t from 'io-ts'; +import { Either } from 'fp-ts/lib/Either'; + +/** + * Creates a schema of an array that works in the following way: + * - If input is a CSV string, it will be parsed to an array which will be validated. + * - If input is an array, each item is validated to match `itemSchema`. + * - If input is a single string, it is validated to match `itemSchema`. + * - If input is not specified, the result will be set to [] (empty array): + * - null, undefined, empty string, empty array + * + * In all cases when an input is valid, the resulting decoded value will be an array, + * either an empty one or containing valid items. + * + * @param itemSchema Schema of the array's items. + * @param name (Optional) Name of the resulting schema. + */ +export const defaultCsvArray = ( + itemSchema: t.Type, + name?: string +): t.Type => { + return new t.Type( + name ?? `DefaultCsvArray<${itemSchema.name}>`, + t.array(itemSchema).is, + (input, context): Either => { + if (input == null) { + return t.success([]); + } else if (typeof input === 'string') { + if (input === '') { + return t.success([]); + } else { + return t.array(itemSchema).validate(input.split(','), context); + } + } else { + return t.array(itemSchema).validate(input, context); + } + }, + t.identity + ); +}; diff --git a/packages/kbn-securitysolution-io-ts-types/src/default_value/index.test.ts b/packages/kbn-securitysolution-io-ts-types/src/default_value/index.test.ts new file mode 100644 index 0000000000000..0fc5e7584d944 --- /dev/null +++ b/packages/kbn-securitysolution-io-ts-types/src/default_value/index.test.ts @@ -0,0 +1,106 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import * as t from 'io-ts'; +import { pipe } from 'fp-ts/lib/pipeable'; +import { left } from 'fp-ts/lib/Either'; +import { foldLeftRight, getPaths } from '@kbn/securitysolution-io-ts-utils'; +import { defaultValue } from '.'; + +describe('defaultValue', () => { + describe('Creates a schema that sets a default value if the input value is not specified', () => { + type TestType = t.TypeOf; + const TestType = t.union([t.string, t.number, t.null, t.undefined], 'TestType'); + + const DefaultValue = defaultValue(TestType, 42); + + describe('Name of the schema', () => { + it('has a default value', () => { + expect(defaultValue(TestType, 42).name).toEqual('DefaultValue'); + }); + + it('can be overriden', () => { + expect(defaultValue(TestType, 42, 'CustomName').name).toEqual('CustomName'); + }); + }); + + describe('Validation succeeds', () => { + describe('when input is a valid value', () => { + const cases = [ + { input: 'foo' }, + { input: '42' }, + { input: 42 }, + // including all "falsey" values which are not null or undefined + { input: '' }, + { input: 0 }, + ]; + + cases.forEach(({ input }) => { + it(`${input}`, () => { + const decoded = DefaultValue.decode(input); + const message = pipe(decoded, foldLeftRight); + const expectedOutput = input; + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(expectedOutput); + }); + }); + }); + }); + + describe('Validation fails', () => { + describe('when input is an invalid value', () => { + const cases = [ + { + input: {}, + expectedErrors: ['Invalid value "{}" supplied to "DefaultValue"'], + }, + { + input: { foo: 42 }, + expectedErrors: ['Invalid value "{"foo":42}" supplied to "DefaultValue"'], + }, + { + input: [], + expectedErrors: ['Invalid value "[]" supplied to "DefaultValue"'], + }, + { + input: ['foo', 42], + expectedErrors: ['Invalid value "["foo",42]" supplied to "DefaultValue"'], + }, + ]; + + cases.forEach(({ input, expectedErrors }) => { + it(`${input}`, () => { + const decoded = DefaultValue.decode(input); + const message = pipe(decoded, foldLeftRight); + + expect(getPaths(left(message.errors))).toEqual(expectedErrors); + expect(message.schema).toEqual({}); + }); + }); + }); + }); + + describe('Validation returns specified default value', () => { + describe('when input is', () => { + const cases = [{ input: null }, { input: undefined }]; + + cases.forEach(({ input }) => { + it(`${input}`, () => { + const decoded = DefaultValue.decode(input); + const message = pipe(decoded, foldLeftRight); + const expectedOutput = 42; + + expect(getPaths(left(message.errors))).toEqual([]); + expect(message.schema).toEqual(expectedOutput); + }); + }); + }); + }); + }); +}); diff --git a/packages/kbn-securitysolution-io-ts-types/src/default_value/index.ts b/packages/kbn-securitysolution-io-ts-types/src/default_value/index.ts new file mode 100644 index 0000000000000..1785225202820 --- /dev/null +++ b/packages/kbn-securitysolution-io-ts-types/src/default_value/index.ts @@ -0,0 +1,31 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import * as t from 'io-ts'; +import type { Either } from 'fp-ts/lib/Either'; + +/** + * Creates a schema that sets a default value if the input value is not specified. + * + * @param valueSchema Base schema of a value. + * @param value Default value to set. + * @param name (Optional) Name of the resulting schema. + */ +export const defaultValue = ( + valueSchema: t.Type, + value: TValue, + name?: string +): t.Type => { + return new t.Type( + name ?? `DefaultValue<${valueSchema.name}>`, + valueSchema.is, + (input, context): Either => + input == null ? t.success(value) : valueSchema.validate(input, context), + t.identity + ); +}; diff --git a/packages/kbn-securitysolution-io-ts-types/src/index.ts b/packages/kbn-securitysolution-io-ts-types/src/index.ts index 01f9b32ca31af..8d701d6994322 100644 --- a/packages/kbn-securitysolution-io-ts-types/src/index.ts +++ b/packages/kbn-securitysolution-io-ts-types/src/index.ts @@ -9,10 +9,12 @@ export * from './default_array'; export * from './default_boolean_false'; export * from './default_boolean_true'; +export * from './default_csv_array'; export * from './default_empty_string'; export * from './default_string_array'; export * from './default_string_boolean_false'; export * from './default_uuid'; +export * from './default_value'; export * from './default_version_number'; export * from './empty_string_array'; export * from './enumeration'; diff --git a/packages/kbn-securitysolution-list-utils/src/helpers/index.ts b/packages/kbn-securitysolution-list-utils/src/helpers/index.ts index 3c0fea8577353..adbffa3c728ef 100644 --- a/packages/kbn-securitysolution-list-utils/src/helpers/index.ts +++ b/packages/kbn-securitysolution-list-utils/src/helpers/index.ts @@ -44,6 +44,9 @@ import { isOneOfOperator, isOperator, DETECTION_ENGINE_EXCEPTION_OPERATORS, + isNotOneOfOperator, + isInListOperator, + isNotInListOperator, } from '../autocomplete_operators'; import { @@ -668,6 +671,10 @@ export const getEntryOnOperatorChange = ( } }; +const fieldSupportsMatches = (field: DataViewFieldBase) => { + return field.type === 'string'; +}; + /** * Determines which operators to make available * @@ -691,9 +698,31 @@ export const getOperatorOptions = ( } else if (isBoolean) { return [isOperator, isNotOperator, existsOperator, doesNotExistOperator]; } else if (!includeValueListOperators) { - return EXCEPTION_OPERATORS_SANS_LISTS; + return fieldSupportsMatches(item.field) + ? EXCEPTION_OPERATORS_SANS_LISTS + : [ + isOperator, + isNotOperator, + isOneOfOperator, + isNotOneOfOperator, + existsOperator, + doesNotExistOperator, + ]; } else { - return listType === 'detection' ? DETECTION_ENGINE_EXCEPTION_OPERATORS : ALL_OPERATORS; + return listType === 'detection' + ? fieldSupportsMatches(item.field) + ? DETECTION_ENGINE_EXCEPTION_OPERATORS + : [ + isOperator, + isNotOperator, + isOneOfOperator, + isNotOneOfOperator, + existsOperator, + doesNotExistOperator, + isInListOperator, + isNotInListOperator, + ] + : ALL_OPERATORS; } }; diff --git a/packages/kbn-test/BUILD.bazel b/packages/kbn-test/BUILD.bazel index b854379eb536b..26cf9174d5936 100644 --- a/packages/kbn-test/BUILD.bazel +++ b/packages/kbn-test/BUILD.bazel @@ -87,6 +87,7 @@ TYPES_DEPS = [ "//packages/kbn-utils:npm_module_types", "//packages/kbn-tooling-log:npm_module_types", "//packages/kbn-bazel-packages:npm_module_types", + "//packages/kbn-get-repo-files:npm_module_types", "@npm//@elastic/elasticsearch", "@npm//@jest/console", "@npm//@jest/reporters", diff --git a/packages/kbn-test/src/jest/configs/get_all_jest_paths.ts b/packages/kbn-test/src/jest/configs/get_all_jest_paths.ts index 63a829225ca60..336e28bd16fd5 100644 --- a/packages/kbn-test/src/jest/configs/get_all_jest_paths.ts +++ b/packages/kbn-test/src/jest/configs/get_all_jest_paths.ts @@ -6,12 +6,10 @@ * Side Public License, v 1. */ -import Fs from 'fs'; import Path from 'path'; -import execa from 'execa'; import minimatch from 'minimatch'; -import { REPO_ROOT } from '@kbn/utils'; +import { getRepoFiles } from '@kbn/get-repo-files'; // @ts-expect-error jest-preset is necessarily a JS file import { testMatch } from '../../../jest-preset'; @@ -19,51 +17,31 @@ import { testMatch } from '../../../jest-preset'; const UNIT_CONFIG_NAME = 'jest.config.js'; const INTEGRATION_CONFIG_NAME = 'jest.integration.config.js'; -export async function getAllJestPaths() { - const proc = await execa('git', ['ls-files', '-comt', '--exclude-standard'], { - cwd: REPO_ROOT, - stdio: ['ignore', 'pipe', 'pipe'], - buffer: true, - }); +const testsRe = (testMatch as string[]).map((p) => minimatch.makeRe(p)); - const testsRe = (testMatch as string[]).map((p) => minimatch.makeRe(p)); - const classify = (rel: string) => { - if (testsRe.some((re) => re.test(rel))) { - return 'test' as const; - } +const classify = (rel: string) => { + if (testsRe.some((re) => re.test(rel))) { + return 'test' as const; + } - const basename = Path.basename(rel); - return basename === UNIT_CONFIG_NAME || basename === INTEGRATION_CONFIG_NAME - ? ('config' as const) - : undefined; - }; + const basename = Path.basename(rel); + return basename === UNIT_CONFIG_NAME || basename === INTEGRATION_CONFIG_NAME + ? ('config' as const) + : undefined; +}; +export async function getAllJestPaths() { const tests = new Set(); const configs = new Set(); - for (const line of proc.stdout.split('\n').map((l) => l.trim())) { - if (!line) { - continue; - } - - const rel = line.slice(2); // trim the single char status from the line - const type = classify(rel); - - if (!type) { - continue; - } - - const set = type === 'test' ? tests : configs; - const abs = Path.resolve(REPO_ROOT, rel); - - if (line.startsWith('C ')) { - // this line indicates that the previous path is changed in the working tree, so we need to determine if - // it was deleted, and if so, remove it from the set we added it to - if (!Fs.existsSync(abs)) { - set.delete(abs); - } - } else { - set.add(abs); + for (const { repoRel, abs } of await getRepoFiles()) { + switch (classify(repoRel)) { + case 'test': + tests.add(abs); + break; + case 'config': + configs.add(abs); + break; } } diff --git a/scripts/classify_source.js b/scripts/classify_source.js new file mode 100644 index 0000000000000..c73f339a1786a --- /dev/null +++ b/scripts/classify_source.js @@ -0,0 +1,11 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +require('../src/setup_node_env/ensure_node_preserve_symlinks'); +require('source-map-support/register'); +require('@kbn/repo-source-classifier-cli'); diff --git a/src/core/public/index.ts b/src/core/public/index.ts index ad7e37e5e4551..3da80ef78bc54 100644 --- a/src/core/public/index.ts +++ b/src/core/public/index.ts @@ -128,31 +128,33 @@ export type { NavigateToUrlOptions, } from './application'; -export { SimpleSavedObject } from './saved_objects'; -export type { ResolvedSimpleSavedObject } from './saved_objects'; +export { SimpleSavedObjectImpl } from './saved_objects'; export type { + SavedObjectsClientContract, + SimpleSavedObject, + SavedObjectsCreateOptions, + SavedObjectsDeleteOptions, SavedObjectsBatchResponse, - SavedObjectsBulkCreateObject, - SavedObjectsBulkCreateOptions, - SavedObjectsBulkResolveObject, - SavedObjectsBulkResolveResponse, + SavedObjectsFindOptions, + SavedObjectsFindOptionsReference, + SavedObjectsUpdateOptions, + ResolvedSimpleSavedObject, SavedObjectsBulkUpdateObject, + SavedObjectsFindResponse, + SavedObjectsBulkCreateOptions, SavedObjectsBulkUpdateOptions, - SavedObjectsCreateOptions, - SavedObjectsFindResponsePublic, - SavedObjectsResolveResponse, - SavedObjectsUpdateOptions, + SavedObjectsBulkResolveResponse, + SavedObjectsBulkCreateObject, +} from '@kbn/core-saved-objects-api-browser'; +export type { SavedObject, + SavedObjectTypeIdTuple, SavedObjectAttribute, SavedObjectAttributes, SavedObjectAttributeSingle, SavedObjectError, SavedObjectReference, - SavedObjectsBaseOptions, - SavedObjectsFindOptions, - SavedObjectsFindOptionsReference, SavedObjectsMigrationVersion, - SavedObjectsClientContract, SavedObjectsImportResponse, SavedObjectsImportSuccess, SavedObjectsImportConflictError, @@ -166,9 +168,7 @@ export type { SavedObjectsImportSimpleWarning, SavedObjectsImportActionRequiredWarning, SavedObjectsImportWarning, - SavedObjectReferenceWithContext, - SavedObjectsCollectMultiNamespaceReferencesResponse, -} from './saved_objects'; +} from '@kbn/core-saved-objects-common'; export type { HttpHeadersInit, diff --git a/src/core/public/saved_objects/index.ts b/src/core/public/saved_objects/index.ts index 1880948225010..cb3ab31cea5c8 100644 --- a/src/core/public/saved_objects/index.ts +++ b/src/core/public/saved_objects/index.ts @@ -5,53 +5,8 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ -export { SavedObjectsService } from './saved_objects_service'; -export type { - SavedObjectsBatchResponse, - SavedObjectsBulkCreateObject, - SavedObjectsBulkCreateOptions, - SavedObjectsBulkUpdateObject, - SavedObjectsClient, - SavedObjectsClientContract, - SavedObjectsCreateOptions, - SavedObjectsFindResponsePublic, - SavedObjectsUpdateOptions, - SavedObjectsBulkUpdateOptions, - SavedObjectsBulkResolveResponse, -} from './saved_objects_client'; -export { SimpleSavedObject } from './simple_saved_object'; -export type { ResolvedSimpleSavedObject } from './types'; +export { SavedObjectsService } from './saved_objects_service'; +export type { SavedObjectsClient } from './saved_objects_client'; +export { SimpleSavedObjectImpl } from './simple_saved_object'; export type { SavedObjectsStart } from './saved_objects_service'; -export type { - SavedObjectsBaseOptions, - SavedObjectsFindOptions, - SavedObjectsFindOptionsReference, - SavedObjectsMigrationVersion, - SavedObjectsImportResponse, - SavedObjectsImportSuccess, - SavedObjectsImportConflictError, - SavedObjectsImportAmbiguousConflictError, - SavedObjectsImportUnsupportedTypeError, - SavedObjectsImportMissingReferencesError, - SavedObjectsImportUnknownError, - SavedObjectsImportFailure, - SavedObjectsImportRetry, - SavedObjectsNamespaceType, - SavedObjectsImportSimpleWarning, - SavedObjectsImportActionRequiredWarning, - SavedObjectsImportWarning, - SavedObjectReferenceWithContext, - SavedObjectsCollectMultiNamespaceReferencesResponse, - SavedObjectsBulkResolveObject, - SavedObjectsResolveResponse, -} from '../../server'; - -export type { - SavedObject, - SavedObjectAttribute, - SavedObjectAttributes, - SavedObjectAttributeSingle, - SavedObjectError, - SavedObjectReference, -} from '../../types'; diff --git a/src/core/public/saved_objects/saved_objects_client.test.ts b/src/core/public/saved_objects/saved_objects_client.test.ts index ebc58218eb9d1..77391343cd033 100644 --- a/src/core/public/saved_objects/saved_objects_client.test.ts +++ b/src/core/public/saved_objects/saved_objects_client.test.ts @@ -8,7 +8,7 @@ import { httpServiceMock } from '@kbn/core-http-browser-mocks'; import { SavedObjectsClient } from './saved_objects_client'; -import { SimpleSavedObject } from './simple_saved_object'; +import { SimpleSavedObjectImpl as SimpleSavedObject } from './simple_saved_object'; describe('SavedObjectsClient', () => { const doc = { diff --git a/src/core/public/saved_objects/saved_objects_client.ts b/src/core/public/saved_objects/saved_objects_client.ts index 69e51557baa07..3a16030983fa9 100644 --- a/src/core/public/saved_objects/saved_objects_client.ts +++ b/src/core/public/saved_objects/saved_objects_client.ts @@ -8,113 +8,33 @@ import { pick, throttle, cloneDeep } from 'lodash'; import type { HttpSetup, HttpFetchOptions } from '@kbn/core-http-browser'; - +import type { SavedObject, SavedObjectTypeIdTuple } from '@kbn/core-saved-objects-common'; import type { - SavedObject, - SavedObjectReference, SavedObjectsBulkResolveResponse as SavedObjectsBulkResolveResponseServer, SavedObjectsClientContract as SavedObjectsApi, - SavedObjectsFindOptions as SavedObjectFindOptionsServer, - SavedObjectsMigrationVersion, + SavedObjectsFindResponse as SavedObjectsFindResponseServer, SavedObjectsResolveResponse, -} from '../../server'; - -import { SimpleSavedObject } from './simple_saved_object'; -import type { ResolvedSimpleSavedObject } from './types'; +} from '@kbn/core-saved-objects-api-server'; +import type { + SavedObjectsClientContract, + SavedObjectsCreateOptions, + SavedObjectsDeleteOptions, + SavedObjectsBatchResponse, + SavedObjectsFindOptions, + SavedObjectsUpdateOptions, + ResolvedSimpleSavedObject, + SavedObjectsBulkUpdateObject, + SavedObjectsFindResponse, + SavedObjectsBulkCreateOptions, + SavedObjectsBulkCreateObject, + SimpleSavedObject, +} from '@kbn/core-saved-objects-api-browser'; + +import { SimpleSavedObjectImpl } from './simple_saved_object'; type PromiseType> = T extends Promise ? U : never; -type SavedObjectsFindOptions = Omit< - SavedObjectFindOptionsServer, - 'pit' | 'rootSearchFields' | 'searchAfter' | 'sortOrder' | 'typeToNamespacesMap' ->; - -type SavedObjectsFindResponse = Omit>, 'pit_id'>; - -/** @public */ -export interface SavedObjectsCreateOptions { - /** - * (Not recommended) Specify an id instead of having the saved objects service generate one for you. - */ - id?: string; - /** If a document with the given `id` already exists, overwrite it's contents (default=false). */ - overwrite?: boolean; - /** {@inheritDoc SavedObjectsMigrationVersion} */ - migrationVersion?: SavedObjectsMigrationVersion; - /** A semver value that is used when upgrading objects between Kibana versions. */ - coreMigrationVersion?: string; - references?: SavedObjectReference[]; -} - -/** - * @param type - Create a SavedObject of the given type - * @param attributes - Create a SavedObject with the given attributes - * - * @public - */ -export interface SavedObjectsBulkCreateObject extends SavedObjectsCreateOptions { - type: string; - attributes: T; -} - -/** @public */ -export interface SavedObjectsBulkCreateOptions { - /** If a document with the given `id` already exists, overwrite it's contents (default=false). */ - overwrite?: boolean; -} - -/** @public */ -export interface SavedObjectsBulkUpdateObject { - type: string; - id: string; - attributes: T; - version?: string; - references?: SavedObjectReference[]; -} - -/** @public */ -export interface SavedObjectsBulkUpdateOptions { - namespace?: string; -} - -/** @public */ -export interface SavedObjectsUpdateOptions { - version?: string; - upsert?: Attributes; - references?: SavedObjectReference[]; -} - -/** @public */ -export interface SavedObjectsBatchResponse { - savedObjects: Array>; -} - -/** @public */ -export interface SavedObjectsDeleteOptions { - /** Force deletion of an object that exists in multiple namespaces */ - force?: boolean; -} - -/** @public */ -export interface SavedObjectsBulkResolveResponse { - resolved_objects: Array>; -} - -/** - * Return type of the Saved Objects `find()` method. - * - * *Note*: this type is different between the Public and Server Saved Objects - * clients. - * - * @public - */ -export interface SavedObjectsFindResponsePublic - extends SavedObjectsBatchResponse { - aggregations?: A; - total: number; - perPage: number; - page: number; -} +type SavedObjectsFindResponseInternal = Omit; interface BatchGetQueueEntry { type: string; @@ -144,149 +64,8 @@ const BATCH_INTERVAL = 100; const API_BASE_URL = '/api/saved_objects/'; -/** - * The client-side SavedObjectsClient is a thin convenience library around the SavedObjects - * HTTP API for interacting with Saved Objects. - * - * @public - */ -export interface SavedObjectsClientContract { - /** - * Persists an object - */ - create( - type: string, - attributes: T, - options?: SavedObjectsCreateOptions - ): Promise>; - - /** - * Creates multiple documents at once - * @returns The result of the create operation containing created saved objects. - */ - bulkCreate( - objects: SavedObjectsBulkCreateObject[], - options?: SavedObjectsBulkCreateOptions - ): Promise>; - - /** - * Deletes an object - */ - delete(type: string, id: string, options?: SavedObjectsDeleteOptions): Promise<{}>; - - /** - * Search for objects - * - * @param {object} [options={}] - * @property {string} options.type - * @property {string} options.search - * @property {string} options.searchFields - see Elasticsearch Simple Query String - * Query field argument for more information - * @property {integer} [options.page=1] - * @property {integer} [options.perPage=20] - * @property {array} options.fields - * @property {object} [options.hasReference] - { type, id } - * @returns A find result with objects matching the specified search. - */ - find( - options: SavedObjectsFindOptions - ): Promise>; - - /** - * Fetches a single object - * - * @param {string} type - * @param {string} id - * @returns The saved object for the given type and id. - */ - get(type: string, id: string): Promise>; - - /** - * Returns an array of objects by id - * - * @param {array} objects - an array ids, or an array of objects containing id and optionally type - * @returns The saved objects with the given type and ids requested - * @example - * - * bulkGet([ - * { id: 'one', type: 'config' }, - * { id: 'foo', type: 'index-pattern' } - * ]) - */ - bulkGet( - objects: Array<{ id: string; type: string }> - ): Promise>; - - /** - * Resolves a single object - * - * @param {string} type - * @param {string} id - * @returns The resolve result for the saved object for the given type and id. - * - * @note Saved objects that Kibana fails to find are replaced with an error object and an "exactMatch" outcome. The rationale behind the - * outcome is that "exactMatch" is the default outcome, and the outcome only changes if an alias is found. This behavior for the `resolve` - * API is unique to the public client, which batches individual calls with `bulkResolve` under the hood. We don't throw an error in that - * case for legacy compatibility reasons. - */ - resolve(type: string, id: string): Promise>; - - /** - * Resolves an array of objects by id, using any legacy URL aliases if they exist - * - * @param objects - an array of objects containing id, type - * @returns The bulk resolve result for the saved objects for the given types and ids. - * @example - * - * bulkResolve([ - * { id: 'one', type: 'config' }, - * { id: 'foo', type: 'index-pattern' } - * ]) - * - * @note Saved objects that Kibana fails to find are replaced with an error object and an "exactMatch" outcome. The rationale behind the - * outcome is that "exactMatch" is the default outcome, and the outcome only changes if an alias is found. The `resolve` method in the - * public client uses `bulkResolve` under the hood, so it behaves the same way. - */ - bulkResolve( - objects: Array<{ id: string; type: string }> - ): Promise>; - - /** - * Updates an object - * - * @param {string} type - * @param {string} id - * @param {object} attributes - * @param {object} options - * @prop {integer} options.version - ensures version matches that of persisted object - * @prop {object} options.migrationVersion - The optional migrationVersion of this document - * @returns - */ - update( - type: string, - id: string, - attributes: T, - options?: SavedObjectsUpdateOptions - ): Promise>; - - /** - * Update multiple documents at once - * - * @param {array} objects - [{ type, id, attributes, options: { version, references } }] - * @returns The result of the update operation containing both failed and updated saved objects. - */ - bulkUpdate( - objects: SavedObjectsBulkUpdateObject[] - ): Promise>; -} - -interface ObjectTypeAndId { - id: string; - type: string; -} - -const getObjectsToFetch = (queue: BatchGetQueueEntry[]): ObjectTypeAndId[] => { - const objects: ObjectTypeAndId[] = []; +const getObjectsToFetch = (queue: BatchGetQueueEntry[]): SavedObjectTypeIdTuple[] => { + const objects: SavedObjectTypeIdTuple[] = []; const inserted = new Set(); queue.forEach(({ id, type }) => { if (!inserted.has(`${type}|${id}`)) { @@ -299,7 +78,7 @@ const getObjectsToFetch = (queue: BatchGetQueueEntry[]): ObjectTypeAndId[] => { const getObjectsToResolve = (queue: BatchResolveQueueEntry[]) => { const responseIndices: number[] = []; - const objectsToResolve: ObjectTypeAndId[] = []; + const objectsToResolve: SavedObjectTypeIdTuple[] = []; const inserted = new Map(); queue.forEach(({ id, type }) => { const key = `${type}|${id}`; @@ -478,7 +257,7 @@ export class SavedObjectsClient implements SavedObjectsClientContract { public find = ( options: SavedObjectsFindOptions - ): Promise> => { + ): Promise> => { const path = this.getPath(['_find']); const renameMap = { defaultSearchOperator: 'default_search_operator', @@ -520,7 +299,7 @@ export class SavedObjectsClient implements SavedObjectsClientContract { query, }); return request.then((resp) => { - return renameKeys( + return renameKeys( { aggregations: 'aggregations', saved_objects: 'savedObjects', @@ -532,7 +311,7 @@ export class SavedObjectsClient implements SavedObjectsClientContract { ...resp, saved_objects: resp.saved_objects.map((d) => this.createSavedObject(d)), } - ) as SavedObjectsFindResponsePublic; + ) as SavedObjectsFindResponse; }); }; @@ -558,7 +337,7 @@ export class SavedObjectsClient implements SavedObjectsClientContract { }); }; - private async performBulkGet(objects: ObjectTypeAndId[]) { + private async performBulkGet(objects: SavedObjectTypeIdTuple[]) { const path = this.getPath(['_bulk_get']); const request: ReturnType = this.savedObjectsFetch(path, { method: 'POST', @@ -591,7 +370,7 @@ export class SavedObjectsClient implements SavedObjectsClientContract { }; }; - private async performBulkResolve(objects: ObjectTypeAndId[]) { + private async performBulkResolve(objects: SavedObjectTypeIdTuple[]) { const path = this.getPath(['_bulk_resolve']); const request: Promise> = this.savedObjectsFetch( path, @@ -645,13 +424,13 @@ export class SavedObjectsClient implements SavedObjectsClientContract { } private createSavedObject(options: SavedObject): SimpleSavedObject { - return new SimpleSavedObject(this, options); + return new SimpleSavedObjectImpl(this, options); } private createResolvedSavedObject( resolveResponse: SavedObjectsResolveResponse ): ResolvedSimpleSavedObject { - const simpleSavedObject = new SimpleSavedObject(this, resolveResponse.saved_object); + const simpleSavedObject = new SimpleSavedObjectImpl(this, resolveResponse.saved_object); return { saved_object: simpleSavedObject, outcome: resolveResponse.outcome, diff --git a/src/core/public/saved_objects/saved_objects_service.ts b/src/core/public/saved_objects/saved_objects_service.ts index 59550f58af69a..776e35700a0af 100644 --- a/src/core/public/saved_objects/saved_objects_service.ts +++ b/src/core/public/saved_objects/saved_objects_service.ts @@ -8,7 +8,8 @@ import type { CoreService } from '@kbn/core-base-browser-internal'; import type { HttpStart } from '@kbn/core-http-browser'; -import { SavedObjectsClient, type SavedObjectsClientContract } from './saved_objects_client'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-browser'; +import { SavedObjectsClient } from './saved_objects_client'; /** * @public @@ -20,8 +21,10 @@ export interface SavedObjectsStart { export class SavedObjectsService implements CoreService { public async setup() {} + public async start({ http }: { http: HttpStart }): Promise { return { client: new SavedObjectsClient(http) }; } + public async stop() {} } diff --git a/src/core/public/saved_objects/simple_saved_object.test.ts b/src/core/public/saved_objects/simple_saved_object.test.ts index 432bc215a5b4c..7ffe708fd1e12 100644 --- a/src/core/public/saved_objects/simple_saved_object.test.ts +++ b/src/core/public/saved_objects/simple_saved_object.test.ts @@ -6,11 +6,11 @@ * Side Public License, v 1. */ -import { SavedObject } from '../../server'; -import { SimpleSavedObject } from './simple_saved_object'; -import { SavedObjectsClientContract } from './saved_objects_client'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-browser'; +import { SimpleSavedObjectImpl as SimpleSavedObject } from './simple_saved_object'; -describe('SimpleSavedObject', () => { +describe('SimpleSavedObjectImpl', () => { let client: SavedObjectsClientContract; beforeEach(() => { diff --git a/src/core/public/saved_objects/simple_saved_object.ts b/src/core/public/saved_objects/simple_saved_object.ts index 4daae92867538..89501c69dcfb5 100644 --- a/src/core/public/saved_objects/simple_saved_object.ts +++ b/src/core/public/saved_objects/simple_saved_object.ts @@ -8,21 +8,19 @@ import { set } from '@elastic/safer-lodash-set'; import { get, has } from 'lodash'; -import { SavedObject as SavedObjectType } from '../../server'; -import { SavedObjectsClientContract } from './saved_objects_client'; +import type { SavedObject as SavedObjectType } from '@kbn/core-saved-objects-common'; +import type { + SavedObjectsClientContract, + SimpleSavedObject, +} from '@kbn/core-saved-objects-api-browser'; /** - * This class is a very simple wrapper for SavedObjects loaded from the server - * with the {@link SavedObjectsClientContract}. + * Core internal implementation of {@link SimpleSavedObject} * - * It provides basic functionality for creating/saving/deleting saved objects, - * but doesn't include any type-specific implementations. - * - * @public + * @internal Should use the {@link SimpleSavedObject} interface instead */ -export class SimpleSavedObject { +export class SimpleSavedObjectImpl implements SimpleSavedObject { public attributes: T; - // We want to use the same interface this class had in JS public _version?: SavedObjectType['version']; public id: SavedObjectType['id']; public type: SavedObjectType['type']; @@ -31,10 +29,6 @@ export class SimpleSavedObject { public error: SavedObjectType['error']; public references: SavedObjectType['references']; public updatedAt: SavedObjectType['updated_at']; - /** - * Space(s) that this saved object exists in. This attribute is not used for "global" saved object types which are registered with - * `namespaceType: 'agnostic'`. - */ public namespaces: SavedObjectType['namespaces']; constructor( diff --git a/src/core/server/index.ts b/src/core/server/index.ts index b59df474a6865..27f57e10b9281 100644 --- a/src/core/server/index.ts +++ b/src/core/server/index.ts @@ -283,6 +283,27 @@ export { mergeSavedObjectMigrationMaps, } from './saved_objects'; +export type { + SavedObject, + SavedObjectAttribute, + SavedObjectAttributes, + SavedObjectAttributeSingle, + SavedObjectReference, + SavedObjectsMigrationVersion, + SavedObjectsImportConflictError, + SavedObjectsImportAmbiguousConflictError, + SavedObjectsImportFailure, + SavedObjectsImportMissingReferencesError, + SavedObjectsImportResponse, + SavedObjectsImportRetry, + SavedObjectsImportSuccess, + SavedObjectsImportUnknownError, + SavedObjectsImportUnsupportedTypeError, + SavedObjectsNamespaceType, + SavedObjectsImportSimpleWarning, + SavedObjectsImportActionRequiredWarning, + SavedObjectsImportWarning, +} from '@kbn/core-saved-objects-common'; export type { SavedObjectsBulkCreateObject, SavedObjectsBulkGetObject, @@ -292,42 +313,16 @@ export type { SavedObjectsBulkUpdateResponse, SavedObjectsCheckConflictsObject, SavedObjectsCheckConflictsResponse, - SavedObjectsClientProviderOptions, - SavedObjectsClientWrapperFactory, - SavedObjectsClientWrapperOptions, - SavedObjectsClientFactory, - SavedObjectsClientFactoryProvider, SavedObjectsClosePointInTimeOptions, SavedObjectsClosePointInTimeResponse, ISavedObjectsPointInTimeFinder, SavedObjectsCreatePointInTimeFinderDependencies, SavedObjectsCreatePointInTimeFinderOptions, SavedObjectsCreateOptions, - SavedObjectTypeExcludeFromUpgradeFilterHook, - SavedObjectsExportResultDetails, - SavedObjectsExportExcludedObject, SavedObjectsFindResult, SavedObjectsFindResponse, - SavedObjectsImportConflictError, - SavedObjectsImportAmbiguousConflictError, - SavedObjectsImportFailure, - SavedObjectsImportMissingReferencesError, - SavedObjectsImportOptions, - SavedObjectsImportResponse, - SavedObjectsImportRetry, - SavedObjectsImportSuccess, - SavedObjectsImportUnknownError, - SavedObjectsImportUnsupportedTypeError, - SavedObjectMigrationContext, - SavedObjectsMigrationLogger, SavedObjectsOpenPointInTimeOptions, SavedObjectsOpenPointInTimeResponse, - SavedObjectsRawDoc, - SavedObjectsRawDocParseOptions, - SavedObjectSanitizedDoc, - SavedObjectUnsanitizedDoc, - SavedObjectsRepositoryFactory, - SavedObjectsResolveImportErrorsOptions, SavedObjectsBulkResolveObject, SavedObjectsBulkResolveResponse, SavedObjectsResolveResponse, @@ -343,20 +338,44 @@ export type { SavedObjectsUpdateObjectsSpacesOptions, SavedObjectsUpdateObjectsSpacesResponse, SavedObjectsUpdateObjectsSpacesResponseObject, - SavedObjectsServiceStart, - SavedObjectsServiceSetup, - SavedObjectStatusMeta, SavedObjectsDeleteOptions, ISavedObjectsRepository, - SavedObjectsRepository, SavedObjectsDeleteByNamespaceOptions, SavedObjectsIncrementCounterOptions, SavedObjectsIncrementCounterField, + SavedObjectsBaseOptions, + MutatingOperationRefreshSetting, + SavedObjectsClientContract, + SavedObjectsFindOptions, + SavedObjectsFindOptionsReference, + SavedObjectsPitParams, +} from '@kbn/core-saved-objects-api-server'; +export type { + SavedObjectsClientProviderOptions, + SavedObjectsClientWrapperFactory, + SavedObjectsClientWrapperOptions, + SavedObjectsClientFactory, + SavedObjectsClientFactoryProvider, + SavedObjectTypeExcludeFromUpgradeFilterHook, + SavedObjectsExportResultDetails, + SavedObjectsExportExcludedObject, + SavedObjectsImportOptions, + SavedObjectMigrationContext, + SavedObjectsMigrationLogger, + SavedObjectsRawDoc, + SavedObjectsRawDocParseOptions, + SavedObjectSanitizedDoc, + SavedObjectUnsanitizedDoc, + SavedObjectsRepositoryFactory, + SavedObjectsResolveImportErrorsOptions, + SavedObjectsServiceStart, + SavedObjectsServiceSetup, + SavedObjectStatusMeta, + SavedObjectsRepository, SavedObjectsFieldMapping, SavedObjectsTypeMappingDefinition, SavedObjectsMappingProperties, ISavedObjectTypeRegistry, - SavedObjectsNamespaceType, SavedObjectsType, SavedObjectsTypeManagementDefinition, SavedObjectMigrationMap, @@ -374,9 +393,6 @@ export type { SavedObjectsImportError, SavedObjectsImportHook, SavedObjectsImportHookResult, - SavedObjectsImportSimpleWarning, - SavedObjectsImportActionRequiredWarning, - SavedObjectsImportWarning, SavedObjectsValidationMap, SavedObjectsValidationSpec, SavedObjectsRequestHandlerContext, @@ -418,21 +434,6 @@ export type { DeprecationsDetails } from '@kbn/core-deprecations-common'; export type { AppCategory } from '../types'; export { DEFAULT_APP_CATEGORIES, APP_WRAPPER_CLASS } from '../utils'; -export type { - SavedObject, - SavedObjectAttribute, - SavedObjectAttributes, - SavedObjectAttributeSingle, - SavedObjectReference, - SavedObjectsBaseOptions, - MutatingOperationRefreshSetting, - SavedObjectsClientContract, - SavedObjectsFindOptions, - SavedObjectsFindOptionsReference, - SavedObjectsPitParams, - SavedObjectsMigrationVersion, -} from './types'; - export { ServiceStatusLevels } from './status'; export type { CoreStatus, ServiceStatus, ServiceStatusLevel, StatusServiceSetup } from './status'; diff --git a/src/core/server/integration_tests/saved_objects/migrations/7_13_0_transform_failures.test.ts b/src/core/server/integration_tests/saved_objects/migrations/7_13_0_transform_failures.test.ts index b177332322c00..aaeb0f4359500 100644 --- a/src/core/server/integration_tests/saved_objects/migrations/7_13_0_transform_failures.test.ts +++ b/src/core/server/integration_tests/saved_objects/migrations/7_13_0_transform_failures.test.ts @@ -26,7 +26,8 @@ async function removeLogFile() { await asyncUnlink(logFilePath).catch(() => void 0); } -describe('migration v2', () => { +// FAILING ON 8.4: https://github.com/elastic/kibana/issues/137329 +describe.skip('migration v2', () => { let esServer: kbnTestServer.TestElasticsearchUtils; let root: Root; diff --git a/src/core/server/integration_tests/saved_objects/migrations/actions/actions.test.ts b/src/core/server/integration_tests/saved_objects/migrations/actions/actions.test.ts index 67dd9a54fa26f..13c3e8c9cff9a 100644 --- a/src/core/server/integration_tests/saved_objects/migrations/actions/actions.test.ts +++ b/src/core/server/integration_tests/saved_objects/migrations/actions/actions.test.ts @@ -16,7 +16,6 @@ import * as kbnTestServer from '../../../../../test_helpers/kbn_server'; import type { SavedObjectsRawDoc } from '../../../../saved_objects/serialization'; import { bulkOverwriteTransformedDocuments, - cloneIndex, closePit, createIndex, openPit, @@ -25,7 +24,7 @@ import { readWithPit, type ReadWithPit, searchForOutdatedDocuments, - SearchResponse, + type SearchResponse, setWriteBlock, updateAliases, waitForReindexTask, @@ -35,16 +34,17 @@ import { type UpdateByQueryResponse, updateAndPickupMappings, type UpdateAndPickupMappingsResponse, - verifyReindex, removeWriteBlock, transformDocs, - waitForIndexStatusYellow, + waitForIndexStatus, initAction, + cloneIndex, } from '../../../../saved_objects/migrations/actions'; import type { DocumentsTransformFailed, DocumentsTransformSuccess, } from '../../../../saved_objects/migrations/core'; +import { MIGRATION_CLIENT_OPTIONS } from '../../../../saved_objects/migrations/run_resilient_migrator'; const { startES } = kbnTestServer.createTestServers({ adjustTimeout: (t: number) => jest.setTimeout(t), @@ -63,7 +63,7 @@ describe('migration actions', () => { beforeAll(async () => { esServer = await startES(); - client = esServer.es.getClient(); + client = esServer.es.getClient().child(MIGRATION_CLIENT_OPTIONS); // Create test fixture data: await createIndex({ @@ -242,21 +242,21 @@ describe('migration actions', () => { expect.assertions(1); const task = setWriteBlock({ client, index: 'new_index_without_write_block' }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Right", - "right": "set_write_block_succeeded", - } - `); + Object { + "_tag": "Right", + "right": "set_write_block_succeeded", + } + `); }); it('resolves right when setting a write block on an index that already has one', async () => { expect.assertions(1); const task = setWriteBlock({ client, index: 'existing_index_with_write_block' }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Right", - "right": "set_write_block_succeeded", - } - `); + Object { + "_tag": "Right", + "right": "set_write_block_succeeded", + } + `); }); it('once resolved, prevents further writes to the index', async () => { expect.assertions(1); @@ -313,10 +313,10 @@ describe('migration actions', () => { expect.assertions(1); const task = removeWriteBlock({ client, index: 'existing_index_with_write_block_2' }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Right", - "right": "remove_write_block_succeeded", - } + Object { + "_tag": "Right", + "right": "remove_write_block_succeeded", + } `); }); it('resolves right if successful when an index does not have a write block', async () => { @@ -336,7 +336,7 @@ describe('migration actions', () => { }); }); - describe('waitForIndexStatusYellow', () => { + describe('waitForIndexStatus', () => { afterEach(async () => { try { await client.indices.delete({ index: 'red_then_yellow_index' }); @@ -365,9 +365,10 @@ describe('migration actions', () => { ); // Start tracking the index status - const indexStatusPromise = waitForIndexStatusYellow({ + const indexStatusPromise = waitForIndexStatus({ client, index: 'red_then_yellow_index', + status: 'yellow', })(); const redStatusResponse = await client.cluster.health({ index: 'red_then_yellow_index' }); @@ -405,10 +406,11 @@ describe('migration actions', () => { }) .catch((e) => {}); // try to wait for index status yellow: - const task = waitForIndexStatusYellow({ + const task = waitForIndexStatus({ client, index: 'red_index', timeout: '1s', + status: 'yellow', }); await expect(task()).resolves.toMatchInlineSnapshot(` Object { @@ -420,6 +422,39 @@ describe('migration actions', () => { } `); }); + + it('resolves left with "index_not_green_timeout" after waiting for an index status to be green timeout', async () => { + // Create a yellow index + await client.indices + .create({ + index: 'yellow_index', + timeout: '5s', + body: { + mappings: { properties: {} }, + settings: { + // Allocate no replicas so that this index stays yellow + number_of_replicas: '0', + }, + }, + }) + .catch((e) => {}); + // try to wait for index status yellow: + const task = waitForIndexStatus({ + client, + index: 'red_index', + timeout: '1s', + status: 'green', + }); + await expect(task()).resolves.toMatchInlineSnapshot(` + Object { + "_tag": "Left", + "left": Object { + "message": "[index_not_green_timeout] Timeout waiting for the status of the [red_index] index to become 'green'", + "type": "index_not_green_timeout", + }, + } + `); + }); }); describe('cloneIndex', () => { @@ -451,19 +486,19 @@ describe('migration actions', () => { } `); }); - it('resolves right after waiting for index status to be yellow if clone target already existed', async () => { + it('resolves right if clone target already existed after waiting for index status to be green ', async () => { expect.assertions(2); - // Create a yellow index + // Create a red index that we later turn into green await client.indices .create({ - index: 'clone_red_then_yellow_index', + index: 'clone_red_then_green_index', timeout: '5s', body: { mappings: { properties: {} }, settings: { - // Allocate 1 replica so that this index stays yellow - number_of_replicas: '1', + // Allocate 1 replica so that this index can go to green + number_of_replicas: '0', // Disable all shard allocation so that the index status is red index: { routing: { allocation: { enable: 'none' } } }, }, @@ -475,24 +510,24 @@ describe('migration actions', () => { const cloneIndexPromise = cloneIndex({ client, source: 'existing_index_with_write_block', - target: 'clone_red_then_yellow_index', + target: 'clone_red_then_green_index', })(); - let indexYellow = false; + let indexGreen = false; setTimeout(() => { client.indices.putSettings({ - index: 'clone_red_then_yellow_index', + index: 'clone_red_then_green_index', body: { - // Enable all shard allocation so that the index status goes yellow + // Enable all shard allocation so that the index status goes green routing: { allocation: { enable: 'all' } }, }, }); - indexYellow = true; + indexGreen = true; }, 10); await cloneIndexPromise.then((res) => { // Assert that the promise didn't resolve before the index became green - expect(indexYellow).toBe(true); + expect(indexGreen).toBe(true); expect(res).toMatchInlineSnapshot(` Object { "_tag": "Right", @@ -504,20 +539,7 @@ describe('migration actions', () => { `); }); }); - it('resolves left index_not_found_exception if the source index does not exist', async () => { - expect.assertions(1); - const task = cloneIndex({ client, source: 'no_such_index', target: 'clone_target_3' }); - await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "index": "no_such_index", - "type": "index_not_found_exception", - }, - } - `); - }); - it('resolves left with a index_not_yellow_timeout if clone target already exists but takes longer than the specified timeout before turning yellow', async () => { + it('resolves left with a index_not_green_timeout if clone target already exists but takes longer than the specified timeout before turning green', async () => { // Create a red index await client.indices .create({ @@ -536,7 +558,7 @@ describe('migration actions', () => { .catch((e) => {}); // Call clone even though the index already exists - const cloneIndexPromise = cloneIndex({ + let cloneIndexPromise = cloneIndex({ client, source: 'existing_index_with_write_block', target: 'clone_red_index', @@ -544,16 +566,16 @@ describe('migration actions', () => { })(); await expect(cloneIndexPromise).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "message": "[index_not_yellow_timeout] Timeout waiting for the status of the [clone_red_index] index to become 'yellow'", - "type": "index_not_yellow_timeout", - }, - } + Object { + "_tag": "Left", + "left": Object { + "message": "[index_not_green_timeout] Timeout waiting for the status of the [clone_red_index] index to become 'green'", + "type": "index_not_green_timeout", + }, + } `); - // Now that we know timeouts work, make the index yellow again and call cloneIndex a second time to verify that it completes + // Now make the index yellow and repeat await client.indices.putSettings({ index: 'clone_red_index', @@ -563,22 +585,63 @@ describe('migration actions', () => { }, }); - // Call clone even though the index already exists with yellow state - const cloneIndexPromise2 = cloneIndex({ + // Call clone even though the index already exists + cloneIndexPromise = cloneIndex({ + client, + source: 'existing_index_with_write_block', + target: 'clone_red_index', + timeout: '1s', + })(); + + await expect(cloneIndexPromise).resolves.toMatchInlineSnapshot(` + Object { + "_tag": "Left", + "left": Object { + "message": "[index_not_green_timeout] Timeout waiting for the status of the [clone_red_index] index to become 'green'", + "type": "index_not_green_timeout", + }, + } + `); + + // Now make the index green and it should succeed + + await client.indices.putSettings({ + index: 'clone_red_index', + body: { + // Set zero replicas so status goes green + number_of_replicas: 0, + }, + }); + + // Call clone even though the index already exists + cloneIndexPromise = cloneIndex({ client, source: 'existing_index_with_write_block', target: 'clone_red_index', timeout: '30s', })(); - await expect(cloneIndexPromise2).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Right", - "right": Object { - "acknowledged": true, - "shardsAcknowledged": true, - }, - } + await expect(cloneIndexPromise).resolves.toMatchInlineSnapshot(` + Object { + "_tag": "Right", + "right": Object { + "acknowledged": true, + "shardsAcknowledged": true, + }, + } + `); + }); + it('resolves left index_not_found_exception if the source index does not exist', async () => { + expect.assertions(1); + const task = cloneIndex({ client, source: 'no_such_index', target: 'clone_target_3' }); + await expect(task()).resolves.toMatchInlineSnapshot(` + Object { + "_tag": "Left", + "left": Object { + "index": "no_such_index", + "type": "index_not_found_exception", + }, + } `); }); it('resolves left cluster_shard_limit_exceeded when the action would exceed the maximum normal open shards', async () => { @@ -614,10 +677,10 @@ describe('migration actions', () => { })()) as Either.Right; const task = waitForReindexTask({ client, taskId: res.right.taskId, timeout: '10s' }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Right", - "right": "reindex_succeeded", - } + Object { + "_tag": "Right", + "right": "reindex_succeeded", + } `); const results = ( @@ -687,10 +750,10 @@ describe('migration actions', () => { })()) as Either.Right; const task = waitForReindexTask({ client, taskId: res.right.taskId, timeout: '10s' }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Right", - "right": "reindex_succeeded", - } + Object { + "_tag": "Right", + "right": "reindex_succeeded", + } `); const results = ( (await searchForOutdatedDocuments(client, { @@ -722,11 +785,11 @@ describe('migration actions', () => { })()) as Either.Right; let task = waitForReindexTask({ client, taskId: res.right.taskId, timeout: '10s' }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Right", - "right": "reindex_succeeded", - } - `); + Object { + "_tag": "Right", + "right": "reindex_succeeded", + } + `); // reindex without a script res = (await reindex({ @@ -739,11 +802,11 @@ describe('migration actions', () => { })()) as Either.Right; task = waitForReindexTask({ client, taskId: res.right.taskId, timeout: '10s' }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Right", - "right": "reindex_succeeded", - } - `); + Object { + "_tag": "Right", + "right": "reindex_succeeded", + } + `); // Assert that documents weren't overridden by the second, unscripted reindex const results = ( @@ -798,11 +861,11 @@ describe('migration actions', () => { })()) as Either.Right; const task = waitForReindexTask({ client, taskId: res.right.taskId, timeout: '10s' }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Right", - "right": "reindex_succeeded", - } - `); + Object { + "_tag": "Right", + "right": "reindex_succeeded", + } + `); // Assert that existing documents weren't overridden, but that missing // documents were added by the reindex const results = ( @@ -855,13 +918,13 @@ describe('migration actions', () => { const task = waitForReindexTask({ client, taskId: reindexTaskId, timeout: '10s' }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "type": "incompatible_mapping_exception", - }, - } - `); + Object { + "_tag": "Left", + "left": Object { + "type": "incompatible_mapping_exception", + }, + } + `); }); it('resolves left incompatible_mapping_exception if all reindex failures are due to a mapper_parsing_exception', async () => { expect.assertions(1); @@ -894,13 +957,13 @@ describe('migration actions', () => { const task = waitForReindexTask({ client, taskId: reindexTaskId, timeout: '10s' }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "type": "incompatible_mapping_exception", - }, - } - `); + Object { + "_tag": "Left", + "left": Object { + "type": "incompatible_mapping_exception", + }, + } + `); }); it('resolves left index_not_found_exception if source index does not exist', async () => { expect.assertions(1); @@ -916,14 +979,14 @@ describe('migration actions', () => { })()) as Either.Right; const task = waitForReindexTask({ client, taskId: res.right.taskId, timeout: '10s' }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "index": "no_such_index", - "type": "index_not_found_exception", - }, - } - `); + Object { + "_tag": "Left", + "left": Object { + "index": "no_such_index", + "type": "index_not_found_exception", + }, + } + `); }); it('resolves left target_index_had_write_block if all failures are due to a write block', async () => { expect.assertions(1); @@ -939,13 +1002,13 @@ describe('migration actions', () => { const task = waitForReindexTask({ client, taskId: res.right.taskId, timeout: '10s' }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "type": "target_index_had_write_block", - }, - } - `); + Object { + "_tag": "Left", + "left": Object { + "type": "target_index_had_write_block", + }, + } + `); }); it('resolves left if requireAlias=true and the target is not an alias', async () => { expect.assertions(1); @@ -961,20 +1024,21 @@ describe('migration actions', () => { const task = waitForReindexTask({ client, taskId: res.right.taskId, timeout: '10s' }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "index": "existing_index_with_write_block", - "type": "index_not_found_exception", - }, - } - `); + Object { + "_tag": "Left", + "left": Object { + "index": "existing_index_with_write_block", + "type": "index_not_found_exception", + }, + } + `); }); it('resolves left wait_for_task_completion_timeout when the task does not finish within the timeout', async () => { - await waitForIndexStatusYellow({ + await waitForIndexStatus({ client, index: '.kibana_1', + status: 'yellow', })(); const res = (await reindex({ @@ -1001,65 +1065,6 @@ describe('migration actions', () => { }); }); - describe('verifyReindex', () => { - it('resolves right if source and target indices have the same amount of documents', async () => { - expect.assertions(1); - const res = (await reindex({ - client, - sourceIndex: 'existing_index_with_docs', - targetIndex: 'reindex_target_7', - reindexScript: Option.none, - requireAlias: false, - excludeOnUpgradeQuery: { match_all: {} }, - })()) as Either.Right; - await waitForReindexTask({ client, taskId: res.right.taskId, timeout: '10s' })(); - - const task = verifyReindex({ - client, - sourceIndex: 'existing_index_with_docs', - targetIndex: 'reindex_target_7', - }); - await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Right", - "right": "verify_reindex_succeeded", - } - `); - }); - it('resolves left if source and target indices have different amount of documents', async () => { - expect.assertions(1); - const task = verifyReindex({ - client, - sourceIndex: 'existing_index_with_docs', - targetIndex: 'existing_index_2', - }); - await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "type": "verify_reindex_failed", - }, - } - `); - }); - it('rejects if source or target index does not exist', async () => { - expect.assertions(2); - let task = verifyReindex({ - client, - sourceIndex: 'no_such_index', - targetIndex: 'existing_index_2', - }); - await expect(task()).rejects.toThrow('index_not_found_exception'); - - task = verifyReindex({ - client, - sourceIndex: 'existing_index_2', - targetIndex: 'no_such_index', - }); - await expect(task()).rejects.toThrow('index_not_found_exception'); - }); - }); - describe('openPit', () => { it('opens PointInTime for an index', async () => { const openPitTask = openPit({ client, index: 'existing_index_with_docs' }); @@ -1372,11 +1377,11 @@ describe('migration actions', () => { }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Right", - "right": "pickup_updated_mappings_succeeded", - } - `); + Object { + "_tag": "Right", + "right": "pickup_updated_mappings_succeeded", + } + `); }); }); @@ -1460,14 +1465,14 @@ describe('migration actions', () => { ], }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "index": "no_such_index", - "type": "index_not_found_exception", - }, - } - `); + Object { + "_tag": "Left", + "left": Object { + "index": "no_such_index", + "type": "index_not_found_exception", + }, + } + `); }); describe('with must_exist=false', () => { it('resolves left alias_not_found_exception when alias does not exist', async () => { @@ -1484,13 +1489,13 @@ describe('migration actions', () => { ], }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "type": "alias_not_found_exception", - }, - } - `); + Object { + "_tag": "Left", + "left": Object { + "type": "alias_not_found_exception", + }, + } + `); }); }); describe('with must_exist=true', () => { @@ -1508,13 +1513,13 @@ describe('migration actions', () => { ], }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "type": "alias_not_found_exception", - }, - } - `); + Object { + "_tag": "Left", + "left": Object { + "type": "alias_not_found_exception", + }, + } + `); }); it('resolves left alias_not_found_exception when alias does not exist', async () => { const task = updateAliases({ @@ -1530,13 +1535,13 @@ describe('migration actions', () => { ], }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "type": "alias_not_found_exception", - }, - } - `); + Object { + "_tag": "Left", + "left": Object { + "type": "alias_not_found_exception", + }, + } + `); }); }); }); @@ -1553,14 +1558,14 @@ describe('migration actions', () => { ], }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "index": "no_such_index", - "type": "index_not_found_exception", - }, - } - `); + Object { + "_tag": "Left", + "left": Object { + "index": "no_such_index", + "type": "index_not_found_exception", + }, + } + `); }); it('left remove_index_not_a_concrete_index when remove_index targets an alias', async () => { const task = updateAliases({ @@ -1574,13 +1579,13 @@ describe('migration actions', () => { ], }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Left", - "left": Object { - "type": "remove_index_not_a_concrete_index", - }, - } - `); + Object { + "_tag": "Left", + "left": Object { + "type": "remove_index_not_a_concrete_index", + }, + } + `); }); }); }); @@ -1591,9 +1596,24 @@ describe('migration actions', () => { await client.cluster.putSettings({ persistent: { cluster: { max_shards_per_node: null } } }); }); afterAll(async () => { - await client.indices.delete({ index: 'red_then_yellow_index' }); + await client.indices.delete({ index: 'red_then_yellow_index' }).catch(); + await client.indices.delete({ index: 'yellow_then_green_index' }).catch(); + await client.indices.delete({ index: 'create_new_index' }).catch(); }); - it('resolves right after waiting for an index status to be yellow if the index already existed', async () => { + it('resolves right after waiting for an index status to become green when cluster state is not propagated within the timeout', async () => { + // By specifying a very short timeout Elasticsearch will respond before the shard is allocated + const createIndexPromise = createIndex({ + client, + indexName: 'create_new_index', + mappings: undefined as any, + timeout: '1nanos', + })(); + await expect(createIndexPromise).resolves.toEqual({ + _tag: 'Right', + right: 'create_index_succeeded', + }); + }); + it('resolves left if an existing index status does not become green', async () => { expect.assertions(2); // Create a red index await client.indices @@ -1606,7 +1626,7 @@ describe('migration actions', () => { settings: { // Allocate 1 replica so that this index stays yellow number_of_replicas: '1', - // Disable all shard allocation so that the index status is red + // Disable all shard allocation so that the index status starts as red index: { routing: { allocation: { enable: 'none' } } }, }, }, @@ -1629,16 +1649,68 @@ describe('migration actions', () => { client.indices.putSettings({ index: 'red_then_yellow_index', body: { - // Disable all shard allocation so that the index status is red + // Renable allocation so that the status becomes yellow routing: { allocation: { enable: 'all' } }, }, }); indexYellow = true; }, 10); + await createIndexPromise.then((err) => { + // Assert that the promise didn't resolve before the index became yellow + expect(indexYellow).toBe(true); + expect(err).toMatchInlineSnapshot(` + Object { + "_tag": "Left", + "left": Object { + "message": "[index_not_green_timeout] Timeout waiting for the status of the [red_then_yellow_index] index to become 'green'", + "type": "index_not_green_timeout", + }, + } + `); + }); + }); + it('resolves right after waiting for an existing index status to become green', async () => { + expect.assertions(2); + // Create a yellow index + await client.indices + .create({ + index: 'yellow_then_green_index', + timeout: '5s', + body: { + mappings: { properties: {} }, + settings: { + // Allocate 1 replica so that this index stays yellow + number_of_replicas: '1', + }, + }, + }) + .catch((e) => { + /** ignore */ + }); + + // Call createIndex even though the index already exists + const createIndexPromise = createIndex({ + client, + indexName: 'yellow_then_green_index', + mappings: undefined as any, + })(); + let indexGreen = false; + + setTimeout(() => { + client.indices.putSettings({ + index: 'yellow_then_green_index', + body: { + // Set 0 replican so that this index becomes green + number_of_replicas: '0', + }, + }); + indexGreen = true; + }, 10); + await createIndexPromise.then((res) => { // Assert that the promise didn't resolve before the index became green - expect(indexYellow).toBe(true); + expect(indexGreen).toBe(true); expect(res).toMatchInlineSnapshot(` Object { "_tag": "Right", @@ -1652,7 +1724,7 @@ describe('migration actions', () => { await client.cluster.putSettings({ persistent: { cluster: { max_shards_per_node: 1 } } }); const createIndexPromise = createIndex({ client, - indexName: 'red_then_yellow_index_1', + indexName: 'create_index_1', mappings: undefined as any, })(); await expect(createIndexPromise).resolves.toMatchInlineSnapshot(` @@ -1688,10 +1760,10 @@ describe('migration actions', () => { }); await expect(task()).resolves.toMatchInlineSnapshot(` - Object { - "_tag": "Right", - "right": "bulk_index_succeeded", - } + Object { + "_tag": "Right", + "right": "bulk_index_succeeded", + } `); }); it('resolves right even if there were some version_conflict_engine_exception', async () => { diff --git a/src/core/server/integration_tests/saved_objects/migrations/cleanup.test.ts b/src/core/server/integration_tests/saved_objects/migrations/cleanup.test.ts index bea6e7033eb53..bce99dc294398 100644 --- a/src/core/server/integration_tests/saved_objects/migrations/cleanup.test.ts +++ b/src/core/server/integration_tests/saved_objects/migrations/cleanup.test.ts @@ -54,7 +54,8 @@ function createRoot() { ); } -describe('migration v2', () => { +// FAILING ON 8.4: https://github.com/elastic/kibana/issues/137331 +describe.skip('migration v2', () => { let esServer: kbnTestServer.TestElasticsearchUtils; let root: Root; diff --git a/src/core/server/integration_tests/saved_objects/migrations/collects_corrupt_docs.test.ts b/src/core/server/integration_tests/saved_objects/migrations/collects_corrupt_docs.test.ts index 55c21a70fb9da..bcbb0382e94b0 100644 --- a/src/core/server/integration_tests/saved_objects/migrations/collects_corrupt_docs.test.ts +++ b/src/core/server/integration_tests/saved_objects/migrations/collects_corrupt_docs.test.ts @@ -21,7 +21,8 @@ async function removeLogFile() { await asyncUnlink(logFilePath).catch(() => void 0); } -describe('migration v2 with corrupt saved object documents', () => { +// FAILING ON 8.4: https://github.com/elastic/kibana/issues/137330 +describe.skip('migration v2 with corrupt saved object documents', () => { let esServer: kbnTestServer.TestElasticsearchUtils; let root: Root; diff --git a/src/core/server/integration_tests/saved_objects/service/lib/repository_with_proxy.test.ts b/src/core/server/integration_tests/saved_objects/service/lib/repository_with_proxy.test.ts index b82cb54053482..7581e5f3639a2 100644 --- a/src/core/server/integration_tests/saved_objects/service/lib/repository_with_proxy.test.ts +++ b/src/core/server/integration_tests/saved_objects/service/lib/repository_with_proxy.test.ts @@ -9,8 +9,8 @@ import Hapi from '@hapi/hapi'; import h2o2 from '@hapi/h2o2'; import { URL } from 'url'; -import { ISavedObjectsRepository } from '../../../../saved_objects/service/lib/repository'; -import { SavedObject } from '../../../../saved_objects/types'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; +import type { ISavedObjectsRepository } from '@kbn/core-saved-objects-api-server'; import { InternalCoreSetup, InternalCoreStart } from '../../../../internal_types'; import { Root } from '../../../../root'; import * as kbnTestServer from '../../../../../test_helpers/kbn_server'; diff --git a/src/core/server/integration_tests/saved_objects/validation/validator.test.ts b/src/core/server/integration_tests/saved_objects/validation/validator.test.ts index 44d882b0fe80b..59c9cb65c83f2 100644 --- a/src/core/server/integration_tests/saved_objects/validation/validator.test.ts +++ b/src/core/server/integration_tests/saved_objects/validation/validator.test.ts @@ -12,8 +12,8 @@ import Util from 'util'; import { Env } from '@kbn/config'; import { schema } from '@kbn/config-schema'; import { REPO_ROOT } from '@kbn/utils'; +import type { ISavedObjectsRepository } from '@kbn/core-saved-objects-api-server'; import { SavedObjectsType } from '../../../saved_objects/types'; -import { ISavedObjectsRepository } from '../../../saved_objects/service/lib'; import { getEnvOptions } from '@kbn/config-mocks'; import { InternalCoreSetup, InternalCoreStart } from '../../../internal_types'; import { Root } from '../../../root'; diff --git a/src/core/server/saved_objects/export/apply_export_transforms.test.ts b/src/core/server/saved_objects/export/apply_export_transforms.test.ts index 561c1ee1aed8b..c3f091b170ab7 100644 --- a/src/core/server/saved_objects/export/apply_export_transforms.test.ts +++ b/src/core/server/saved_objects/export/apply_export_transforms.test.ts @@ -8,7 +8,7 @@ import { CoreKibanaRequest } from '@kbn/core-http-router-server-internal'; import { httpServerMock } from '@kbn/core-http-server-mocks'; -import { SavedObject } from '../../../types'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; import { applyExportTransforms } from './apply_export_transforms'; import { SavedObjectsExportTransform } from './types'; diff --git a/src/core/server/saved_objects/export/apply_export_transforms.ts b/src/core/server/saved_objects/export/apply_export_transforms.ts index c105ccd7a7ad5..1742b4ff1a2a3 100644 --- a/src/core/server/saved_objects/export/apply_export_transforms.ts +++ b/src/core/server/saved_objects/export/apply_export_transforms.ts @@ -7,7 +7,7 @@ */ import type { KibanaRequest } from '@kbn/core-http-server'; -import { SavedObject } from '../../../types'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; import { SavedObjectsExportError } from './errors'; import { SavedObjectsExportTransform, SavedObjectsExportTransformContext } from './types'; import { getObjKey, SavedObjectComparator } from './utils'; diff --git a/src/core/server/saved_objects/export/collect_exported_objects.test.ts b/src/core/server/saved_objects/export/collect_exported_objects.test.ts index 7a483d3a9af20..84520efa10a53 100644 --- a/src/core/server/saved_objects/export/collect_exported_objects.test.ts +++ b/src/core/server/saved_objects/export/collect_exported_objects.test.ts @@ -7,10 +7,10 @@ */ import { httpServerMock } from '@kbn/core-http-server-mocks'; +import type { SavedObject, SavedObjectError } from '@kbn/core-saved-objects-common'; import { applyExportTransformsMock } from './collect_exported_objects.test.mocks'; import { savedObjectsClientMock } from '../../mocks'; import { loggerMock } from '@kbn/logging-mocks'; -import { SavedObject, SavedObjectError } from '../../../types'; import { SavedObjectTypeRegistry } from '../saved_objects_type_registry'; import type { SavedObjectsExportTransform } from './types'; import { collectExportedObjects, ExclusionReason } from './collect_exported_objects'; diff --git a/src/core/server/saved_objects/export/collect_exported_objects.ts b/src/core/server/saved_objects/export/collect_exported_objects.ts index 57a83fc399291..cec75952afcae 100644 --- a/src/core/server/saved_objects/export/collect_exported_objects.ts +++ b/src/core/server/saved_objects/export/collect_exported_objects.ts @@ -8,8 +8,9 @@ import type { Logger } from '@kbn/logging'; import type { KibanaRequest } from '@kbn/core-http-server'; -import type { SavedObject } from '../../../types'; -import { SavedObjectsClientContract, SavedObjectsExportablePredicate } from '../types'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; +import { SavedObjectsExportablePredicate } from '../types'; import { ISavedObjectTypeRegistry } from '../saved_objects_type_registry'; import type { SavedObjectsExportTransform } from './types'; import { applyExportTransforms } from './apply_export_transforms'; diff --git a/src/core/server/saved_objects/export/errors.ts b/src/core/server/saved_objects/export/errors.ts index 0110e68142fa0..6ca23c358f931 100644 --- a/src/core/server/saved_objects/export/errors.ts +++ b/src/core/server/saved_objects/export/errors.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { SavedObject } from '../../../types'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; /** * @public diff --git a/src/core/server/saved_objects/export/saved_objects_exporter.test.ts b/src/core/server/saved_objects/export/saved_objects_exporter.test.ts index 6b0e0e3b277d9..8b4604087141c 100644 --- a/src/core/server/saved_objects/export/saved_objects_exporter.test.ts +++ b/src/core/server/saved_objects/export/saved_objects_exporter.test.ts @@ -7,7 +7,7 @@ */ import { httpServerMock } from '@kbn/core-http-server-mocks'; -import type { SavedObject } from '../../../types'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; import { SavedObjectsExporter } from './saved_objects_exporter'; import { savedObjectsClientMock } from '../service/saved_objects_client.mock'; import { SavedObjectTypeRegistry } from '../saved_objects_type_registry'; diff --git a/src/core/server/saved_objects/export/saved_objects_exporter.ts b/src/core/server/saved_objects/export/saved_objects_exporter.ts index ae9660256c3a5..7618d5c79def2 100644 --- a/src/core/server/saved_objects/export/saved_objects_exporter.ts +++ b/src/core/server/saved_objects/export/saved_objects_exporter.ts @@ -9,8 +9,11 @@ import type { Readable } from 'stream'; import { createListStream } from '@kbn/utils'; import type { Logger } from '@kbn/logging'; -import { SavedObject, SavedObjectsClientContract } from '../types'; -import { SavedObjectsFindResult } from '../service'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; +import type { + SavedObjectsClientContract, + SavedObjectsFindResult, +} from '@kbn/core-saved-objects-api-server'; import { ISavedObjectTypeRegistry } from '../saved_objects_type_registry'; import { sortObjects } from './sort_objects'; import { diff --git a/src/core/server/saved_objects/export/sort_objects.ts b/src/core/server/saved_objects/export/sort_objects.ts index 3b73f889933b9..487622877e25c 100644 --- a/src/core/server/saved_objects/export/sort_objects.ts +++ b/src/core/server/saved_objects/export/sort_objects.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { SavedObject } from '../types'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; export function sortObjects(savedObjects: SavedObject[]): SavedObject[] { const path = new Set(); diff --git a/src/core/server/saved_objects/export/types.ts b/src/core/server/saved_objects/export/types.ts index f766a4ce7f6a1..ada5f54eba104 100644 --- a/src/core/server/saved_objects/export/types.ts +++ b/src/core/server/saved_objects/export/types.ts @@ -7,7 +7,8 @@ */ import type { KibanaRequest } from '@kbn/core-http-server'; -import { SavedObject, SavedObjectsFindOptionsReference } from '../types'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; +import type { SavedObjectsFindOptionsReference } from '@kbn/core-saved-objects-api-server'; /** @public */ export interface SavedObjectExportBaseOptions { diff --git a/src/core/server/saved_objects/export/utils.test.ts b/src/core/server/saved_objects/export/utils.test.ts index b34aadb682629..6088217bd9201 100644 --- a/src/core/server/saved_objects/export/utils.test.ts +++ b/src/core/server/saved_objects/export/utils.test.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ +import type { SavedObject } from '@kbn/core-saved-objects-common'; import { byIdAscComparator, getPreservedOrderComparator } from './utils'; -import { SavedObject } from '../../../types'; const createObj = (id: string): SavedObject => ({ id, diff --git a/src/core/server/saved_objects/export/utils.ts b/src/core/server/saved_objects/export/utils.ts index 1caa80785753d..dbace21e98ca6 100644 --- a/src/core/server/saved_objects/export/utils.ts +++ b/src/core/server/saved_objects/export/utils.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { SavedObject } from '../../../types'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; export type SavedObjectComparator = (a: SavedObject, b: SavedObject) => number; diff --git a/src/core/server/saved_objects/import/errors.ts b/src/core/server/saved_objects/import/errors.ts index 19754b384c27f..c0350c7eac7f8 100644 --- a/src/core/server/saved_objects/import/errors.ts +++ b/src/core/server/saved_objects/import/errors.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { SavedObject } from '../../../types'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; /** * @public diff --git a/src/core/server/saved_objects/import/import_saved_objects.test.ts b/src/core/server/saved_objects/import/import_saved_objects.test.ts index 046b9d3505cde..98550c8113b6d 100644 --- a/src/core/server/saved_objects/import/import_saved_objects.test.ts +++ b/src/core/server/saved_objects/import/import_saved_objects.test.ts @@ -19,17 +19,17 @@ import { import { Readable } from 'stream'; import { v4 as uuidv4 } from 'uuid'; -import { - SavedObjectsClientContract, - SavedObjectsType, +import type { SavedObject, SavedObjectsImportFailure, -} from '../types'; + SavedObjectsImportWarning, +} from '@kbn/core-saved-objects-common'; +import { SavedObjectsClientContract, SavedObjectsType } from '../types'; import { savedObjectsClientMock } from '../../mocks'; import { ISavedObjectTypeRegistry } from '..'; import { typeRegistryMock } from '../saved_objects_type_registry.mock'; import { importSavedObjectsFromStream, ImportSavedObjectsOptions } from './import_saved_objects'; -import { SavedObjectsImportHook, SavedObjectsImportWarning } from './types'; +import { SavedObjectsImportHook } from './types'; import type { ImportStateMap } from './lib'; describe('#importSavedObjectsFromStream', () => { diff --git a/src/core/server/saved_objects/import/import_saved_objects.ts b/src/core/server/saved_objects/import/import_saved_objects.ts index 9e9f5f8b050dc..504dd8ef9396e 100644 --- a/src/core/server/saved_objects/import/import_saved_objects.ts +++ b/src/core/server/saved_objects/import/import_saved_objects.ts @@ -7,13 +7,13 @@ */ import { Readable } from 'stream'; -import { ISavedObjectTypeRegistry } from '../saved_objects_type_registry'; -import { SavedObjectsClientContract } from '../types'; -import { +import type { SavedObjectsImportFailure, SavedObjectsImportResponse, - SavedObjectsImportHook, -} from './types'; +} from '@kbn/core-saved-objects-common'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; +import { ISavedObjectTypeRegistry } from '../saved_objects_type_registry'; +import { SavedObjectsImportHook } from './types'; import { checkReferenceOrigins, validateReferences, diff --git a/src/core/server/saved_objects/import/index.ts b/src/core/server/saved_objects/import/index.ts index 4832038b342d2..c299b92d4c5f9 100644 --- a/src/core/server/saved_objects/import/index.ts +++ b/src/core/server/saved_objects/import/index.ts @@ -9,21 +9,9 @@ export { SavedObjectsImporter } from './saved_objects_importer'; export type { ISavedObjectsImporter } from './saved_objects_importer'; export type { - SavedObjectsImportResponse, - SavedObjectsImportSuccess, - SavedObjectsImportFailure, SavedObjectsImportOptions, - SavedObjectsImportConflictError, - SavedObjectsImportAmbiguousConflictError, - SavedObjectsImportMissingReferencesError, - SavedObjectsImportUnknownError, - SavedObjectsImportUnsupportedTypeError, SavedObjectsResolveImportErrorsOptions, - SavedObjectsImportRetry, SavedObjectsImportHook, SavedObjectsImportHookResult, - SavedObjectsImportSimpleWarning, - SavedObjectsImportActionRequiredWarning, - SavedObjectsImportWarning, } from './types'; export { SavedObjectsImportError } from './errors'; diff --git a/src/core/server/saved_objects/import/lib/check_conflicts.test.ts b/src/core/server/saved_objects/import/lib/check_conflicts.test.ts index a9c534bd7e36b..3dcbeacae1a2d 100644 --- a/src/core/server/saved_objects/import/lib/check_conflicts.test.ts +++ b/src/core/server/saved_objects/import/lib/check_conflicts.test.ts @@ -7,8 +7,12 @@ */ import { savedObjectsClientMock } from '../../../mocks'; -import { SavedObjectReference, SavedObjectsImportRetry } from '../../../../public'; -import { SavedObjectsClientContract, SavedObject } from '../../types'; +import type { + SavedObject, + SavedObjectReference, + SavedObjectsImportRetry, +} from '@kbn/core-saved-objects-common'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; import { SavedObjectsErrorHelpers } from '../../service'; import { checkConflicts } from './check_conflicts'; diff --git a/src/core/server/saved_objects/import/lib/check_conflicts.ts b/src/core/server/saved_objects/import/lib/check_conflicts.ts index 3ab4b03e791b0..f4f6082ef18ab 100644 --- a/src/core/server/saved_objects/import/lib/check_conflicts.ts +++ b/src/core/server/saved_objects/import/lib/check_conflicts.ts @@ -7,13 +7,13 @@ */ import { v4 as uuidv4 } from 'uuid'; -import { +import type { SavedObject, - SavedObjectsClientContract, SavedObjectsImportFailure, SavedObjectError, SavedObjectsImportRetry, -} from '../../types'; +} from '@kbn/core-saved-objects-common'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; import type { ImportStateMap } from './types'; interface CheckConflictsParams { diff --git a/src/core/server/saved_objects/import/lib/check_origin_conflicts.test.ts b/src/core/server/saved_objects/import/lib/check_origin_conflicts.test.ts index 30f40e5e84c62..2d75fdfb73116 100644 --- a/src/core/server/saved_objects/import/lib/check_origin_conflicts.test.ts +++ b/src/core/server/saved_objects/import/lib/check_origin_conflicts.test.ts @@ -8,13 +8,13 @@ import { mockCreateOriginQuery } from './check_reference_origins.test.mock'; -import { - SavedObjectsClientContract, +import type { SavedObjectReference, SavedObject, SavedObjectsImportFailure, SavedObjectsImportRetry, -} from '../../types'; +} from '@kbn/core-saved-objects-common'; +import { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; import { checkOriginConflicts } from './check_origin_conflicts'; import { savedObjectsClientMock } from '../../../mocks'; import { typeRegistryMock } from '../../saved_objects_type_registry.mock'; diff --git a/src/core/server/saved_objects/import/lib/check_origin_conflicts.ts b/src/core/server/saved_objects/import/lib/check_origin_conflicts.ts index 207eb59b126cd..bd22d50841a52 100644 --- a/src/core/server/saved_objects/import/lib/check_origin_conflicts.ts +++ b/src/core/server/saved_objects/import/lib/check_origin_conflicts.ts @@ -10,10 +10,10 @@ import pMap from 'p-map'; import { v4 as uuidv4 } from 'uuid'; import type { SavedObject, - SavedObjectsClientContract, SavedObjectsImportFailure, SavedObjectsImportRetry, -} from '../../types'; +} from '@kbn/core-saved-objects-common'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; import { ISavedObjectTypeRegistry } from '../../saved_objects_type_registry'; import { getObjectKey } from '../../service/lib/internal_utils'; import type { ImportStateMap } from './types'; @@ -44,14 +44,17 @@ interface InexactMatch { object: SavedObject; destinations: Array<{ id: string; title?: string; updatedAt?: string }>; } + interface Left { tag: 'left'; value: InexactMatch; } + interface Right { tag: 'right'; value: SavedObject; } + type Either = Left | Right; const isLeft = (object: Either): object is Left => object.tag === 'left'; diff --git a/src/core/server/saved_objects/import/lib/check_reference_origins.test.ts b/src/core/server/saved_objects/import/lib/check_reference_origins.test.ts index de162856b9873..a8ddb5b8a063e 100644 --- a/src/core/server/saved_objects/import/lib/check_reference_origins.test.ts +++ b/src/core/server/saved_objects/import/lib/check_reference_origins.test.ts @@ -8,7 +8,7 @@ import { mockCreateOriginQuery } from './check_reference_origins.test.mock'; -import type { SavedObjectsFindResult } from '../../service'; +import type { SavedObjectsFindResult } from '@kbn/core-saved-objects-api-server'; import type { SavedObjectsClientContract } from '../../types'; import { checkReferenceOrigins, CheckReferenceOriginsParams } from './check_reference_origins'; import { savedObjectsClientMock } from '../../../mocks'; diff --git a/src/core/server/saved_objects/import/lib/collect_saved_objects.ts b/src/core/server/saved_objects/import/lib/collect_saved_objects.ts index 66d75d7af5073..e86ff1f70794d 100644 --- a/src/core/server/saved_objects/import/lib/collect_saved_objects.ts +++ b/src/core/server/saved_objects/import/lib/collect_saved_objects.ts @@ -14,8 +14,7 @@ import { createPromiseFromStreams, } from '@kbn/utils'; -import { SavedObject } from '../../types'; -import { SavedObjectsImportFailure } from '../types'; +import type { SavedObject, SavedObjectsImportFailure } from '@kbn/core-saved-objects-common'; import { SavedObjectsImportError } from '../errors'; import { getNonUniqueEntries } from './get_non_unique_entries'; import { createLimitStream } from './create_limit_stream'; diff --git a/src/core/server/saved_objects/import/lib/create_objects_filter.ts b/src/core/server/saved_objects/import/lib/create_objects_filter.ts index 295104846a868..4b830e80fa6cb 100644 --- a/src/core/server/saved_objects/import/lib/create_objects_filter.ts +++ b/src/core/server/saved_objects/import/lib/create_objects_filter.ts @@ -6,8 +6,7 @@ * Side Public License, v 1. */ -import { SavedObject } from '../../types'; -import { SavedObjectsImportRetry } from '../types'; +import type { SavedObject, SavedObjectsImportRetry } from '@kbn/core-saved-objects-common'; export function createObjectsFilter(retries: SavedObjectsImportRetry[]) { const retryKeys = new Set(retries.map((retry) => `${retry.type}:${retry.id}`)); diff --git a/src/core/server/saved_objects/import/lib/create_saved_objects.test.ts b/src/core/server/saved_objects/import/lib/create_saved_objects.test.ts index 7f8b67406773e..a29765849c364 100644 --- a/src/core/server/saved_objects/import/lib/create_saved_objects.test.ts +++ b/src/core/server/saved_objects/import/lib/create_saved_objects.test.ts @@ -7,8 +7,9 @@ */ import { savedObjectsClientMock } from '../../../mocks'; +import type { SavedObject, SavedObjectsImportFailure } from '@kbn/core-saved-objects-common'; +import { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; import { createSavedObjects } from './create_saved_objects'; -import { SavedObjectsClientContract, SavedObject, SavedObjectsImportFailure } from '../../types'; import { SavedObjectsErrorHelpers } from '../../service'; import { extractErrors } from './extract_errors'; diff --git a/src/core/server/saved_objects/import/lib/create_saved_objects.ts b/src/core/server/saved_objects/import/lib/create_saved_objects.ts index f3260e4968d00..95affbd61097b 100644 --- a/src/core/server/saved_objects/import/lib/create_saved_objects.ts +++ b/src/core/server/saved_objects/import/lib/create_saved_objects.ts @@ -6,7 +6,8 @@ * Side Public License, v 1. */ -import { SavedObject, SavedObjectsClientContract, SavedObjectsImportFailure } from '../../types'; +import type { SavedObject, SavedObjectsImportFailure } from '@kbn/core-saved-objects-common'; +import { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; import { extractErrors } from './extract_errors'; import { CreatedObject } from '../types'; import type { ImportStateMap } from './types'; @@ -20,6 +21,7 @@ export interface CreateSavedObjectsParams { overwrite?: boolean; refresh?: boolean | 'wait_for'; } + export interface CreateSavedObjectsResult { createdObjects: Array>; errors: SavedObjectsImportFailure[]; diff --git a/src/core/server/saved_objects/import/lib/execute_import_hooks.test.ts b/src/core/server/saved_objects/import/lib/execute_import_hooks.test.ts index cf4bf718e6782..64b2c60c7f16b 100644 --- a/src/core/server/saved_objects/import/lib/execute_import_hooks.test.ts +++ b/src/core/server/saved_objects/import/lib/execute_import_hooks.test.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ -import { SavedObject } from '../../types'; -import { SavedObjectsImportHookResult, SavedObjectsImportWarning } from '../types'; +import type { SavedObject, SavedObjectsImportWarning } from '@kbn/core-saved-objects-common'; +import { SavedObjectsImportHookResult } from '../types'; import { executeImportHooks } from './execute_import_hooks'; const createObject = (type: string, id: string): SavedObject => ({ diff --git a/src/core/server/saved_objects/import/lib/execute_import_hooks.ts b/src/core/server/saved_objects/import/lib/execute_import_hooks.ts index c0b5ae0437b2c..a94bf822f7f75 100644 --- a/src/core/server/saved_objects/import/lib/execute_import_hooks.ts +++ b/src/core/server/saved_objects/import/lib/execute_import_hooks.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ -import { SavedObject } from '../../types'; -import { SavedObjectsImportHook, SavedObjectsImportWarning } from '../types'; +import type { SavedObject, SavedObjectsImportWarning } from '@kbn/core-saved-objects-common'; +import { SavedObjectsImportHook } from '../types'; export interface ExecuteImportHooksOptions { objects: SavedObject[]; diff --git a/src/core/server/saved_objects/import/lib/extract_errors.test.ts b/src/core/server/saved_objects/import/lib/extract_errors.test.ts index a355094f07117..400db2077d8c7 100644 --- a/src/core/server/saved_objects/import/lib/extract_errors.test.ts +++ b/src/core/server/saved_objects/import/lib/extract_errors.test.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { SavedObject } from '../../types'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; import { extractErrors } from './extract_errors'; import { SavedObjectsErrorHelpers } from '../../service'; import { CreatedObject } from '../types'; diff --git a/src/core/server/saved_objects/import/lib/extract_errors.ts b/src/core/server/saved_objects/import/lib/extract_errors.ts index 12d7612a4f960..15164f9873538 100644 --- a/src/core/server/saved_objects/import/lib/extract_errors.ts +++ b/src/core/server/saved_objects/import/lib/extract_errors.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ -import { SavedObject } from '../../types'; -import { SavedObjectsImportFailure, CreatedObject } from '../types'; +import type { SavedObject, SavedObjectsImportFailure } from '@kbn/core-saved-objects-common'; +import { CreatedObject } from '../types'; export function extractErrors( // TODO: define saved object type diff --git a/src/core/server/saved_objects/import/lib/get_import_state_map_for_retries.test.ts b/src/core/server/saved_objects/import/lib/get_import_state_map_for_retries.test.ts index af5aca10ba289..d598326afa136 100644 --- a/src/core/server/saved_objects/import/lib/get_import_state_map_for_retries.test.ts +++ b/src/core/server/saved_objects/import/lib/get_import_state_map_for_retries.test.ts @@ -6,8 +6,7 @@ * Side Public License, v 1. */ -import type { SavedObject } from '../../types'; -import type { SavedObjectsImportRetry } from '../types'; +import type { SavedObject, SavedObjectsImportRetry } from '@kbn/core-saved-objects-common'; import { getImportStateMapForRetries } from './get_import_state_map_for_retries'; describe('#getImportStateMapForRetries', () => { diff --git a/src/core/server/saved_objects/import/lib/get_import_state_map_for_retries.ts b/src/core/server/saved_objects/import/lib/get_import_state_map_for_retries.ts index 3066ae72738a4..dd4ed3036fb8c 100644 --- a/src/core/server/saved_objects/import/lib/get_import_state_map_for_retries.ts +++ b/src/core/server/saved_objects/import/lib/get_import_state_map_for_retries.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { SavedObject, SavedObjectsImportRetry } from '../../types'; +import type { SavedObject, SavedObjectsImportRetry } from '@kbn/core-saved-objects-common'; import type { ImportStateMap } from './types'; interface GetImportStateMapForRetriesParams { diff --git a/src/core/server/saved_objects/import/lib/regenerate_ids.test.ts b/src/core/server/saved_objects/import/lib/regenerate_ids.test.ts index d22b9431367d4..f8a8c502af38a 100644 --- a/src/core/server/saved_objects/import/lib/regenerate_ids.test.ts +++ b/src/core/server/saved_objects/import/lib/regenerate_ids.test.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ +import type { SavedObject } from '@kbn/core-saved-objects-common'; import { regenerateIds } from './regenerate_ids'; -import { SavedObject } from '../../types'; jest.mock('uuid', () => ({ v4: jest diff --git a/src/core/server/saved_objects/import/lib/regenerate_ids.ts b/src/core/server/saved_objects/import/lib/regenerate_ids.ts index 174658555aaf1..1d895c8c7dabf 100644 --- a/src/core/server/saved_objects/import/lib/regenerate_ids.ts +++ b/src/core/server/saved_objects/import/lib/regenerate_ids.ts @@ -7,7 +7,7 @@ */ import { v4 as uuidv4 } from 'uuid'; -import { SavedObject } from '../../types'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; import type { ImportStateMap } from './types'; /** diff --git a/src/core/server/saved_objects/import/lib/split_overwrites.ts b/src/core/server/saved_objects/import/lib/split_overwrites.ts index 8f2d15d37ea09..818b6e512dcc2 100644 --- a/src/core/server/saved_objects/import/lib/split_overwrites.ts +++ b/src/core/server/saved_objects/import/lib/split_overwrites.ts @@ -6,8 +6,7 @@ * Side Public License, v 1. */ -import { SavedObject } from '../../types'; -import { SavedObjectsImportRetry } from '../types'; +import type { SavedObject, SavedObjectsImportRetry } from '@kbn/core-saved-objects-common'; export function splitOverwrites( savedObjects: Array>, diff --git a/src/core/server/saved_objects/import/lib/validate_references.ts b/src/core/server/saved_objects/import/lib/validate_references.ts index b454bf8c887a4..8f271908bf48d 100644 --- a/src/core/server/saved_objects/import/lib/validate_references.ts +++ b/src/core/server/saved_objects/import/lib/validate_references.ts @@ -6,8 +6,12 @@ * Side Public License, v 1. */ -import { SavedObject, SavedObjectsClientContract } from '../../types'; -import { SavedObjectsImportFailure, SavedObjectsImportRetry } from '../types'; +import type { + SavedObject, + SavedObjectsImportFailure, + SavedObjectsImportRetry, +} from '@kbn/core-saved-objects-common'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; import { SavedObjectsImportError } from '../errors'; import type { ImportStateMap } from './types'; @@ -16,6 +20,7 @@ const REF_TYPES_TO_VALIDATE = ['index-pattern', 'search']; function filterReferencesToValidate({ type }: { type: string }) { return REF_TYPES_TO_VALIDATE.includes(type); } + const getObjectsToSkip = (retries: SavedObjectsImportRetry[] = []) => retries.reduce( (acc, { type, id, ignoreMissingReferences }) => diff --git a/src/core/server/saved_objects/import/lib/validate_retries.test.ts b/src/core/server/saved_objects/import/lib/validate_retries.test.ts index e81a51b99fe8c..984068b59c575 100644 --- a/src/core/server/saved_objects/import/lib/validate_retries.test.ts +++ b/src/core/server/saved_objects/import/lib/validate_retries.test.ts @@ -6,8 +6,8 @@ * Side Public License, v 1. */ +import type { SavedObjectsImportRetry } from '@kbn/core-saved-objects-common'; import { validateRetries } from './validate_retries'; -import { SavedObjectsImportRetry } from '../types'; import { SavedObjectsImportError } from '../errors'; import { getNonUniqueEntries } from './get_non_unique_entries'; diff --git a/src/core/server/saved_objects/import/lib/validate_retries.ts b/src/core/server/saved_objects/import/lib/validate_retries.ts index f1c06f73c63ae..745bb9fd42354 100644 --- a/src/core/server/saved_objects/import/lib/validate_retries.ts +++ b/src/core/server/saved_objects/import/lib/validate_retries.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { SavedObjectsImportRetry } from '../types'; +import type { SavedObjectsImportRetry } from '@kbn/core-saved-objects-common'; import { getNonUniqueEntries } from './get_non_unique_entries'; import { SavedObjectsImportError } from '../errors'; diff --git a/src/core/server/saved_objects/import/resolve_import_errors.test.ts b/src/core/server/saved_objects/import/resolve_import_errors.test.ts index 2a228df80f2d3..5a2f91e10ac6f 100644 --- a/src/core/server/saved_objects/import/resolve_import_errors.test.ts +++ b/src/core/server/saved_objects/import/resolve_import_errors.test.ts @@ -23,15 +23,15 @@ import { import { Readable } from 'stream'; import { v4 as uuidv4 } from 'uuid'; -import { - SavedObjectsClientContract, - SavedObjectsType, +import type { SavedObject, SavedObjectsImportFailure, SavedObjectsImportRetry, SavedObjectReference, SavedObjectsImportWarning, -} from '../types'; +} from '@kbn/core-saved-objects-common'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; +import { SavedObjectsType } from '../types'; import { savedObjectsClientMock } from '../../mocks'; import { ISavedObjectTypeRegistry, SavedObjectsImportHook } from '..'; import { typeRegistryMock } from '../saved_objects_type_registry.mock'; diff --git a/src/core/server/saved_objects/import/resolve_import_errors.ts b/src/core/server/saved_objects/import/resolve_import_errors.ts index 99daf2113e287..21e7eaee0cf36 100644 --- a/src/core/server/saved_objects/import/resolve_import_errors.ts +++ b/src/core/server/saved_objects/import/resolve_import_errors.ts @@ -7,14 +7,16 @@ */ import { Readable } from 'stream'; -import { SavedObject, SavedObjectsClientContract, SavedObjectsImportRetry } from '../types'; -import { ISavedObjectTypeRegistry } from '../saved_objects_type_registry'; -import { +import type { + SavedObject, + SavedObjectsImportRetry, SavedObjectsImportFailure, - SavedObjectsImportHook, SavedObjectsImportResponse, SavedObjectsImportSuccess, -} from './types'; +} from '@kbn/core-saved-objects-common'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; +import { ISavedObjectTypeRegistry } from '../saved_objects_type_registry'; +import { SavedObjectsImportHook } from './types'; import { collectSavedObjects, createObjectsFilter, diff --git a/src/core/server/saved_objects/import/saved_objects_importer.ts b/src/core/server/saved_objects/import/saved_objects_importer.ts index cc73b2d041edc..34f3692a2c0d4 100644 --- a/src/core/server/saved_objects/import/saved_objects_importer.ts +++ b/src/core/server/saved_objects/import/saved_objects_importer.ts @@ -6,12 +6,12 @@ * Side Public License, v 1. */ +import type { SavedObjectsImportResponse } from '@kbn/core-saved-objects-common'; import { SavedObjectsClientContract } from '../types'; import { ISavedObjectTypeRegistry } from '../saved_objects_type_registry'; import { importSavedObjectsFromStream } from './import_saved_objects'; import { resolveSavedObjectsImportErrors } from './resolve_import_errors'; import { - SavedObjectsImportResponse, SavedObjectsImportOptions, SavedObjectsResolveImportErrorsOptions, SavedObjectsImportHook, diff --git a/src/core/server/saved_objects/import/types.ts b/src/core/server/saved_objects/import/types.ts index d3a38b48e92cb..fdfbc70e27911 100644 --- a/src/core/server/saved_objects/import/types.ts +++ b/src/core/server/saved_objects/import/types.ts @@ -7,140 +7,11 @@ */ import { Readable } from 'stream'; -import { SavedObject } from '../types'; - -/** - * Describes a retry operation for importing a saved object. - * @public - */ -export interface SavedObjectsImportRetry { - type: string; - id: string; - overwrite: boolean; - /** - * The object ID that will be created or overwritten. If not specified, the `id` field will be used. - */ - destinationId?: string; - replaceReferences: Array<{ - type: string; - from: string; - to: string; - }>; - /** - * If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where - * `createNewCopies` mode is disabled and ambiguous source conflicts are detected. - */ - createNewCopy?: boolean; - /** - * If `ignoreMissingReferences` is specified, reference validation will be skipped for this object. - */ - ignoreMissingReferences?: boolean; -} - -/** - * Represents a failure to import due to a conflict. - * @public - */ -export interface SavedObjectsImportConflictError { - type: 'conflict'; - destinationId?: string; -} - -/** - * Represents a failure to import due to a conflict, which can be resolved in different ways with an overwrite. - * @public - */ -export interface SavedObjectsImportAmbiguousConflictError { - type: 'ambiguous_conflict'; - destinations: Array<{ id: string; title?: string; updatedAt?: string }>; -} - -/** - * Represents a failure to import due to having an unsupported saved object type. - * @public - */ -export interface SavedObjectsImportUnsupportedTypeError { - type: 'unsupported_type'; -} - -/** - * Represents a failure to import due to an unknown reason. - * @public - */ -export interface SavedObjectsImportUnknownError { - type: 'unknown'; - message: string; - statusCode: number; -} - -/** - * Represents a failure to import due to missing references. - * @public - */ -export interface SavedObjectsImportMissingReferencesError { - type: 'missing_references'; - references: Array<{ type: string; id: string }>; -} - -/** - * Represents a failure to import. - * @public - */ -export interface SavedObjectsImportFailure { - id: string; - type: string; - meta: { title?: string; icon?: string }; - /** - * If `overwrite` is specified, an attempt was made to overwrite an existing object. - */ - overwrite?: boolean; - error: - | SavedObjectsImportConflictError - | SavedObjectsImportAmbiguousConflictError - | SavedObjectsImportUnsupportedTypeError - | SavedObjectsImportMissingReferencesError - | SavedObjectsImportUnknownError; -} - -/** - * Represents a successful import. - * @public - */ -export interface SavedObjectsImportSuccess { - id: string; - type: string; - /** - * If `destinationId` is specified, the new object has a new ID that is different from the import ID. - */ - destinationId?: string; - /** - * @deprecated Can be removed when https://github.com/elastic/kibana/issues/91615 is done. - * If `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where - * `createNewCopies` mode is disabled and ambiguous source conflicts are detected. When `createNewCopies` mode is permanently enabled, - * this field will be redundant and can be removed. - */ - createNewCopy?: boolean; - meta: { - title?: string; - icon?: string; - }; - /** - * If `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution). - */ - overwrite?: boolean; -} - -/** - * The response describing the result of an import. - * @public - */ -export interface SavedObjectsImportResponse { - success: boolean; - successCount: number; - successResults?: SavedObjectsImportSuccess[]; - warnings: SavedObjectsImportWarning[]; - errors?: SavedObjectsImportFailure[]; -} +import { + SavedObject, + SavedObjectsImportRetry, + SavedObjectsImportWarning, +} from '@kbn/core-saved-objects-common'; /** * Options to control the import operation. @@ -176,47 +47,6 @@ export interface SavedObjectsResolveImportErrorsOptions { export type CreatedObject = SavedObject & { destinationId?: string }; -/** - * A simple informative warning that will be displayed to the user. - * - * @public - */ -export interface SavedObjectsImportSimpleWarning { - type: 'simple'; - /** The translated message to display to the user */ - message: string; -} - -/** - * A warning meant to notify that a specific user action is required to finalize the import - * of some type of object. - * - * @remark The `actionUrl` must be a path relative to the basePath, and not include it. - * - * @public - */ -export interface SavedObjectsImportActionRequiredWarning { - type: 'action_required'; - /** The translated message to display to the user. */ - message: string; - /** The path (without the basePath) that the user should be redirect to address this warning. */ - actionPath: string; - /** An optional label to use for the link button. If unspecified, a default label will be used. */ - buttonLabel?: string; -} - -/** - * Composite type of all the possible types of import warnings. - * - * See {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning} - * for more details. - * - * @public - */ -export type SavedObjectsImportWarning = - | SavedObjectsImportSimpleWarning - | SavedObjectsImportActionRequiredWarning; - /** * Result from a {@link SavedObjectsImportHook | import hook} * diff --git a/src/core/server/saved_objects/index.ts b/src/core/server/saved_objects/index.ts index 434096193ff9f..72d791667e163 100644 --- a/src/core/server/saved_objects/index.ts +++ b/src/core/server/saved_objects/index.ts @@ -12,23 +12,11 @@ export { SavedObjectsImporter } from './import'; export type { ISavedObjectsImporter, - SavedObjectsImportAmbiguousConflictError, - SavedObjectsImportConflictError, - SavedObjectsImportFailure, - SavedObjectsImportMissingReferencesError, SavedObjectsImportOptions, - SavedObjectsImportResponse, - SavedObjectsImportRetry, - SavedObjectsImportSuccess, - SavedObjectsImportUnknownError, - SavedObjectsImportUnsupportedTypeError, SavedObjectsResolveImportErrorsOptions, SavedObjectsImportError, SavedObjectsImportHook, SavedObjectsImportHookResult, - SavedObjectsImportSimpleWarning, - SavedObjectsImportActionRequiredWarning, - SavedObjectsImportWarning, } from './import'; export type { @@ -65,13 +53,6 @@ export type { SavedObjectsRepositoryFactory, } from './saved_objects_service'; -export type { - ISavedObjectsRepository, - SavedObjectsIncrementCounterOptions, - SavedObjectsIncrementCounterField, - SavedObjectsDeleteByNamespaceOptions, -} from './service/lib/repository'; - export type { SavedObjectsFieldMapping, SavedObjectsMappingProperties, @@ -87,7 +68,6 @@ export type { export { mergeSavedObjectMigrationMaps } from './migrations'; export type { - SavedObjectsNamespaceType, SavedObjectStatusMeta, SavedObjectsType, SavedObjectsTypeManagementDefinition, diff --git a/src/core/server/saved_objects/migrations/README.md b/src/core/server/saved_objects/migrations/README.md index 03bbb0bc731c4..12d3b2d490583 100644 --- a/src/core/server/saved_objects/migrations/README.md +++ b/src/core/server/saved_objects/migrations/README.md @@ -149,7 +149,7 @@ index. ### New control state 1. Two conditions have to be met before migrations begin: - 1. The Elasticsearch shard allocation cluster setting `cluster.routing.allocation.enable` needs to be unset or set to 'all'. When set to 'primaries', 'new_primaries' or 'none', the migration will timeout when waiting for index yellow status before bulk indexing because the replica cannot be allocated. + 1. The Elasticsearch shard allocation cluster setting `cluster.routing.allocation.enable` needs to be unset or set to 'all'. When set to 'primaries', 'new_primaries' or 'none', the migration will timeout when waiting for index green status before bulk indexing because the replica cannot be allocated. As per the Elasticsearch docs https://www.elastic.co/guide/en/elasticsearch/reference/8.2/restart-cluster.html#restart-cluster-rolling when Cloud performs a rolling restart such as during an upgrade, it will temporarily disable shard allocation. Kibana therefore keeps retrying the INIT step to wait for shard allocation to be enabled again. @@ -182,12 +182,12 @@ and the migration source index is the index the `.kibana` alias points to. ### Next action `createIndex` -Create the target index. This operation is idempotent, if the index already exist, we wait until its status turns yellow +Create the target index. This operation is idempotent, if the index already exist, we wait until its status turns green ### New control state 1. If the action succeeds → `MARK_VERSION_INDEX_READY` -2. If the action fails with a `index_not_yellow_timeout` +2. If the action fails with a `index_not_green_timeout` → `CREATE_NEW_TARGET` @@ -219,7 +219,7 @@ saved objects index in 7.4 it will be reindexed into `.kibana_pre7.4.0_001`) ### New control state 1. If the index creation succeeds → `LEGACY_REINDEX` -2. If the index creation task failed with a `index_not_yellow_timeout` +2. If the index creation task failed with a `index_not_green_timeout` → `LEGACY_REINDEX_WAIT_FOR_TASK` ## LEGACY_REINDEX ### Next action @@ -261,10 +261,9 @@ new `.kibana` alias that points to `.kibana_pre6.5.0_001`. ## WAIT_FOR_YELLOW_SOURCE ### Next action -`waitForIndexStatusYellow` +`waitForIndexStatus` (status='yellow') -Wait for the Elasticsearch cluster to be in "yellow" state. It means the index's primary shard is allocated and the index is ready for searching/indexing documents, but ES wasn't able to allocate the replicas. -We don't have as much data redundancy as we could have, but it's enough to start the migration. +Wait for the source index to become yellow. This means the index's primary has been allocated and is ready for reading/searching. On a multi node cluster the replicas for this index might not be ready yet but since we're never writing to the source index it does not matter. ### New control state 1. If the action succeeds @@ -285,7 +284,7 @@ Set a write block on the source index to prevent any older Kibana instances from ### Next action `createIndex` -This operation is idempotent, if the index already exist, we wait until its status turns yellow. +This operation is idempotent, if the index already exist, we wait until its status turns green. - Because we will be transforming documents before writing them into this index, we can already set the mappings to the target mappings for this version. The source index might contain documents belonging to a disabled plugin. So set `dynamic: false` mappings for any unknown saved object types. - (Since we never query the temporary index we can potentially disable refresh to speed up indexing performance. Profile to see if gains justify complexity) @@ -293,7 +292,7 @@ This operation is idempotent, if the index already exist, we wait until its stat ### New control state 1. If the action succeeds → `REINDEX_SOURCE_TO_TEMP_OPEN_PIT` -2. If the action fails with a `index_not_yellow_timeout` +2. If the action fails with a `index_not_green_timeout` → `CREATE_REINDEX_TEMP` ## REINDEX_SOURCE_TO_TEMP_OPEN_PIT @@ -368,14 +367,14 @@ Set a write block on the temporary index so that we can clone it. ### Next action `cloneIndex` -Ask elasticsearch to clone the temporary index into the target index. If the target index already exists (because another node already started the clone operation), wait until the clone is complete by waiting for a yellow index status. +Ask elasticsearch to clone the temporary index into the target index. If the target index already exists (because another node already started the clone operation), wait until the clone is complete by waiting for a green index status. We can’t use the temporary index as our target index because one instance can complete the migration, delete a document, and then a second instance starts the reindex operation and re-creates the deleted document. By cloning the temporary index and only accepting writes/deletes from the cloned target index, we prevent lost acknowledged deletes. ### New control state 1. If the action succeeds → `OUTDATED_DOCUMENTS_SEARCH` -2. If the action fails with a `index_not_yellow_timeout` +2. If the action fails with a `index_not_green_timeout` → `CLONE_TEMP_TO_TARGET` ## OUTDATED_DOCUMENTS_SEARCH diff --git a/src/core/server/saved_objects/migrations/actions/check_for_unknown_docs.ts b/src/core/server/saved_objects/migrations/actions/check_for_unknown_docs.ts index a7027c65d011e..bc101416b9fee 100644 --- a/src/core/server/saved_objects/migrations/actions/check_for_unknown_docs.ts +++ b/src/core/server/saved_objects/migrations/actions/check_for_unknown_docs.ts @@ -44,8 +44,9 @@ export interface UnknownDocsFound { } /** - * Performs a search in ES, aggregating documents by type, - * retrieving a bunch of documents for each type. + * Performs a search in ES, aggregating documents by type, retrieving a bunch + * of documents for each type. + * * @internal * @param esClient The ES client to perform the search query * @param targetIndices The ES indices to target diff --git a/src/core/server/saved_objects/migrations/actions/clone_index.ts b/src/core/server/saved_objects/migrations/actions/clone_index.ts index 8b0bce96989f2..80b2ff527740c 100644 --- a/src/core/server/saved_objects/migrations/actions/clone_index.ts +++ b/src/core/server/saved_objects/migrations/actions/clone_index.ts @@ -15,8 +15,8 @@ import { catchRetryableEsClientErrors, RetryableEsClientError, } from './catch_retryable_es_client_errors'; -import type { IndexNotFound, AcknowledgeResponse, IndexNotYellowTimeout } from '.'; -import { waitForIndexStatusYellow } from './wait_for_index_status_yellow'; +import type { IndexNotFound, AcknowledgeResponse } from '.'; +import { type IndexNotGreenTimeout, waitForIndexStatus } from './wait_for_index_status'; import { DEFAULT_TIMEOUT, INDEX_AUTO_EXPAND_REPLICAS, @@ -52,7 +52,7 @@ export const cloneIndex = ({ target, timeout = DEFAULT_TIMEOUT, }: CloneIndexParams): TaskEither.TaskEither< - RetryableEsClientError | IndexNotFound | IndexNotYellowTimeout | ClusterShardLimitExceeded, + RetryableEsClientError | IndexNotFound | IndexNotGreenTimeout | ClusterShardLimitExceeded, CloneIndexResponse > => { const cloneTask: TaskEither.TaskEither< @@ -60,32 +60,29 @@ export const cloneIndex = ({ AcknowledgeResponse > = () => { return client.indices - .clone( - { - index: source, - target, - wait_for_active_shards: WAIT_FOR_ALL_SHARDS_TO_BE_ACTIVE, - body: { - settings: { - index: { - // The source we're cloning from will have a write block set, so - // we need to remove it to allow writes to our newly cloned index - 'blocks.write': false, - number_of_shards: INDEX_NUMBER_OF_SHARDS, - auto_expand_replicas: INDEX_AUTO_EXPAND_REPLICAS, - // Set an explicit refresh interval so that we don't inherit the - // value from incorrectly configured index templates (not required - // after we adopt system indices) - refresh_interval: '1s', - // Bump priority so that recovery happens before newer indices - priority: 10, - }, + .clone({ + index: source, + target, + wait_for_active_shards: WAIT_FOR_ALL_SHARDS_TO_BE_ACTIVE, + body: { + settings: { + index: { + // The source we're cloning from will have a write block set, so + // we need to remove it to allow writes to our newly cloned index + 'blocks.write': false, + number_of_shards: INDEX_NUMBER_OF_SHARDS, + auto_expand_replicas: INDEX_AUTO_EXPAND_REPLICAS, + // Set an explicit refresh interval so that we don't inherit the + // value from incorrectly configured index templates (not required + // after we adopt system indices) + refresh_interval: '1s', + // Bump priority so that recovery happens before newer indices + priority: 10, }, }, - timeout, }, - { maxRetries: 0 /** handle retry ourselves for now */ } - ) + timeout, + }) .then((response) => { /** * - acknowledged=false, we timed out before the cluster state was @@ -136,7 +133,7 @@ export const cloneIndex = ({ } else { // Otherwise, wait until the target index has a 'yellow' status. return pipe( - waitForIndexStatusYellow({ client, index: target, timeout }), + waitForIndexStatus({ client, index: target, timeout, status: 'green' }), TaskEither.map((value) => { /** When the index status is 'yellow' we know that all shards were started */ return { acknowledged: true, shardsAcknowledged: true }; diff --git a/src/core/server/saved_objects/migrations/actions/constants.ts b/src/core/server/saved_objects/migrations/actions/constants.ts index 5d0d2ffe5d695..536ae1d256960 100644 --- a/src/core/server/saved_objects/migrations/actions/constants.ts +++ b/src/core/server/saved_objects/migrations/actions/constants.ts @@ -11,6 +11,16 @@ * Uses the default value of 1000 for Elasticsearch reindex operation. */ export const BATCH_SIZE = 1_000; +/** + * When a request takes a long time to complete and hits the timeout or the + * client aborts that request due to the requestTimeout, our only course of + * action is to retry that request. This places our request at the end of the + * queue and adds more load to Elasticsearch just making things worse. + * + * So we want to choose as long a timeout as possible. Some load balancers / + * reverse proxies like ELB ignore TCP keep-alive packets so unless there's a + * request or response sent over the socket it will be dropped after 60s. + */ export const DEFAULT_TIMEOUT = '60s'; /** Allocate 1 replica if there are enough data nodes, otherwise continue with 0 */ export const INDEX_AUTO_EXPAND_REPLICAS = '0-1'; diff --git a/src/core/server/saved_objects/migrations/actions/create_index.ts b/src/core/server/saved_objects/migrations/actions/create_index.ts index 3436845f82382..41ee20fc9562d 100644 --- a/src/core/server/saved_objects/migrations/actions/create_index.ts +++ b/src/core/server/saved_objects/migrations/actions/create_index.ts @@ -22,7 +22,7 @@ import { INDEX_AUTO_EXPAND_REPLICAS, WAIT_FOR_ALL_SHARDS_TO_BE_ACTIVE, } from './constants'; -import { IndexNotYellowTimeout, waitForIndexStatusYellow } from './wait_for_index_status_yellow'; +import { type IndexNotGreenTimeout, waitForIndexStatus } from './wait_for_index_status'; import { isClusterShardLimitExceeded } from './es_errors'; function aliasArrayToRecord(aliases: string[]): Record { @@ -44,6 +44,7 @@ export interface CreateIndexParams { indexName: string; mappings: IndexMapping; aliases?: string[]; + timeout?: string; } /** * Creates an index with the given mappings @@ -60,8 +61,9 @@ export const createIndex = ({ indexName, mappings, aliases = [], + timeout = DEFAULT_TIMEOUT, }: CreateIndexParams): TaskEither.TaskEither< - RetryableEsClientError | IndexNotYellowTimeout | ClusterShardLimitExceeded, + RetryableEsClientError | IndexNotGreenTimeout | ClusterShardLimitExceeded, 'create_index_succeeded' > => { const createIndexTask: TaskEither.TaskEither< @@ -71,36 +73,34 @@ export const createIndex = ({ const aliasesObject = aliasArrayToRecord(aliases); return client.indices - .create( - { - index: indexName, - // wait until all shards are available before creating the index - // (since number_of_shards=1 this does not have any effect atm) - wait_for_active_shards: WAIT_FOR_ALL_SHARDS_TO_BE_ACTIVE, - // Wait up to 60s for the cluster state to update and all shards to be - // started - timeout: DEFAULT_TIMEOUT, - body: { - mappings, - aliases: aliasesObject, - settings: { - index: { - // ES rule of thumb: shards should be several GB to 10's of GB, so - // Kibana is unlikely to cross that limit. - number_of_shards: 1, - auto_expand_replicas: INDEX_AUTO_EXPAND_REPLICAS, - // Set an explicit refresh interval so that we don't inherit the - // value from incorrectly configured index templates (not required - // after we adopt system indices) - refresh_interval: '1s', - // Bump priority so that recovery happens before newer indices - priority: 10, - }, + .create({ + index: indexName, + // wait up to timeout until the following shards are available before + // creating the index: primary, replica (only on multi node clusters) + wait_for_active_shards: WAIT_FOR_ALL_SHARDS_TO_BE_ACTIVE, + // Timeout for the cluster state to update and all shards to become + // available. If the request doesn't complete within timeout, + // acknowledged or shards_acknowledged would be false. + timeout, + body: { + mappings, + aliases: aliasesObject, + settings: { + index: { + // ES rule of thumb: shards should be several GB to 10's of GB, so + // Kibana is unlikely to cross that limit. + number_of_shards: 1, + auto_expand_replicas: INDEX_AUTO_EXPAND_REPLICAS, + // Set an explicit refresh interval so that we don't inherit the + // value from incorrectly configured index templates (not required + // after we adopt system indices) + refresh_interval: '1s', + // Bump priority so that recovery happens before newer indices + priority: 10, }, }, }, - { maxRetries: 0 /** handle retry ourselves for now */ } - ) + }) .then((res) => { /** * - acknowledged=false, we timed out before the cluster state was @@ -140,19 +140,25 @@ export const createIndex = ({ return pipe( createIndexTask, TaskEither.chain< - RetryableEsClientError | IndexNotYellowTimeout | ClusterShardLimitExceeded, + RetryableEsClientError | IndexNotGreenTimeout | ClusterShardLimitExceeded, AcknowledgeResponse, 'create_index_succeeded' >((res) => { if (res.acknowledged && res.shardsAcknowledged) { - // If the cluster state was updated and all shards ackd we're done + // If the cluster state was updated and all shards started we're done return TaskEither.right('create_index_succeeded'); } else { - // Otherwise, wait until the target index has a 'yellow' status. + // Otherwise, wait until the target index has a 'green' status meaning + // the primary (and on multi node clusters) the replica has been started return pipe( - waitForIndexStatusYellow({ client, index: indexName, timeout: DEFAULT_TIMEOUT }), + waitForIndexStatus({ + client, + index: indexName, + timeout: DEFAULT_TIMEOUT, + status: 'green', + }), TaskEither.map(() => { - /** When the index status is 'yellow' we know that all shards were started */ + /** When the index status is 'green' we know that all shards were started */ return 'create_index_succeeded'; }) ); diff --git a/src/core/server/saved_objects/migrations/actions/fetch_indices.ts b/src/core/server/saved_objects/migrations/actions/fetch_indices.ts index a88d610a90221..922797f2ba268 100644 --- a/src/core/server/saved_objects/migrations/actions/fetch_indices.ts +++ b/src/core/server/saved_objects/migrations/actions/fetch_indices.ts @@ -34,18 +34,14 @@ export const fetchIndices = client, indices, }: FetchIndicesParams): TaskEither.TaskEither => - // @ts-expect-error @elastic/elasticsearch IndexState.alias and IndexState.mappings should be required () => { return client.indices - .get( - { - index: indices, - ignore_unavailable: true, // Don't return an error for missing indices. Note this *will* include closed indices, the docs are misleading https://github.com/elastic/elasticsearch/issues/63607 - }, - { maxRetries: 0 } - ) + .get({ + index: indices, + ignore_unavailable: true, // Don't return an error for missing indices. Note this *will* include closed indices, the docs are misleading https://github.com/elastic/elasticsearch/issues/63607 + }) .then((body) => { - return Either.right(body); + return Either.right(body as FetchIndexResponse); }) .catch(catchRetryableEsClientErrors); }; diff --git a/src/core/server/saved_objects/migrations/actions/index.ts b/src/core/server/saved_objects/migrations/actions/index.ts index 4ac6bfa24fee6..2b6d501f787b0 100644 --- a/src/core/server/saved_objects/migrations/actions/index.ts +++ b/src/core/server/saved_objects/migrations/actions/index.ts @@ -35,11 +35,12 @@ export { removeWriteBlock } from './remove_write_block'; export type { CloneIndexResponse, CloneIndexParams } from './clone_index'; export { cloneIndex } from './clone_index'; -export type { - WaitForIndexStatusYellowParams, - IndexNotYellowTimeout, -} from './wait_for_index_status_yellow'; -import { IndexNotYellowTimeout, waitForIndexStatusYellow } from './wait_for_index_status_yellow'; +export type { WaitForIndexStatusParams, IndexNotYellowTimeout } from './wait_for_index_status'; +import { + type IndexNotGreenTimeout, + type IndexNotYellowTimeout, + waitForIndexStatus, +} from './wait_for_index_status'; export type { WaitForTaskResponse, WaitForTaskCompletionTimeout } from './wait_for_task'; import { waitForTask, WaitForTaskCompletionTimeout } from './wait_for_task'; @@ -48,7 +49,7 @@ export type { UpdateByQueryResponse } from './pickup_updated_mappings'; import { pickupUpdatedMappings } from './pickup_updated_mappings'; export type { OpenPitResponse, OpenPitParams } from './open_pit'; -export { openPit, pitKeepAlive } from './open_pit'; +export { openPit } from './open_pit'; export type { ReadWithPit, ReadWithPitParams } from './read_with_pit'; export { readWithPit } from './read_with_pit'; @@ -69,9 +70,6 @@ import type { IncompatibleMappingException } from './wait_for_reindex_task'; export { waitForReindexTask } from './wait_for_reindex_task'; -export type { VerifyReindexParams } from './verify_reindex'; -export { verifyReindex } from './verify_reindex'; - import type { AliasNotFound, RemoveIndexNotAConcreteIndex } from './update_aliases'; export type { AliasAction, UpdateAliasesParams } from './update_aliases'; @@ -114,7 +112,7 @@ export type { } from './calculate_exclude_filters'; export { calculateExcludeFilters } from './calculate_exclude_filters'; -export { pickupUpdatedMappings, waitForTask, waitForIndexStatusYellow }; +export { pickupUpdatedMappings, waitForTask, waitForIndexStatus }; export type { AliasNotFound, RemoveIndexNotAConcreteIndex }; export interface IndexNotFound { @@ -153,6 +151,7 @@ export interface ActionErrorTypeMap { request_entity_too_large_exception: RequestEntityTooLargeException; unknown_docs_found: UnknownDocsFound; incompatible_cluster_routing_allocation: IncompatibleClusterRoutingAllocation; + index_not_green_timeout: IndexNotGreenTimeout; index_not_yellow_timeout: IndexNotYellowTimeout; cluster_shard_limit_exceeded: ClusterShardLimitExceeded; } diff --git a/src/core/server/saved_objects/migrations/actions/open_pit.ts b/src/core/server/saved_objects/migrations/actions/open_pit.ts index c17b42d13a8c4..3966198393c21 100644 --- a/src/core/server/saved_objects/migrations/actions/open_pit.ts +++ b/src/core/server/saved_objects/migrations/actions/open_pit.ts @@ -25,7 +25,7 @@ export interface OpenPitParams { index: string; } // how long ES should keep PIT alive -export const pitKeepAlive = '10m'; +export const DEFAULT_PIT_KEEP_ALIVE = '10m'; /* * Creates a lightweight view of data when the request has been initiated. * See https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html @@ -39,7 +39,7 @@ export const openPit = return client .openPointInTime({ index, - keep_alive: pitKeepAlive, + keep_alive: DEFAULT_PIT_KEEP_ALIVE, }) .then((response) => Either.right({ pitId: response.id })) .catch(catchRetryableEsClientErrors); diff --git a/src/core/server/saved_objects/migrations/actions/read_with_pit.ts b/src/core/server/saved_objects/migrations/actions/read_with_pit.ts index 10d5ff6bfff88..91e12ddc33c23 100644 --- a/src/core/server/saved_objects/migrations/actions/read_with_pit.ts +++ b/src/core/server/saved_objects/migrations/actions/read_with_pit.ts @@ -15,7 +15,7 @@ import { catchRetryableEsClientErrors, RetryableEsClientError, } from './catch_retryable_es_client_errors'; -import { pitKeepAlive } from './open_pit'; +import { DEFAULT_PIT_KEEP_ALIVE } from './open_pit'; /** @internal */ export interface ReadWithPit { @@ -49,11 +49,18 @@ export const readWithPit = () => { return client .search({ - allow_partial_search_results: false, seq_no_primary_term: seqNoPrimaryTerm, - // Sort fields are required to use searchAfter + // Fail if the index being searched doesn't exist or is closed + // allow_no_indices: false, + // By default ES returns a 200 with partial results if there are shard + // request timeouts or shard failures which can lead to data loss for + // migrations + allow_partial_search_results: false, + // Sort fields are required to use searchAfter so we sort by the + // natural order of the index which is the most efficient option + // as order is not important for the migration sort: '_shard_doc:asc', - pit: { id: pitId, keep_alive: pitKeepAlive }, + pit: { id: pitId, keep_alive: DEFAULT_PIT_KEEP_ALIVE }, size: batchSize, search_after: searchAfter, /** diff --git a/src/core/server/saved_objects/migrations/actions/remove_write_block.ts b/src/core/server/saved_objects/migrations/actions/remove_write_block.ts index e5c64c8385e91..d4e4ad4b8e7c8 100644 --- a/src/core/server/saved_objects/migrations/actions/remove_write_block.ts +++ b/src/core/server/saved_objects/migrations/actions/remove_write_block.ts @@ -33,19 +33,16 @@ export const removeWriteBlock = > => () => { return client.indices - .putSettings( - { - index, - // Don't change any existing settings - preserve_existing: true, - body: { - blocks: { - write: false, - }, + .putSettings({ + index, + // Don't change any existing settings + preserve_existing: true, + body: { + blocks: { + write: false, }, }, - { maxRetries: 0 /** handle retry ourselves for now */ } - ) + }) .then((res) => { return res.acknowledged === true ? Either.right('remove_write_block_succeeded' as const) diff --git a/src/core/server/saved_objects/migrations/actions/update_aliases.ts b/src/core/server/saved_objects/migrations/actions/update_aliases.ts index 1a5e487ce9205..5843599e55afc 100644 --- a/src/core/server/saved_objects/migrations/actions/update_aliases.ts +++ b/src/core/server/saved_objects/migrations/actions/update_aliases.ts @@ -49,14 +49,11 @@ export const updateAliases = > => () => { return client.indices - .updateAliases( - { - body: { - actions: aliasActions, - }, + .updateAliases({ + body: { + actions: aliasActions, }, - { maxRetries: 0 } - ) + }) .then(() => { // Ignore `acknowledged: false`. When the coordinating node accepts // the new cluster state update but not all nodes have applied the diff --git a/src/core/server/saved_objects/migrations/actions/verify_reindex.ts b/src/core/server/saved_objects/migrations/actions/verify_reindex.ts deleted file mode 100644 index 866ec9974e929..0000000000000 --- a/src/core/server/saved_objects/migrations/actions/verify_reindex.ts +++ /dev/null @@ -1,54 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import * as Either from 'fp-ts/lib/Either'; -import * as TaskEither from 'fp-ts/lib/TaskEither'; -import type { ElasticsearchClient } from '@kbn/core-elasticsearch-server'; -import { - catchRetryableEsClientErrors, - RetryableEsClientError, -} from './catch_retryable_es_client_errors'; - -/** @internal */ -export interface VerifyReindexParams { - client: ElasticsearchClient; - sourceIndex: string; - targetIndex: string; -} - -export const verifyReindex = - ({ - client, - sourceIndex, - targetIndex, - }: VerifyReindexParams): TaskEither.TaskEither< - RetryableEsClientError | { type: 'verify_reindex_failed' }, - 'verify_reindex_succeeded' - > => - () => { - const count = (index: string) => - client - .count({ - index, - // Return an error when targeting missing or closed indices - allow_no_indices: false, - }) - .then((res) => { - return res.count; - }); - - return Promise.all([count(sourceIndex), count(targetIndex)]) - .then(([sourceCount, targetCount]) => { - if (targetCount >= sourceCount) { - return Either.right('verify_reindex_succeeded' as const); - } else { - return Either.left({ type: 'verify_reindex_failed' as const }); - } - }) - .catch(catchRetryableEsClientErrors); - }; diff --git a/src/core/server/saved_objects/migrations/actions/wait_for_index_status_yellow.test.ts b/src/core/server/saved_objects/migrations/actions/wait_for_index_status.test.ts similarity index 89% rename from src/core/server/saved_objects/migrations/actions/wait_for_index_status_yellow.test.ts rename to src/core/server/saved_objects/migrations/actions/wait_for_index_status.test.ts index ecff30c595a78..3a4968be27aa8 100644 --- a/src/core/server/saved_objects/migrations/actions/wait_for_index_status_yellow.test.ts +++ b/src/core/server/saved_objects/migrations/actions/wait_for_index_status.test.ts @@ -7,13 +7,13 @@ */ import { errors as EsErrors } from '@elastic/elasticsearch'; -import { waitForIndexStatusYellow } from './wait_for_index_status_yellow'; +import { waitForIndexStatus } from './wait_for_index_status'; import { elasticsearchClientMock } from '@kbn/core-elasticsearch-client-server-mocks'; import { catchRetryableEsClientErrors } from './catch_retryable_es_client_errors'; jest.mock('./catch_retryable_es_client_errors'); -describe('waitForIndexStatusYellow', () => { +describe('waitForIndexStatus', () => { beforeEach(() => { jest.clearAllMocks(); }); @@ -31,9 +31,10 @@ describe('waitForIndexStatusYellow', () => { ); it('calls catchRetryableEsClientErrors when the promise rejects', async () => { - const task = waitForIndexStatusYellow({ + const task = waitForIndexStatus({ client, index: 'my_index', + status: 'yellow', }); try { await task(); diff --git a/src/core/server/saved_objects/migrations/actions/wait_for_index_status.ts b/src/core/server/saved_objects/migrations/actions/wait_for_index_status.ts new file mode 100644 index 0000000000000..7ee63e7583851 --- /dev/null +++ b/src/core/server/saved_objects/migrations/actions/wait_for_index_status.ts @@ -0,0 +1,103 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import * as Either from 'fp-ts/lib/Either'; +import * as TaskEither from 'fp-ts/lib/TaskEither'; +import type { ElasticsearchClient } from '@kbn/core-elasticsearch-server'; +import { + catchRetryableEsClientErrors, + RetryableEsClientError, +} from './catch_retryable_es_client_errors'; +import { DEFAULT_TIMEOUT } from './constants'; + +/** @internal */ +export interface WaitForIndexStatusParams { + client: ElasticsearchClient; + index: string; + timeout?: string; + status: 'yellow' | 'green'; +} + +export interface IndexNotYellowTimeout { + type: 'index_not_yellow_timeout'; + message: string; +} + +export interface IndexNotGreenTimeout { + type: 'index_not_green_timeout'; + message: string; +} + +export function waitForIndexStatus({ + client, + index, + timeout, + status, +}: WaitForIndexStatusParams & { status: 'yellow' }): TaskEither.TaskEither< + RetryableEsClientError | IndexNotYellowTimeout, + {} +>; + +export function waitForIndexStatus({ + client, + index, + timeout, + status, +}: WaitForIndexStatusParams & { status: 'green' }): TaskEither.TaskEither< + RetryableEsClientError | IndexNotGreenTimeout, + {} +>; + +/** + * Wait until an index status become either 'yellow' or 'green'. + * + * A yellow index status means the index's primary shard was allocated but ES + * wasn't able to allocate the replica. Thus a yellow index can be searched + * and read from but indexing documents with `wait_for_active_shards='all'` + * will fail. + * + * A green index status means the index's primary and replica shards has been + * allocated so we can search, read and index documents with + * `wait_for_active_shards='all'`. + */ +export function waitForIndexStatus({ + client, + index, + timeout = DEFAULT_TIMEOUT, + status, +}: WaitForIndexStatusParams): TaskEither.TaskEither< + RetryableEsClientError | IndexNotYellowTimeout | IndexNotGreenTimeout, + {} +> { + return () => { + return client.cluster + .health( + { + index, + wait_for_status: status, + timeout, + }, + { + /* Don't reject on status code 408 so that we can handle the timeout + * explicitly with a custom response type and provide more context in the error message + */ + ignore: [408], + } + ) + .then((res) => { + if (res.timed_out === true) { + return Either.left({ + type: `index_not_${status}_timeout` as const, + message: `[index_not_${status}_timeout] Timeout waiting for the status of the [${index}] index to become '${status}'`, + }); + } + return Either.right({}); + }) + .catch(catchRetryableEsClientErrors); + }; +} diff --git a/src/core/server/saved_objects/migrations/actions/wait_for_index_status_yellow.ts b/src/core/server/saved_objects/migrations/actions/wait_for_index_status_yellow.ts deleted file mode 100644 index a306c0d2d058c..0000000000000 --- a/src/core/server/saved_objects/migrations/actions/wait_for_index_status_yellow.ts +++ /dev/null @@ -1,71 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import * as Either from 'fp-ts/lib/Either'; -import * as TaskEither from 'fp-ts/lib/TaskEither'; -import type { ElasticsearchClient } from '@kbn/core-elasticsearch-server'; -import { - catchRetryableEsClientErrors, - RetryableEsClientError, -} from './catch_retryable_es_client_errors'; -import { DEFAULT_TIMEOUT } from './constants'; - -/** @internal */ -export interface WaitForIndexStatusYellowParams { - client: ElasticsearchClient; - index: string; - timeout?: string; -} - -export interface IndexNotYellowTimeout { - type: 'index_not_yellow_timeout'; - message: string; -} -/** - * A yellow index status means the index's primary shard is allocated and the - * index is ready for searching/indexing documents, but ES wasn't able to - * allocate the replicas. When migrations proceed with a yellow index it means - * we don't have as much data-redundancy as we could have, but waiting for - * replicas would mean that v2 migrations fail where v1 migrations would have - * succeeded. It doesn't feel like it's Kibana's job to force users to keep - * their clusters green and even if it's green when we migrate it can turn - * yellow at any point in the future. So ultimately data-redundancy is up to - * users to maintain. - */ -export const waitForIndexStatusYellow = - ({ - client, - index, - timeout = DEFAULT_TIMEOUT, - }: WaitForIndexStatusYellowParams): TaskEither.TaskEither< - RetryableEsClientError | IndexNotYellowTimeout, - {} - > => - () => { - return client.cluster - .health( - { - index, - wait_for_status: 'yellow', - timeout, - }, - // Don't reject on status code 408 so that we can handle the timeout - // explicitly with a custom response type and provide more context in the error message - { ignore: [408] } - ) - .then((res) => { - if (res.timed_out === true) { - return Either.left({ - type: 'index_not_yellow_timeout' as const, - message: `[index_not_yellow_timeout] Timeout waiting for the status of the [${index}] index to become 'yellow'`, - }); - } - return Either.right({}); - }) - .catch(catchRetryableEsClientErrors); - }; diff --git a/src/core/server/saved_objects/migrations/core/document_migrator.ts b/src/core/server/saved_objects/migrations/core/document_migrator.ts index fcee8da491496..75f037123a382 100644 --- a/src/core/server/saved_objects/migrations/core/document_migrator.ts +++ b/src/core/server/saved_objects/migrations/core/document_migrator.ts @@ -47,12 +47,12 @@ import { set } from '@elastic/safer-lodash-set'; import _ from 'lodash'; import Semver from 'semver'; import type { Logger } from '@kbn/logging'; -import { SavedObjectUnsanitizedDoc } from '../../serialization'; -import { +import type { SavedObjectsMigrationVersion, SavedObjectsNamespaceType, - SavedObjectsType, -} from '../../types'; +} from '@kbn/core-saved-objects-common'; +import { SavedObjectUnsanitizedDoc } from '../../serialization'; +import { SavedObjectsType } from '../../types'; import { MigrationLogger } from './migration_logger'; import { TransformSavedObjectDocumentError } from '.'; import { ISavedObjectTypeRegistry } from '../../saved_objects_type_registry'; diff --git a/src/core/server/saved_objects/migrations/initial_state.ts b/src/core/server/saved_objects/migrations/initial_state.ts index edf2b60a48145..dc8f5be7e4f36 100644 --- a/src/core/server/saved_objects/migrations/initial_state.ts +++ b/src/core/server/saved_objects/migrations/initial_state.ts @@ -9,8 +9,8 @@ import * as Option from 'fp-ts/Option'; import type { DocLinksServiceStart } from '@kbn/core-doc-links-server'; import type { Logger } from '@kbn/logging'; +import type { SavedObjectsMigrationVersion } from '@kbn/core-saved-objects-common'; import type { IndexMapping } from '../mappings'; -import type { SavedObjectsMigrationVersion } from '../../../types'; import type { SavedObjectsMigrationConfigType } from '../saved_objects_config'; import type { ISavedObjectTypeRegistry } from '../saved_objects_type_registry'; import type { InitState } from './state'; diff --git a/src/core/server/saved_objects/migrations/kibana_migrator.test.ts b/src/core/server/saved_objects/migrations/kibana_migrator.test.ts index 926b6efcf1803..df6ddb9624abe 100644 --- a/src/core/server/saved_objects/migrations/kibana_migrator.test.ts +++ b/src/core/server/saved_objects/migrations/kibana_migrator.test.ts @@ -247,6 +247,9 @@ const mockV2MigrationOptions = () => { }; const mockOptions = () => { + const mockedClient = elasticsearchClientMock.createElasticsearchClient(); + (mockedClient as any).child = jest.fn().mockImplementation(() => mockedClient); + const options: MockedOptions = { logger: loggingSystemMock.create().get(), kibanaVersion: '8.2.3', @@ -284,7 +287,7 @@ const mockOptions = () => { skip: false, retryAttempts: 20, }, - client: elasticsearchClientMock.createElasticsearchClient(), + client: mockedClient, docLinks: docLinksServiceMock.createSetupContract(), }; return options; diff --git a/src/core/server/saved_objects/migrations/model/model.test.ts b/src/core/server/saved_objects/migrations/model/model.test.ts index b61fdc2c8ec8c..eade744a00469 100644 --- a/src/core/server/saved_objects/migrations/model/model.test.ts +++ b/src/core/server/saved_objects/migrations/model/model.test.ts @@ -596,10 +596,10 @@ describe('migrations v2 model', () => { expect(newState.retryCount).toEqual(0); expect(newState.retryDelay).toEqual(0); }); - test('LEGACY_CREATE_REINDEX_TARGET -> LEGACY_CREATE_REINDEX_TARGET if action fails with index_not_yellow_timeout', () => { + test('LEGACY_CREATE_REINDEX_TARGET -> LEGACY_CREATE_REINDEX_TARGET if action fails with index_not_green_timeout', () => { const res: ResponseType<'LEGACY_CREATE_REINDEX_TARGET'> = Either.left({ - message: '[index_not_yellow_timeout] Timeout waiting for ...', - type: 'index_not_yellow_timeout', + message: '[index_not_green_timeout] Timeout waiting for ...', + type: 'index_not_green_timeout', }); const newState = model(legacyCreateReindexTargetState, res); expect(newState.controlState).toEqual('LEGACY_CREATE_REINDEX_TARGET'); @@ -608,7 +608,7 @@ describe('migrations v2 model', () => { expect(newState.logs[0]).toMatchInlineSnapshot(` Object { "level": "error", - "message": "Action failed with '[index_not_yellow_timeout] Timeout waiting for ... Refer to repeatedTimeoutRequests for information on how to resolve the issue.'. Retrying attempt 1 in 2 seconds.", + "message": "Action failed with '[index_not_green_timeout] Timeout waiting for ... Refer to repeatedTimeoutRequests for information on how to resolve the issue.'. Retrying attempt 1 in 2 seconds.", } `); }); @@ -1049,10 +1049,10 @@ describe('migrations v2 model', () => { expect(newState.retryCount).toEqual(0); expect(newState.retryDelay).toEqual(0); }); - it('CREATE_REINDEX_TEMP -> CREATE_REINDEX_TEMP if action fails with index_not_yellow_timeout', () => { + it('CREATE_REINDEX_TEMP -> CREATE_REINDEX_TEMP if action fails with index_not_green_timeout', () => { const res: ResponseType<'CREATE_REINDEX_TEMP'> = Either.left({ - message: '[index_not_yellow_timeout] Timeout waiting for ...', - type: 'index_not_yellow_timeout', + message: '[index_not_green_timeout] Timeout waiting for ...', + type: 'index_not_green_timeout', }); const newState = model(state, res); expect(newState.controlState).toEqual('CREATE_REINDEX_TEMP'); @@ -1061,7 +1061,7 @@ describe('migrations v2 model', () => { expect(newState.logs[0]).toMatchInlineSnapshot(` Object { "level": "error", - "message": "Action failed with '[index_not_yellow_timeout] Timeout waiting for ... Refer to repeatedTimeoutRequests for information on how to resolve the issue.'. Retrying attempt 1 in 2 seconds.", + "message": "Action failed with '[index_not_green_timeout] Timeout waiting for ... Refer to repeatedTimeoutRequests for information on how to resolve the issue.'. Retrying attempt 1 in 2 seconds.", } `); }); @@ -1434,10 +1434,10 @@ describe('migrations v2 model', () => { expect(newState.retryCount).toBe(0); expect(newState.retryDelay).toBe(0); }); - it('CLONE_TEMP_TO_TARGET -> CLONE_TEMP_TO_TARGET if action fails with index_not_yellow_timeout', () => { + it('CLONE_TEMP_TO_TARGET -> CLONE_TEMP_TO_TARGET if action fails with index_not_green_timeout', () => { const res: ResponseType<'CLONE_TEMP_TO_TARGET'> = Either.left({ - message: '[index_not_yellow_timeout] Timeout waiting for ...', - type: 'index_not_yellow_timeout', + message: '[index_not_green_timeout] Timeout waiting for ...', + type: 'index_not_green_timeout', }); const newState = model(state, res); expect(newState.controlState).toEqual('CLONE_TEMP_TO_TARGET'); @@ -1446,7 +1446,7 @@ describe('migrations v2 model', () => { expect(newState.logs[0]).toMatchInlineSnapshot(` Object { "level": "error", - "message": "Action failed with '[index_not_yellow_timeout] Timeout waiting for ... Refer to repeatedTimeoutRequests for information on how to resolve the issue.'. Retrying attempt 1 in 2 seconds.", + "message": "Action failed with '[index_not_green_timeout] Timeout waiting for ... Refer to repeatedTimeoutRequests for information on how to resolve the issue.'. Retrying attempt 1 in 2 seconds.", } `); }); @@ -1963,10 +1963,10 @@ describe('migrations v2 model', () => { expect(newState.retryCount).toEqual(0); expect(newState.retryDelay).toEqual(0); }); - test('CREATE_NEW_TARGET -> CREATE_NEW_TARGET if action fails with index_not_yellow_timeout', () => { + test('CREATE_NEW_TARGET -> CREATE_NEW_TARGET if action fails with index_not_green_timeout', () => { const res: ResponseType<'CREATE_NEW_TARGET'> = Either.left({ - message: '[index_not_yellow_timeout] Timeout waiting for ...', - type: 'index_not_yellow_timeout', + message: '[index_not_green_timeout] Timeout waiting for ...', + type: 'index_not_green_timeout', }); const newState = model(createNewTargetState, res); expect(newState.controlState).toEqual('CREATE_NEW_TARGET'); diff --git a/src/core/server/saved_objects/migrations/model/model.ts b/src/core/server/saved_objects/migrations/model/model.ts index 9ab668b547e21..8eca6d12c4f0a 100644 --- a/src/core/server/saved_objects/migrations/model/model.ts +++ b/src/core/server/saved_objects/migrations/model/model.ts @@ -241,8 +241,8 @@ export const model = (currentState: State, resW: ResponseType): const res = resW as ExcludeRetryableEsError>; if (Either.isLeft(res)) { const left = res.left; - if (isTypeof(left, 'index_not_yellow_timeout')) { - // `index_not_yellow_timeout` for the LEGACY_CREATE_REINDEX_TARGET source index: + if (isTypeof(left, 'index_not_green_timeout')) { + // `index_not_green_timeout` for the LEGACY_CREATE_REINDEX_TARGET source index: // A yellow status timeout could theoretically be temporary for a busy cluster // that takes a long time to allocate the primary and we retry the action to see if // we get a response. @@ -485,10 +485,10 @@ export const model = (currentState: State, resW: ResponseType): return { ...stateP, controlState: 'REINDEX_SOURCE_TO_TEMP_OPEN_PIT' }; } else if (Either.isLeft(res)) { const left = res.left; - if (isTypeof(left, 'index_not_yellow_timeout')) { - // `index_not_yellow_timeout` for the CREATE_REINDEX_TEMP target temp index: - // The index status did not go yellow within the specified timeout period. - // A yellow status timeout could theoretically be temporary for a busy cluster. + if (isTypeof(left, 'index_not_green_timeout')) { + // `index_not_green_timeout` for the CREATE_REINDEX_TEMP target temp index: + // The index status did not go green within the specified timeout period. + // A green status timeout could theoretically be temporary for a busy cluster. // // If there is a problem CREATE_REINDEX_TEMP action will // continue to timeout and eventually lead to a failed migration. @@ -753,9 +753,9 @@ export const model = (currentState: State, resW: ResponseType): ...stateP, controlState: 'REFRESH_TARGET', }; - } else if (isTypeof(left, 'index_not_yellow_timeout')) { - // `index_not_yellow_timeout` for the CLONE_TEMP_TO_TARGET source -> target index: - // The target index status did not go yellow within the specified timeout period. + } else if (isTypeof(left, 'index_not_green_timeout')) { + // `index_not_green_timeout` for the CLONE_TEMP_TO_TARGET source -> target index: + // The target index status did not go green within the specified timeout period. // The cluster could just be busy and we retry the action. // Once we run out of retries, the migration fails. @@ -1019,8 +1019,8 @@ export const model = (currentState: State, resW: ResponseType): }; } else if (Either.isLeft(res)) { const left = res.left; - if (isTypeof(left, 'index_not_yellow_timeout')) { - // `index_not_yellow_timeout` for the CREATE_NEW_TARGET target index: + if (isTypeof(left, 'index_not_green_timeout')) { + // `index_not_green_timeout` for the CREATE_NEW_TARGET target index: // The cluster might just be busy and we retry the action for a set number of times. // If the cluster hit the low watermark for disk usage the action will continue to timeout. // Unless the disk space is addressed, the LEGACY_CREATE_REINDEX_TARGET action will diff --git a/src/core/server/saved_objects/migrations/next.ts b/src/core/server/saved_objects/migrations/next.ts index 7d73d4830259b..9ac29a3a849ba 100644 --- a/src/core/server/saved_objects/migrations/next.ts +++ b/src/core/server/saved_objects/migrations/next.ts @@ -61,7 +61,7 @@ export const nextActionMap = (client: ElasticsearchClient, transformRawDocs: Tra INIT: (state: InitState) => Actions.initAction({ client, indices: [state.currentAlias, state.versionAlias] }), WAIT_FOR_YELLOW_SOURCE: (state: WaitForYellowSourceState) => - Actions.waitForIndexStatusYellow({ client, index: state.sourceIndex.value }), + Actions.waitForIndexStatus({ client, index: state.sourceIndex.value, status: 'yellow' }), CHECK_UNKNOWN_DOCUMENTS: (state: CheckUnknownDocumentsState) => Actions.checkForUnknownDocs({ client, diff --git a/src/core/server/saved_objects/migrations/run_resilient_migrator.ts b/src/core/server/saved_objects/migrations/run_resilient_migrator.ts index 87618dcbab1c9..ce8f9d921e2c6 100644 --- a/src/core/server/saved_objects/migrations/run_resilient_migrator.ts +++ b/src/core/server/saved_objects/migrations/run_resilient_migrator.ts @@ -9,8 +9,8 @@ import type { Logger } from '@kbn/logging'; import type { DocLinksServiceStart } from '@kbn/core-doc-links-server'; import type { ElasticsearchClient } from '@kbn/core-elasticsearch-server'; +import type { SavedObjectsMigrationVersion } from '@kbn/core-saved-objects-common'; import { IndexMapping } from '../mappings'; -import type { SavedObjectsMigrationVersion } from '../types'; import type { TransformRawDocs } from './types'; import { MigrationResult } from './core'; import { next } from './next'; @@ -20,6 +20,20 @@ import { migrationStateActionMachine } from './migrations_state_action_machine'; import { SavedObjectsMigrationConfigType } from '../saved_objects_config'; import type { ISavedObjectTypeRegistry } from '../saved_objects_type_registry'; +/** + * To avoid the Elasticsearch-js client aborting our requests before we + * receive a response from Elasticsearch we choose a requestTimeout that's + * longer than the DEFAULT_TIMEOUT. + * + * This timeout is only really valuable for preventing migrations from being + * stuck waiting forever for a response when the underlying socket is broken. + * + * We also set maxRetries to 0 so that the state action machine can handle all + * retries. This way we get exponential back-off and logging for failed + * actions. + */ +export const MIGRATION_CLIENT_OPTIONS = { maxRetries: 0, requestTimeout: 120_000 }; + /** * Migrates the provided indexPrefix index using a resilient algorithm that is * completely lock-free so that any failure can always be retried by @@ -61,11 +75,12 @@ export async function runResilientMigrator({ docLinks, logger, }); + const migrationClient = client.child(MIGRATION_CLIENT_OPTIONS); return migrationStateActionMachine({ initialState, logger, - next: next(client, transformRawDocs), + next: next(migrationClient, transformRawDocs), model, - client, + client: migrationClient, }); } diff --git a/src/core/server/saved_objects/migrations/state.ts b/src/core/server/saved_objects/migrations/state.ts index 02da8495c0d8a..c6f3273a18d47 100644 --- a/src/core/server/saved_objects/migrations/state.ts +++ b/src/core/server/saved_objects/migrations/state.ts @@ -182,7 +182,7 @@ export interface FatalState extends BaseState { } export interface WaitForYellowSourceState extends BaseState { - /** Wait for the source index to be yellow before requesting it. */ + /** Wait for the source index to be yellow before reading from it. */ readonly controlState: 'WAIT_FOR_YELLOW_SOURCE'; readonly sourceIndex: Option.Some; readonly sourceIndexMappings: IndexMapping; diff --git a/src/core/server/saved_objects/routes/legacy_import_export/lib/collect_references_deep.test.ts b/src/core/server/saved_objects/routes/legacy_import_export/lib/collect_references_deep.test.ts index 1c85ceedf90e6..257fa594d2bc7 100644 --- a/src/core/server/saved_objects/routes/legacy_import_export/lib/collect_references_deep.test.ts +++ b/src/core/server/saved_objects/routes/legacy_import_export/lib/collect_references_deep.test.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { SavedObject, SavedObjectAttributes } from '../../../..'; +import type { SavedObject, SavedObjectAttributes } from '@kbn/core-saved-objects-common'; import { savedObjectsClientMock } from '../../../../mocks'; import { collectReferencesDeep } from './collect_references_deep'; diff --git a/src/core/server/saved_objects/routes/update.ts b/src/core/server/saved_objects/routes/update.ts index 3d68c6a698a04..0d9e4b9cdcf46 100644 --- a/src/core/server/saved_objects/routes/update.ts +++ b/src/core/server/saved_objects/routes/update.ts @@ -7,8 +7,8 @@ */ import { schema } from '@kbn/config-schema'; +import type { SavedObjectsUpdateOptions } from '@kbn/core-saved-objects-api-server'; import { InternalCoreUsageDataSetup } from '../../core_usage_data'; -import type { SavedObjectsUpdateOptions } from '../service/saved_objects_client'; import type { InternalSavedObjectRouter } from '../internal_types'; import { catchAndReturnBoomErrors } from './utils'; diff --git a/src/core/server/saved_objects/saved_objects_service.ts b/src/core/server/saved_objects/saved_objects_service.ts index 123550393f49b..044c588ac70ee 100644 --- a/src/core/server/saved_objects/saved_objects_service.ts +++ b/src/core/server/saved_objects/saved_objects_service.ts @@ -18,6 +18,11 @@ import type { InternalElasticsearchServiceSetup, InternalElasticsearchServiceStart, } from '@kbn/core-elasticsearch-server-internal'; +import type { SavedObjectAttributes } from '@kbn/core-saved-objects-common'; +import type { + ISavedObjectsRepository, + SavedObjectsClientContract, +} from '@kbn/core-saved-objects-api-server'; import { SavedObjectsClient, SavedObjectsClientProvider, @@ -31,13 +36,8 @@ import { SavedObjectsMigrationConfigType, SavedObjectConfig, } from './saved_objects_config'; -import { - SavedObjectsClientContract, - SavedObjectsType, - SavedObjectStatusMeta, - SavedObjectAttributes, -} from './types'; -import { ISavedObjectsRepository, SavedObjectsRepository } from './service/lib/repository'; +import { SavedObjectsType, SavedObjectStatusMeta } from './types'; +import { SavedObjectsRepository } from './service/lib/repository'; import { SavedObjectsClientFactoryProvider, SavedObjectsClientWrapperFactory, diff --git a/src/core/server/saved_objects/serialization/types.ts b/src/core/server/saved_objects/serialization/types.ts index 3956e2133e5a8..4c6fa73065cf7 100644 --- a/src/core/server/saved_objects/serialization/types.ts +++ b/src/core/server/saved_objects/serialization/types.ts @@ -6,7 +6,10 @@ * Side Public License, v 1. */ -import { SavedObjectsMigrationVersion, SavedObjectReference } from '../types'; +import type { + SavedObjectsMigrationVersion, + SavedObjectReference, +} from '@kbn/core-saved-objects-common'; /** * A raw document as represented directly in the saved object index. diff --git a/src/core/server/saved_objects/service/index.ts b/src/core/server/saved_objects/service/index.ts index 7b4ffcf2dd6cf..f52efbad6bf05 100644 --- a/src/core/server/saved_objects/service/index.ts +++ b/src/core/server/saved_objects/service/index.ts @@ -8,23 +8,11 @@ export { SavedObjectsErrorHelpers, SavedObjectsClientProvider, SavedObjectsUtils } from './lib'; export type { SavedObjectsRepository, - ISavedObjectsPointInTimeFinder, - SavedObjectsCreatePointInTimeFinderOptions, - SavedObjectsCreatePointInTimeFinderDependencies, ISavedObjectsClientProvider, SavedObjectsClientProviderOptions, SavedObjectsClientWrapperFactory, SavedObjectsClientWrapperOptions, SavedObjectsClientFactory, SavedObjectsClientFactoryProvider, - SavedObjectsCollectMultiNamespaceReferencesObject, - SavedObjectsCollectMultiNamespaceReferencesOptions, - SavedObjectReferenceWithContext, - SavedObjectsCollectMultiNamespaceReferencesResponse, - SavedObjectsUpdateObjectsSpacesObject, - SavedObjectsUpdateObjectsSpacesOptions, - SavedObjectsUpdateObjectsSpacesResponse, - SavedObjectsUpdateObjectsSpacesResponseObject, } from './lib'; - -export * from './saved_objects_client'; +export { SavedObjectsClient } from './saved_objects_client'; diff --git a/src/core/server/saved_objects/service/lib/aggregations/aggs_types/bucket_aggs.ts b/src/core/server/saved_objects/service/lib/aggregations/aggs_types/bucket_aggs.ts index 069f116a2ee45..7c14da7e4b421 100644 --- a/src/core/server/saved_objects/service/lib/aggregations/aggs_types/bucket_aggs.ts +++ b/src/core/server/saved_objects/service/lib/aggregations/aggs_types/bucket_aggs.ts @@ -54,6 +54,13 @@ const termSchema = s.object({ term: s.recordOf(s.string(), s.oneOf([s.string(), s.boolean(), s.number()])), }); +const existsSchema = s.object({ + exists: s.maybe( + s.object({ + field: s.string(), + }) + ), +}); // TODO: it would be great if we could recursively build the schema since the aggregation have be nested // For more details see how the types are defined in the elasticsearch javascript client: // https://github.com/elastic/elasticsearch-js/blob/4ad5daeaf401ce8ebb28b940075e0a67e56ff9ce/src/api/typesWithBodyKey.ts#L5295 @@ -134,7 +141,7 @@ export const bucketAggsSchemas: Record = { format: s.string(), ranges: s.arrayOf(s.object({ from: s.maybe(s.string()), to: s.maybe(s.string()) })), }), - filter: termSchema, + filter: s.oneOf([termSchema, existsSchema]) as unknown as ObjectType, filters: s.object({ filters: s.recordOf(s.string(), s.oneOf([termSchema, boolSchema])), }), diff --git a/src/core/server/saved_objects/service/lib/collect_multi_namespace_references.test.ts b/src/core/server/saved_objects/service/lib/collect_multi_namespace_references.test.ts index cc219579d9c0b..d3cf76716e598 100644 --- a/src/core/server/saved_objects/service/lib/collect_multi_namespace_references.test.ts +++ b/src/core/server/saved_objects/service/lib/collect_multi_namespace_references.test.ts @@ -13,13 +13,15 @@ import { } from './collect_multi_namespace_references.test.mock'; import { elasticsearchClientMock } from '@kbn/core-elasticsearch-client-server-mocks'; +import type { + SavedObjectsCollectMultiNamespaceReferencesObject, + SavedObjectsCollectMultiNamespaceReferencesOptions, +} from '@kbn/core-saved-objects-api-server'; import { typeRegistryMock } from '../../saved_objects_type_registry.mock'; import { SavedObjectsSerializer } from '../../serialization'; import { ALIAS_OR_SHARED_ORIGIN_SEARCH_PER_PAGE, CollectMultiNamespaceReferencesParams, - SavedObjectsCollectMultiNamespaceReferencesObject, - SavedObjectsCollectMultiNamespaceReferencesOptions, } from './collect_multi_namespace_references'; import { collectMultiNamespaceReferences } from './collect_multi_namespace_references'; import type { CreatePointInTimeFinderFn } from './point_in_time_finder'; diff --git a/src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts b/src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts index fb6bd89f358f6..177b8691e803a 100644 --- a/src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts +++ b/src/core/server/saved_objects/service/lib/collect_multi_namespace_references.ts @@ -7,9 +7,15 @@ */ import { isNotFoundFromUnsupportedServer } from '@kbn/core-elasticsearch-server-internal'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; +import type { + SavedObjectsCollectMultiNamespaceReferencesObject, + SavedObjectsCollectMultiNamespaceReferencesOptions, + SavedObjectsCollectMultiNamespaceReferencesResponse, + SavedObjectReferenceWithContext, +} from '@kbn/core-saved-objects-api-server'; import type { ISavedObjectTypeRegistry } from '../../saved_objects_type_registry'; import type { SavedObjectsSerializer } from '../../serialization'; -import type { SavedObject, SavedObjectsBaseOptions } from '../../types'; import { SavedObjectsErrorHelpers } from './errors'; import { findLegacyUrlAliases } from './legacy_url_aliases'; import { getRootFields } from './included_fields'; @@ -37,74 +43,6 @@ const MAX_REFERENCE_GRAPH_DEPTH = 20; */ export const ALIAS_OR_SHARED_ORIGIN_SEARCH_PER_PAGE = 100; -/** - * An object to collect references for. It must be a multi-namespace type (in other words, the object type must be registered with the - * `namespaceType: 'multiple'` or `namespaceType: 'multiple-isolated'` option). - * - * Note: if options.purpose is 'updateObjectsSpaces', it must be a shareable type (in other words, the object type must be registered with - * the `namespaceType: 'multiple'`). - * - * @public - */ -export interface SavedObjectsCollectMultiNamespaceReferencesObject { - id: string; - type: string; -} - -/** - * Options for collecting references. - * - * @public - */ -export interface SavedObjectsCollectMultiNamespaceReferencesOptions - extends SavedObjectsBaseOptions { - /** Optional purpose used to determine filtering and authorization checks; default is 'collectMultiNamespaceReferences' */ - purpose?: 'collectMultiNamespaceReferences' | 'updateObjectsSpaces'; -} - -/** - * A returned input object or one of its references, with additional context. - * - * @public - */ -export interface SavedObjectReferenceWithContext { - /** The type of the referenced object */ - type: string; - /** The ID of the referenced object */ - id: string; - /** The origin ID of the referenced object (if it has one) */ - originId?: string; - /** The space(s) that the referenced object exists in */ - spaces: string[]; - /** - * References to this object; note that this does not contain _all inbound references everywhere for this object_, it only contains - * inbound references for the scope of this operation - */ - inboundReferences: Array<{ - /** The type of the object that has the inbound reference */ - type: string; - /** The ID of the object that has the inbound reference */ - id: string; - /** The name of the inbound reference */ - name: string; - }>; - /** Whether or not this object or reference is missing */ - isMissing?: boolean; - /** The space(s) that legacy URL aliases matching this type/id exist in */ - spacesWithMatchingAliases?: string[]; - /** The space(s) that objects matching this origin exist in (including this one) */ - spacesWithMatchingOrigins?: string[]; -} - -/** - * The response when object references are collected. - * - * @public - */ -export interface SavedObjectsCollectMultiNamespaceReferencesResponse { - objects: SavedObjectReferenceWithContext[]; -} - /** * Parameters for the collectMultiNamespaceReferences function. * diff --git a/src/core/server/saved_objects/service/lib/filter_utils.test.ts b/src/core/server/saved_objects/service/lib/filter_utils.test.ts index 92eb0d041cc27..7bad553b88517 100644 --- a/src/core/server/saved_objects/service/lib/filter_utils.test.ts +++ b/src/core/server/saved_objects/service/lib/filter_utils.test.ts @@ -103,19 +103,14 @@ describe('Filter Utils', () => { expect( validateConvertFilterToKueryNode( ['foo'], - esKuery.nodeTypes.function.buildNode('is', `foo.attributes.title`, 'best', true), + esKuery.nodeTypes.function.buildNode('is', `foo.attributes.title`, '"best"'), mockMappings ) ).toEqual(esKuery.fromKueryExpression('foo.title: "best"')); }); test('does not mutate the input KueryNode', () => { - const input = esKuery.nodeTypes.function.buildNode( - 'is', - `foo.attributes.title`, - 'best', - true - ); + const input = esKuery.nodeTypes.function.buildNode('is', `foo.attributes.title`, '"best"'); const inputCopy = cloneDeep(input); diff --git a/src/core/server/saved_objects/service/lib/find_shared_origin_objects.test.ts b/src/core/server/saved_objects/service/lib/find_shared_origin_objects.test.ts index ed6ecf7b33d61..36501b00294f8 100644 --- a/src/core/server/saved_objects/service/lib/find_shared_origin_objects.test.ts +++ b/src/core/server/saved_objects/service/lib/find_shared_origin_objects.test.ts @@ -8,9 +8,9 @@ import type { DeeplyMockedKeys } from '@kbn/utility-types-jest'; +import type { ISavedObjectsRepository } from '@kbn/core-saved-objects-api-server'; import type { CreatePointInTimeFinderFn, PointInTimeFinder } from './point_in_time_finder'; import { savedObjectsPointInTimeFinderMock } from './point_in_time_finder.mock'; -import type { ISavedObjectsRepository } from './repository'; import { savedObjectsRepositoryMock } from './repository.mock'; import { findSharedOriginObjects } from './find_shared_origin_objects'; @@ -86,14 +86,14 @@ describe('findSharedOriginObjects', () => { [obj1, obj2, obj3].forEach(({ type, origin }, i) => { expect(kueryFilterArgs[i * 2].arguments).toEqual( expect.arrayContaining([ - { type: 'literal', value: `${type}.id` }, - { type: 'literal', value: `${type}:${origin}` }, + { type: 'literal', value: `${type}.id`, isQuoted: false }, + { type: 'literal', value: `${type}:${origin}`, isQuoted: false }, ]) ); expect(kueryFilterArgs[i * 2 + 1].arguments).toEqual( expect.arrayContaining([ - { type: 'literal', value: `${type}.originId` }, - { type: 'literal', value: origin }, + { type: 'literal', value: `${type}.originId`, isQuoted: false }, + { type: 'literal', value: origin, isQuoted: false }, ]) ); }); diff --git a/src/core/server/saved_objects/service/lib/index.ts b/src/core/server/saved_objects/service/lib/index.ts index ec283f3d3741e..aa88b33a5fa5c 100644 --- a/src/core/server/saved_objects/service/lib/index.ts +++ b/src/core/server/saved_objects/service/lib/index.ts @@ -6,15 +6,9 @@ * Side Public License, v 1. */ -export type { ISavedObjectsRepository, SavedObjectsRepository } from './repository'; +export type { SavedObjectsRepository } from './repository'; export { SavedObjectsClientProvider } from './scoped_client_provider'; -export type { - ISavedObjectsPointInTimeFinder, - SavedObjectsCreatePointInTimeFinderOptions, - SavedObjectsCreatePointInTimeFinderDependencies, -} from './point_in_time_finder'; - export type { SavedObjectsClientWrapperFactory, SavedObjectsClientWrapperOptions, @@ -28,18 +22,4 @@ export { SavedObjectsErrorHelpers } from './errors'; export { SavedObjectsUtils } from './utils'; -export type { - SavedObjectsCollectMultiNamespaceReferencesObject, - SavedObjectsCollectMultiNamespaceReferencesOptions, - SavedObjectReferenceWithContext, - SavedObjectsCollectMultiNamespaceReferencesResponse, -} from './collect_multi_namespace_references'; - -export type { - SavedObjectsUpdateObjectsSpacesObject, - SavedObjectsUpdateObjectsSpacesOptions, - SavedObjectsUpdateObjectsSpacesResponse, - SavedObjectsUpdateObjectsSpacesResponseObject, -} from './update_objects_spaces'; - export { getIndexForType } from './get_index_for_type'; diff --git a/src/core/server/saved_objects/service/lib/internal_bulk_resolve.test.ts b/src/core/server/saved_objects/service/lib/internal_bulk_resolve.test.ts index 44940cd0ae0d7..ec55ea7725718 100644 --- a/src/core/server/saved_objects/service/lib/internal_bulk_resolve.test.ts +++ b/src/core/server/saved_objects/service/lib/internal_bulk_resolve.test.ts @@ -13,12 +13,15 @@ import { } from './internal_bulk_resolve.test.mock'; import { elasticsearchClientMock } from '@kbn/core-elasticsearch-client-server-mocks'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; +import type { + SavedObjectsBulkResolveObject, + SavedObjectsBaseOptions, +} from '@kbn/core-saved-objects-api-server'; import { LEGACY_URL_ALIAS_TYPE } from '../../object_types'; import { typeRegistryMock } from '../../saved_objects_type_registry.mock'; import { SavedObjectsSerializer } from '../../serialization'; import { SavedObjectsErrorHelpers } from './errors'; -import { SavedObjectsBulkResolveObject } from '../saved_objects_client'; -import { SavedObject, SavedObjectsBaseOptions } from '../../types'; import { internalBulkResolve, InternalBulkResolveParams } from './internal_bulk_resolve'; import { SavedObjectsUtils } from './utils'; import { normalizeNamespace } from './internal_utils'; diff --git a/src/core/server/saved_objects/service/lib/internal_bulk_resolve.ts b/src/core/server/saved_objects/service/lib/internal_bulk_resolve.ts index 96ea29486520b..5f66251640232 100644 --- a/src/core/server/saved_objects/service/lib/internal_bulk_resolve.ts +++ b/src/core/server/saved_objects/service/lib/internal_bulk_resolve.ts @@ -9,6 +9,14 @@ import type { MgetResponseItem } from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { isNotFoundFromUnsupportedServer } from '@kbn/core-elasticsearch-server-internal'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; +import type { + SavedObjectsBaseOptions, + SavedObjectsBulkResolveObject, + SavedObjectsResolveResponse, + SavedObjectsIncrementCounterField, + SavedObjectsIncrementCounterOptions, +} from '@kbn/core-saved-objects-api-server'; import { CORE_USAGE_STATS_ID, CORE_USAGE_STATS_TYPE, @@ -17,11 +25,6 @@ import { import { LegacyUrlAlias, LEGACY_URL_ALIAS_TYPE } from '../../object_types'; import type { ISavedObjectTypeRegistry } from '../../saved_objects_type_registry'; import type { SavedObjectsRawDocSource, SavedObjectsSerializer } from '../../serialization'; -import type { SavedObject, SavedObjectsBaseOptions } from '../../types'; -import type { - SavedObjectsBulkResolveObject, - SavedObjectsResolveResponse, -} from '../saved_objects_client'; import { DecoratedError, SavedObjectsErrorHelpers } from './errors'; import { getCurrentTime, @@ -33,10 +36,6 @@ import { isLeft, isRight, } from './internal_utils'; -import { - SavedObjectsIncrementCounterField, - SavedObjectsIncrementCounterOptions, -} from './repository'; import type { RepositoryEsClient } from './repository_es_client'; /** diff --git a/src/core/server/saved_objects/service/lib/internal_utils.ts b/src/core/server/saved_objects/service/lib/internal_utils.ts index abedcf53c781f..815290de79ba4 100644 --- a/src/core/server/saved_objects/service/lib/internal_utils.ts +++ b/src/core/server/saved_objects/service/lib/internal_utils.ts @@ -7,9 +7,9 @@ */ import type { Payload } from '@hapi/boom'; +import type { SavedObject } from '@kbn/core-saved-objects-common'; import type { ISavedObjectTypeRegistry } from '../../saved_objects_type_registry'; import type { SavedObjectsRawDoc, SavedObjectsRawDocSource } from '../../serialization'; -import type { SavedObject } from '../../types'; import { decodeRequestVersion, encodeHitVersion } from '../../version'; import { SavedObjectsErrorHelpers } from './errors'; import { ALL_NAMESPACES_STRING, SavedObjectsUtils } from './utils'; diff --git a/src/core/server/saved_objects/service/lib/legacy_url_aliases/find_legacy_url_aliases.test.ts b/src/core/server/saved_objects/service/lib/legacy_url_aliases/find_legacy_url_aliases.test.ts index f171b0651ffb4..8200c7502fec6 100644 --- a/src/core/server/saved_objects/service/lib/legacy_url_aliases/find_legacy_url_aliases.test.ts +++ b/src/core/server/saved_objects/service/lib/legacy_url_aliases/find_legacy_url_aliases.test.ts @@ -8,10 +8,10 @@ import type { DeeplyMockedKeys } from '@kbn/utility-types-jest'; +import type { ISavedObjectsRepository } from '@kbn/core-saved-objects-api-server'; import { LegacyUrlAlias, LEGACY_URL_ALIAS_TYPE } from '../../../object_types'; import type { CreatePointInTimeFinderFn, PointInTimeFinder } from '../point_in_time_finder'; import { savedObjectsPointInTimeFinderMock } from '../point_in_time_finder.mock'; -import type { ISavedObjectsRepository } from '../repository'; import { savedObjectsRepositoryMock } from '../repository.mock'; import { findLegacyUrlAliases } from './find_legacy_url_aliases'; @@ -82,10 +82,10 @@ describe('findLegacyUrlAliases', () => { const typeAndIdFilter = typeAndIdFilters[i].arguments; expect(typeAndIdFilter).toEqual([ expect.objectContaining({ - arguments: expect.arrayContaining([{ type: 'literal', value: type }]), + arguments: expect.arrayContaining([{ type: 'literal', value: type, isQuoted: false }]), }), expect.objectContaining({ - arguments: expect.arrayContaining([{ type: 'literal', value: id }]), + arguments: expect.arrayContaining([{ type: 'literal', value: id, isQuoted: false }]), }), ]); }); diff --git a/src/core/server/saved_objects/service/lib/point_in_time_finder.mock.ts b/src/core/server/saved_objects/service/lib/point_in_time_finder.mock.ts index c5ea141486c76..371c45e90c71c 100644 --- a/src/core/server/saved_objects/service/lib/point_in_time_finder.mock.ts +++ b/src/core/server/saved_objects/service/lib/point_in_time_finder.mock.ts @@ -7,8 +7,10 @@ */ import { loggerMock, MockedLogger } from '@kbn/logging-mocks'; -import type { SavedObjectsClientContract } from '../../types'; -import type { ISavedObjectsRepository } from './repository'; +import type { + SavedObjectsClientContract, + ISavedObjectsRepository, +} from '@kbn/core-saved-objects-api-server'; import { PointInTimeFinder } from './point_in_time_finder'; const createPointInTimeFinderMock = ({ diff --git a/src/core/server/saved_objects/service/lib/point_in_time_finder.test.ts b/src/core/server/saved_objects/service/lib/point_in_time_finder.test.ts index f9d5098b5d896..29fe08e48b16d 100644 --- a/src/core/server/saved_objects/service/lib/point_in_time_finder.test.ts +++ b/src/core/server/saved_objects/service/lib/point_in_time_finder.test.ts @@ -7,13 +7,13 @@ */ import { loggerMock, MockedLogger } from '@kbn/logging-mocks'; -import type { SavedObjectsFindResult } from '..'; +import type { + SavedObjectsFindResult, + SavedObjectsCreatePointInTimeFinderOptions, +} from '@kbn/core-saved-objects-api-server'; import { savedObjectsRepositoryMock } from './repository.mock'; -import { - PointInTimeFinder, - SavedObjectsCreatePointInTimeFinderOptions, -} from './point_in_time_finder'; +import { PointInTimeFinder } from './point_in_time_finder'; const mockHits = [ { diff --git a/src/core/server/saved_objects/service/lib/point_in_time_finder.ts b/src/core/server/saved_objects/service/lib/point_in_time_finder.ts index b00bfde8d08aa..03249c3e2799a 100644 --- a/src/core/server/saved_objects/service/lib/point_in_time_finder.ts +++ b/src/core/server/saved_objects/service/lib/point_in_time_finder.ts @@ -7,29 +7,20 @@ */ import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import type { Logger } from '@kbn/logging'; -import type { SavedObjectsFindOptions, SavedObjectsClientContract } from '../../types'; -import type { SavedObjectsFindResponse } from '..'; +import type { + SavedObjectsFindOptions, + SavedObjectsFindResponse, + SavedObjectsClientContract, + SavedObjectsCreatePointInTimeFinderDependencies, + SavedObjectsCreatePointInTimeFinderOptions, + ISavedObjectsPointInTimeFinder, +} from '@kbn/core-saved-objects-api-server'; type PointInTimeFinderClient = Pick< SavedObjectsClientContract, 'find' | 'openPointInTimeForType' | 'closePointInTime' >; -/** - * @public - */ -export type SavedObjectsCreatePointInTimeFinderOptions = Omit< - SavedObjectsFindOptions, - 'page' | 'pit' | 'searchAfter' ->; - -/** - * @public - */ -export interface SavedObjectsCreatePointInTimeFinderDependencies { - client: Pick; -} - /** * @internal */ @@ -45,28 +36,6 @@ export type CreatePointInTimeFinderFn = ( findOptions: SavedObjectsCreatePointInTimeFinderOptions ) => ISavedObjectsPointInTimeFinder; -/** @public */ -export interface ISavedObjectsPointInTimeFinder { - /** - * An async generator which wraps calls to `savedObjectsClient.find` and - * iterates over multiple pages of results using `_pit` and `search_after`. - * This will open a new Point-In-Time (PIT), and continue paging until a set - * of results is received that's smaller than the designated `perPage` size. - */ - find: () => AsyncGenerator>; - /** - * Closes the Point-In-Time associated with this finder instance. - * - * Once you have retrieved all of the results you need, it is recommended - * to call `close()` to clean up the PIT and prevent Elasticsearch from - * consuming resources unnecessarily. This is only required if you are - * done iterating and have not yet paged through all of the results: the - * PIT will automatically be closed for you once you reach the last page - * of results, or if the underlying call to `find` fails for any reason. - */ - close: () => Promise; -} - /** * @internal */ diff --git a/src/core/server/saved_objects/service/lib/repository.mock.ts b/src/core/server/saved_objects/service/lib/repository.mock.ts index 9c9b71d42e45e..d950b041d2432 100644 --- a/src/core/server/saved_objects/service/lib/repository.mock.ts +++ b/src/core/server/saved_objects/service/lib/repository.mock.ts @@ -7,7 +7,7 @@ */ import { savedObjectsPointInTimeFinderMock } from './point_in_time_finder.mock'; -import { ISavedObjectsRepository } from './repository'; +import type { ISavedObjectsRepository } from '@kbn/core-saved-objects-api-server'; const create = () => { const mock: jest.Mocked = { diff --git a/src/core/server/saved_objects/service/lib/repository.test.ts b/src/core/server/saved_objects/service/lib/repository.test.ts index c916953df2ad5..420a5b4c8d8fe 100644 --- a/src/core/server/saved_objects/service/lib/repository.test.ts +++ b/src/core/server/saved_objects/service/lib/repository.test.ts @@ -23,26 +23,34 @@ import { import type { Payload } from '@hapi/boom'; import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import { schema } from '@kbn/config-schema'; -import { - SavedObjectsType, - SavedObject, - SavedObjectReference, +import type { SavedObject, SavedObjectReference } from '@kbn/core-saved-objects-common'; +import type { SavedObjectsBaseOptions, SavedObjectsFindOptions, -} from '../../types'; -import type { SavedObjectsUpdateObjectsSpacesResponse } from './update_objects_spaces'; -import { + SavedObjectsUpdateObjectsSpacesResponse, SavedObjectsDeleteByNamespaceOptions, SavedObjectsIncrementCounterField, SavedObjectsIncrementCounterOptions, - SavedObjectsRepository, -} from './repository'; -import { SavedObjectsErrorHelpers } from './errors'; -import { - PointInTimeFinder, SavedObjectsCreatePointInTimeFinderDependencies, SavedObjectsCreatePointInTimeFinderOptions, -} from './point_in_time_finder'; + SavedObjectsBulkCreateObject, + SavedObjectsBulkGetObject, + SavedObjectsBulkUpdateObject, + SavedObjectsBulkUpdateOptions, + SavedObjectsCreateOptions, + SavedObjectsDeleteOptions, + SavedObjectsOpenPointInTimeOptions, + SavedObjectsResolveResponse, + SavedObjectsUpdateOptions, + SavedObjectsCollectMultiNamespaceReferencesObject, + SavedObjectsCollectMultiNamespaceReferencesResponse, + SavedObjectsUpdateObjectsSpacesObject, + SavedObjectsUpdateObjectsSpacesOptions, +} from '@kbn/core-saved-objects-api-server'; +import { SavedObjectsType } from '../../types'; +import { SavedObjectsRepository } from './repository'; +import { SavedObjectsErrorHelpers } from './errors'; +import { PointInTimeFinder } from './point_in_time_finder'; import { ALL_NAMESPACES_STRING } from './utils'; import { loggerMock } from '@kbn/logging-mocks'; import { @@ -59,24 +67,7 @@ import { LEGACY_URL_ALIAS_TYPE } from '../../object_types'; import { elasticsearchClientMock } from '@kbn/core-elasticsearch-client-server-mocks'; import * as esKuery from '@kbn/es-query'; import { errors as EsErrors } from '@elastic/elasticsearch'; -import { - SavedObjectsBulkCreateObject, - SavedObjectsBulkGetObject, - SavedObjectsBulkUpdateObject, - SavedObjectsBulkUpdateOptions, - SavedObjectsCreateOptions, - SavedObjectsDeleteOptions, - SavedObjectsOpenPointInTimeOptions, - SavedObjectsResolveResponse, - SavedObjectsUpdateOptions, -} from '../saved_objects_client'; import { SavedObjectsMappingProperties, SavedObjectsTypeMappingDefinition } from '../../mappings'; -import { - SavedObjectsCollectMultiNamespaceReferencesObject, - SavedObjectsCollectMultiNamespaceReferencesResponse, - SavedObjectsUpdateObjectsSpacesObject, - SavedObjectsUpdateObjectsSpacesOptions, -} from '../../..'; import { InternalBulkResolveError } from './internal_bulk_resolve'; const { nodeTypes } = esKuery; @@ -3773,6 +3764,7 @@ describe('SavedObjectsRepository', () => { Object { "arguments": Array [ Object { + "isQuoted": false, "type": "literal", "value": "dashboard.otherField", }, @@ -3780,10 +3772,6 @@ describe('SavedObjectsRepository', () => { "type": "wildcard", "value": "@kuery-wildcard@", }, - Object { - "type": "literal", - "value": false, - }, ], "function": "is", "type": "function", @@ -3813,6 +3801,7 @@ describe('SavedObjectsRepository', () => { Object { "arguments": Array [ Object { + "isQuoted": false, "type": "literal", "value": "dashboard.otherField", }, @@ -3820,10 +3809,6 @@ describe('SavedObjectsRepository', () => { "type": "wildcard", "value": "@kuery-wildcard@", }, - Object { - "type": "literal", - "value": false, - }, ], "function": "is", "type": "function", diff --git a/src/core/server/saved_objects/service/lib/repository.ts b/src/core/server/saved_objects/service/lib/repository.ts index 6688b8ce18485..cce2caa61c4af 100644 --- a/src/core/server/saved_objects/service/lib/repository.ts +++ b/src/core/server/saved_objects/service/lib/repository.ts @@ -15,13 +15,47 @@ import { isSupportedEsServer, isNotFoundFromUnsupportedServer, } from '@kbn/core-elasticsearch-server-internal'; -import { getRootPropertiesObjects, IndexMapping } from '../../mappings'; -import { +import type { SavedObject } from '@kbn/core-saved-objects-common'; +import type { + ISavedObjectsRepository, + SavedObjectsBaseOptions, + SavedObjectsIncrementCounterOptions, + SavedObjectsDeleteByNamespaceOptions, + SavedObjectsBulkResponse, + SavedObjectsUpdateResponse, + SavedObjectsBulkGetObject, + SavedObjectsBulkResolveObject, + SavedObjectsIncrementCounterField, + SavedObjectsBulkCreateObject, + SavedObjectsBulkResolveResponse, + SavedObjectsCreateOptions, + SavedObjectsFindResponse, + SavedObjectsBulkUpdateResponse, + SavedObjectsUpdateObjectsSpacesOptions, + SavedObjectsCollectMultiNamespaceReferencesOptions, + SavedObjectsRemoveReferencesToResponse, + SavedObjectsCheckConflictsObject, + SavedObjectsCheckConflictsResponse, + SavedObjectsBulkUpdateOptions, + SavedObjectsFindResult, + SavedObjectsRemoveReferencesToOptions, + SavedObjectsDeleteOptions, + SavedObjectsOpenPointInTimeResponse, + SavedObjectsBulkUpdateObject, + SavedObjectsClosePointInTimeResponse, ISavedObjectsPointInTimeFinder, - PointInTimeFinder, - SavedObjectsCreatePointInTimeFinderOptions, SavedObjectsCreatePointInTimeFinderDependencies, -} from './point_in_time_finder'; + SavedObjectsResolveResponse, + SavedObjectsCollectMultiNamespaceReferencesObject, + SavedObjectsUpdateObjectsSpacesObject, + SavedObjectsUpdateOptions, + SavedObjectsOpenPointInTimeOptions, + SavedObjectsClosePointInTimeOptions, + SavedObjectsCreatePointInTimeFinderOptions, + SavedObjectsFindOptions, +} from '@kbn/core-saved-objects-api-server'; +import { getRootPropertiesObjects, IndexMapping } from '../../mappings'; +import { PointInTimeFinder } from './point_in_time_finder'; import { createRepositoryEsClient, RepositoryEsClient } from './repository_es_client'; import { getSearchDsl } from './search_dsl'; import { includedFields } from './included_fields'; @@ -34,39 +68,7 @@ import { SavedObjectsRawDoc, SavedObjectsRawDocSource, } from '../../serialization'; -import { - SavedObjectsBulkCreateObject, - SavedObjectsBulkGetObject, - SavedObjectsBulkResponse, - SavedObjectsBulkUpdateResponse, - SavedObjectsCheckConflictsObject, - SavedObjectsCheckConflictsResponse, - SavedObjectsCreateOptions, - SavedObjectsFindResponse, - SavedObjectsFindResult, - SavedObjectsClosePointInTimeOptions, - SavedObjectsClosePointInTimeResponse, - SavedObjectsOpenPointInTimeOptions, - SavedObjectsOpenPointInTimeResponse, - SavedObjectsUpdateOptions, - SavedObjectsUpdateResponse, - SavedObjectsBulkUpdateObject, - SavedObjectsBulkUpdateOptions, - SavedObjectsDeleteOptions, - SavedObjectsRemoveReferencesToOptions, - SavedObjectsRemoveReferencesToResponse, - SavedObjectsResolveResponse, - SavedObjectsBulkResolveObject, - SavedObjectsBulkResolveResponse, -} from '../saved_objects_client'; import { LEGACY_URL_ALIAS_TYPE } from '../../object_types'; -import { - SavedObject, - SavedObjectsBaseOptions, - SavedObjectsFindOptions, - SavedObjectsMigrationVersion, - MutatingOperationRefreshSetting, -} from '../../types'; import { SavedObjectsTypeValidator } from '../../validation'; import { ISavedObjectTypeRegistry } from '../../saved_objects_type_registry'; import { internalBulkResolve, InternalBulkResolveError } from './internal_bulk_resolve'; @@ -90,16 +92,8 @@ import { FIND_DEFAULT_PER_PAGE, SavedObjectsUtils, } from './utils'; -import { - collectMultiNamespaceReferences, - SavedObjectsCollectMultiNamespaceReferencesObject, - SavedObjectsCollectMultiNamespaceReferencesOptions, -} from './collect_multi_namespace_references'; -import { - updateObjectsSpaces, - SavedObjectsUpdateObjectsSpacesObject, - SavedObjectsUpdateObjectsSpacesOptions, -} from './update_objects_spaces'; +import { collectMultiNamespaceReferences } from './collect_multi_namespace_references'; +import { updateObjectsSpaces } from './update_objects_spaces'; import { getIndexForType } from './get_index_for_type'; import { preflightCheckForCreate, @@ -121,58 +115,9 @@ export interface SavedObjectsRepositoryOptions { logger: Logger; } -/** - * @public - */ -export interface SavedObjectsIncrementCounterOptions - extends SavedObjectsBaseOptions { - /** - * (default=false) If true, sets all the counter fields to 0 if they don't - * already exist. Existing fields will be left as-is and won't be incremented. - */ - initialize?: boolean; - /** {@link SavedObjectsMigrationVersion} */ - migrationVersion?: SavedObjectsMigrationVersion; - /** - * (default='wait_for') The Elasticsearch refresh setting for this - * operation. See {@link MutatingOperationRefreshSetting} - */ - refresh?: MutatingOperationRefreshSetting; - /** - * Attributes to use when upserting the document if it doesn't exist. - */ - upsertAttributes?: Attributes; -} - -/** - * - * @public - */ -export interface SavedObjectsDeleteByNamespaceOptions extends SavedObjectsBaseOptions { - /** The Elasticsearch supports only boolean flag for this operation */ - refresh?: boolean; -} - export const DEFAULT_REFRESH_SETTING = 'wait_for'; export const DEFAULT_RETRY_COUNT = 3; -/** - * See {@link SavedObjectsRepository} - * - * @public - */ -export type ISavedObjectsRepository = Pick; - -/** - * @public - */ -export interface SavedObjectsIncrementCounterField { - /** The field name to increment the counter by.*/ - fieldName: string; - /** The number to increment the field by (defaults to 1).*/ - incrementBy?: number; -} - /** * @internal */ @@ -209,7 +154,7 @@ function isMgetDoc(doc?: estypes.MgetResponseItem): doc is estypes.GetG /** * @public */ -export class SavedObjectsRepository { +export class SavedObjectsRepository implements ISavedObjectsRepository { private _migrator: IKibanaMigrator; private _index: string; private _mappings: IndexMapping; @@ -295,17 +240,7 @@ export class SavedObjectsRepository { } /** - * Persists an object - * - * @param {string} type - * @param {object} attributes - * @param {object} [options={}] - * @property {string} [options.id] - force id on creation, not recommended - * @property {boolean} [options.overwrite=false] - * @property {object} [options.migrationVersion=undefined] - * @property {string} [options.namespace] - * @property {array} [options.references=[]] - [{ name, type, id }] - * @returns {promise} - { id, type, version, attributes } + * {@inheritDoc ISavedObjectsRepository.create} */ public async create( type: string, @@ -418,13 +353,7 @@ export class SavedObjectsRepository { } /** - * Creates multiple documents at once - * - * @param {array} objects - [{ type, id, attributes, references, migrationVersion }] - * @param {object} [options={}] - * @property {boolean} [options.overwrite=false] - overwrites existing documents - * @property {string} [options.namespace] - * @returns {promise} - {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]} + * {@inheritDoc ISavedObjectsRepository.bulkCreate} */ async bulkCreate( objects: Array>, @@ -640,8 +569,7 @@ export class SavedObjectsRepository { } /** - * Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are - * multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. + * {@inheritDoc ISavedObjectsRepository.checkConflicts} */ async checkConflicts( objects: SavedObjectsCheckConflictsObject[] = [], @@ -733,13 +661,7 @@ export class SavedObjectsRepository { } /** - * Deletes an object - * - * @param {string} type - * @param {string} id - * @param {object} [options={}] - * @property {string} [options.namespace] - * @returns {promise} + * {@inheritDoc ISavedObjectsRepository.delete} */ async delete(type: string, id: string, options: SavedObjectsDeleteOptions = {}): Promise<{}> { if (!this._allowedTypes.includes(type)) { @@ -832,10 +754,7 @@ export class SavedObjectsRepository { } /** - * Deletes all objects from the provided namespace. - * - * @param {string} namespace - * @returns {promise} - { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures } + * {@inheritDoc ISavedObjectsRepository.deleteByNamespace} */ async deleteByNamespace( namespace: string, @@ -895,23 +814,7 @@ export class SavedObjectsRepository { } /** - * @param {object} [options={}] - * @property {(string|Array)} [options.type] - * @property {string} [options.search] - * @property {string} [options.defaultSearchOperator] - * @property {Array} [options.searchFields] - see Elasticsearch Simple Query String - * Query field argument for more information - * @property {integer} [options.page=1] - * @property {integer} [options.perPage=20] - * @property {Array} [options.searchAfter] - * @property {string} [options.sortField] - * @property {string} [options.sortOrder] - * @property {Array} [options.fields] - * @property {string} [options.namespace] - * @property {object} [options.hasReference] - { type, id } - * @property {string} [options.pit] - * @property {string} [options.preference] - * @returns {promise} - { saved_objects: [{ id, type, version, attributes }], total, per_page, page } + * {@inheritDoc ISavedObjectsRepository.find} */ async find( options: SavedObjectsFindOptions @@ -1074,18 +977,7 @@ export class SavedObjectsRepository { } /** - * Returns an array of objects by id - * - * @param {array} objects - an array of objects containing id, type and optionally fields - * @param {object} [options={}] - * @property {string} [options.namespace] - * @returns {promise} - { saved_objects: [{ id, type, version, attributes }] } - * @example - * - * bulkGet([ - * { id: 'one', type: 'config' }, - * { id: 'foo', type: 'index-pattern' } - * ]) + * {@inheritDoc ISavedObjectsRepository.bulkGet} */ async bulkGet( objects: SavedObjectsBulkGetObject[] = [], @@ -1192,18 +1084,7 @@ export class SavedObjectsRepository { } /** - * Resolves an array of objects by id, using any legacy URL aliases if they exist - * - * @param {array} objects - an array of objects containing id, type - * @param {object} [options={}] - * @property {string} [options.namespace] - * @returns {promise} - { resolved_objects: [{ saved_object, outcome }] } - * @example - * - * bulkResolve([ - * { id: 'one', type: 'config' }, - * { id: 'foo', type: 'index-pattern' } - * ]) + * {@inheritDoc ISavedObjectsRepository.bulkResolve} */ async bulkResolve( objects: SavedObjectsBulkResolveObject[], @@ -1235,13 +1116,7 @@ export class SavedObjectsRepository { } /** - * Gets a single object - * - * @param {string} type - * @param {string} id - * @param {object} [options={}] - * @property {string} [options.namespace] - * @returns {promise} - { id, type, version, attributes } + * {@inheritDoc ISavedObjectsRepository.get} */ async get( type: string, @@ -1277,13 +1152,7 @@ export class SavedObjectsRepository { } /** - * Resolves a single object, using any legacy URL alias if it exists - * - * @param {string} type - * @param {string} id - * @param {object} [options={}] - * @property {string} [options.namespace] - * @returns {promise} - { saved_object, outcome } + * {@inheritDoc ISavedObjectsRepository.resolve} */ async resolve( type: string, @@ -1308,15 +1177,7 @@ export class SavedObjectsRepository { } /** - * Updates an object - * - * @param {string} type - * @param {string} id - * @param {object} [options={}] - * @property {string} options.version - ensures version matches that of persisted object - * @property {string} [options.namespace] - * @property {array} [options.references] - [{ name, type, id }] - * @returns {promise} + * {@inheritDoc ISavedObjectsRepository.update} */ async update( type: string, @@ -1440,10 +1301,7 @@ export class SavedObjectsRepository { } /** - * Gets all references and transitive references of the given objects. Ignores any object and/or reference that is not a multi-namespace - * type. - * - * @param objects The objects to get the references for. + * {@inheritDoc ISavedObjectsRepository.collectMultiNamespaceReferences} */ async collectMultiNamespaceReferences( objects: SavedObjectsCollectMultiNamespaceReferencesObject[], @@ -1462,12 +1320,7 @@ export class SavedObjectsRepository { } /** - * Updates one or more objects to add and/or remove them from specified spaces. - * - * @param objects - * @param spacesToAdd - * @param spacesToRemove - * @param options + * {@inheritDoc ISavedObjectsRepository.updateObjectsSpaces} */ async updateObjectsSpaces( objects: SavedObjectsUpdateObjectsSpacesObject[], @@ -1491,12 +1344,7 @@ export class SavedObjectsRepository { } /** - * Updates multiple objects in bulk - * - * @param {array} objects - [{ type, id, attributes, options: { version, namespace } references }] - * @property {string} options.version - ensures version matches that of persisted object - * @property {string} [options.namespace] - * @returns {promise} - {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]} + * {@inheritDoc ISavedObjectsRepository.bulkUpdate} */ async bulkUpdate( objects: Array>, @@ -1713,11 +1561,7 @@ export class SavedObjectsRepository { } /** - * Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. - * - * @remarks Will throw a conflict error if the `update_by_query` operation returns any failure. In that case - * some references might have been removed, and some were not. It is the caller's responsibility - * to handle and fix this situation if it was to happen. + * {@inheritDoc ISavedObjectsRepository.removeReferencesTo} */ async removeReferencesTo( type: string, @@ -1782,57 +1626,7 @@ export class SavedObjectsRepository { } /** - * Increments all the specified counter fields (by one by default). Creates the document - * if one doesn't exist for the given id. - * - * @remarks - * When supplying a field name like `stats.api.counter` the field name will - * be used as-is to create a document like: - * `{attributes: {'stats.api.counter': 1}}` - * It will not create a nested structure like: - * `{attributes: {stats: {api: {counter: 1}}}}` - * - * When using incrementCounter for collecting usage data, you need to ensure - * that usage collection happens on a best-effort basis and doesn't - * negatively affect your plugin or users. See https://github.com/elastic/kibana/blob/main/src/plugins/usage_collection/README.mdx#tracking-interactions-with-incrementcounter) - * - * @example - * ```ts - * const repository = coreStart.savedObjects.createInternalRepository(); - * - * // Initialize all fields to 0 - * repository - * .incrementCounter('dashboard_counter_type', 'counter_id', [ - * 'stats.apiCalls', - * 'stats.sampleDataInstalled', - * ], {initialize: true}); - * - * // Increment the apiCalls field counter - * repository - * .incrementCounter('dashboard_counter_type', 'counter_id', [ - * 'stats.apiCalls', - * ]) - * - * // Increment the apiCalls field counter by 4 - * repository - * .incrementCounter('dashboard_counter_type', 'counter_id', [ - * { fieldName: 'stats.apiCalls' incrementBy: 4 }, - * ]) - * - * // Initialize the document with arbitrary fields if not present - * repository.incrementCounter<{ appId: string }>( - * 'dashboard_counter_type', - * 'counter_id', - * [ 'stats.apiCalls'], - * { upsertAttributes: { appId: 'myId' } } - * ) - * ``` - * - * @param type - The type of saved object whose fields should be incremented - * @param id - The id of the document whose fields should be incremented - * @param counterFields - An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField} - * @param options - {@link SavedObjectsIncrementCounterOptions} - * @returns The saved object after the specified fields were incremented + * {@inheritDoc ISavedObjectsRepository.incrementCounter} */ async incrementCounter( type: string, @@ -2002,40 +1796,7 @@ export class SavedObjectsRepository { } /** - * Opens a Point In Time (PIT) against the indices for the specified Saved Object types. - * The returned `id` can then be passed to `SavedObjects.find` to search against that PIT. - * - * Only use this API if you have an advanced use case that's not solved by the - * {@link SavedObjectsRepository.createPointInTimeFinder} method. - * - * @example - * ```ts - * const { id } = await savedObjectsClient.openPointInTimeForType( - * type: 'visualization', - * { keepAlive: '5m' }, - * ); - * const page1 = await savedObjectsClient.find({ - * type: 'visualization', - * sortField: 'updated_at', - * sortOrder: 'asc', - * pit: { id, keepAlive: '2m' }, - * }); - * const lastHit = page1.saved_objects[page1.saved_objects.length - 1]; - * const page2 = await savedObjectsClient.find({ - * type: 'visualization', - * sortField: 'updated_at', - * sortOrder: 'asc', - * pit: { id: page1.pit_id }, - * searchAfter: lastHit.sort, - * }); - * await savedObjectsClient.closePointInTime(page2.pit_id); - * ``` - * - * @param {string|Array} type - * @param {object} [options] - {@link SavedObjectsOpenPointInTimeOptions} - * @property {string} [options.keepAlive] - * @property {string} [options.preference] - * @returns {promise} - { id: string } + * {@inheritDoc ISavedObjectsRepository.openPointInTimeForType} */ async openPointInTimeForType( type: string | string[], @@ -2072,45 +1833,7 @@ export class SavedObjectsRepository { } /** - * Closes a Point In Time (PIT) by ID. This simply proxies the request to ES - * via the Elasticsearch client, and is included in the Saved Objects Client - * as a convenience for consumers who are using `openPointInTimeForType`. - * - * Only use this API if you have an advanced use case that's not solved by the - * {@link SavedObjectsRepository.createPointInTimeFinder} method. - * - * @remarks - * While the `keepAlive` that is provided will cause a PIT to automatically close, - * it is highly recommended to explicitly close a PIT when you are done with it - * in order to avoid consuming unneeded resources in Elasticsearch. - * - * @example - * ```ts - * const repository = coreStart.savedObjects.createInternalRepository(); - * - * const { id } = await repository.openPointInTimeForType( - * type: 'index-pattern', - * { keepAlive: '2m' }, - * ); - * - * const response = await repository.find({ - * type: 'index-pattern', - * search: 'foo*', - * sortField: 'name', - * sortOrder: 'desc', - * pit: { - * id: 'abc123', - * keepAlive: '2m', - * }, - * searchAfter: [1234, 'abcd'], - * }); - * - * await repository.closePointInTime(response.pit_id); - * ``` - * - * @param {string} id - * @param {object} [options] - {@link SavedObjectsClosePointInTimeOptions} - * @returns {promise} - {@link SavedObjectsClosePointInTimeResponse} + * {@inheritDoc ISavedObjectsRepository.closePointInTime} */ async closePointInTime( id: string, @@ -2122,49 +1845,7 @@ export class SavedObjectsRepository { } /** - * Returns a {@link ISavedObjectsPointInTimeFinder} to help page through - * large sets of saved objects. We strongly recommend using this API for - * any `find` queries that might return more than 1000 saved objects, - * however this API is only intended for use in server-side "batch" - * processing of objects where you are collecting all objects in memory - * or streaming them back to the client. - * - * Do NOT use this API in a route handler to facilitate paging through - * saved objects on the client-side unless you are streaming all of the - * results back to the client at once. Because the returned generator is - * stateful, you cannot rely on subsequent http requests retrieving new - * pages from the same Kibana server in multi-instance deployments. - * - * This generator wraps calls to {@link SavedObjectsRepository.find} and - * iterates over multiple pages of results using `_pit` and `search_after`. - * This will open a new Point-In-Time (PIT), and continue paging until a - * set of results is received that's smaller than the designated `perPage`. - * - * Once you have retrieved all of the results you need, it is recommended - * to call `close()` to clean up the PIT and prevent Elasticsearch from - * consuming resources unnecessarily. This is only required if you are - * done iterating and have not yet paged through all of the results: the - * PIT will automatically be closed for you once you reach the last page - * of results, or if the underlying call to `find` fails for any reason. - * - * @example - * ```ts - * const findOptions: SavedObjectsCreatePointInTimeFinderOptions = { - * type: 'visualization', - * search: 'foo*', - * perPage: 100, - * }; - * - * const finder = savedObjectsClient.createPointInTimeFinder(findOptions); - * - * const responses: SavedObjectFindResponse[] = []; - * for await (const response of finder.find()) { - * responses.push(...response); - * if (doneSearching) { - * await finder.close(); - * } - * } - * ``` + * {@inheritDoc ISavedObjectsRepository.createPointInTimeFinder} */ createPointInTimeFinder( findOptions: SavedObjectsCreatePointInTimeFinderOptions, diff --git a/src/core/server/saved_objects/service/lib/scoped_client_provider.ts b/src/core/server/saved_objects/service/lib/scoped_client_provider.ts index 0a535ad199e2b..68aa94a183e77 100644 --- a/src/core/server/saved_objects/service/lib/scoped_client_provider.ts +++ b/src/core/server/saved_objects/service/lib/scoped_client_provider.ts @@ -7,8 +7,8 @@ */ import type { KibanaRequest } from '@kbn/core-http-server'; +import type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; import { PriorityCollection } from './priority_collection'; -import { SavedObjectsClientContract } from '../../types'; import { SavedObjectsRepositoryFactory } from '../../saved_objects_service'; import { ISavedObjectTypeRegistry } from '../../saved_objects_type_registry'; diff --git a/src/core/server/saved_objects/service/lib/search_dsl/pit_params.ts b/src/core/server/saved_objects/service/lib/search_dsl/pit_params.ts index 1a8dcb5cca2e9..c8be64e9a0494 100644 --- a/src/core/server/saved_objects/service/lib/search_dsl/pit_params.ts +++ b/src/core/server/saved_objects/service/lib/search_dsl/pit_params.ts @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import { SavedObjectsPitParams } from '../../../types'; +import type { SavedObjectsPitParams } from '@kbn/core-saved-objects-api-server'; export function getPitParams(pit: SavedObjectsPitParams) { return { diff --git a/src/core/server/saved_objects/service/lib/search_dsl/search_dsl.ts b/src/core/server/saved_objects/service/lib/search_dsl/search_dsl.ts index 5fbb9aba04583..23aa6e1fbeebb 100644 --- a/src/core/server/saved_objects/service/lib/search_dsl/search_dsl.ts +++ b/src/core/server/saved_objects/service/lib/search_dsl/search_dsl.ts @@ -9,8 +9,8 @@ import Boom from '@hapi/boom'; import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import type { SavedObjectsPitParams } from '@kbn/core-saved-objects-api-server'; import { IndexMapping } from '../../../mappings'; -import { SavedObjectsPitParams } from '../../../types'; import { getQueryParams, HasReferenceQueryParams, SearchOperator } from './query_params'; import { getPitParams } from './pit_params'; import { getSortingParams } from './sorting_params'; diff --git a/src/core/server/saved_objects/service/lib/update_objects_spaces.test.ts b/src/core/server/saved_objects/service/lib/update_objects_spaces.test.ts index 194caef879fe8..dfd1600e6d218 100644 --- a/src/core/server/saved_objects/service/lib/update_objects_spaces.test.ts +++ b/src/core/server/saved_objects/service/lib/update_objects_spaces.test.ts @@ -16,12 +16,10 @@ import { import { elasticsearchClientMock } from '@kbn/core-elasticsearch-client-server-mocks'; import { loggerMock } from '@kbn/logging-mocks'; +import type { SavedObjectsUpdateObjectsSpacesObject } from '@kbn/core-saved-objects-api-server'; import { typeRegistryMock } from '../../saved_objects_type_registry.mock'; import { SavedObjectsSerializer } from '../../serialization'; -import type { - SavedObjectsUpdateObjectsSpacesObject, - UpdateObjectsSpacesParams, -} from './update_objects_spaces'; +import type { UpdateObjectsSpacesParams } from './update_objects_spaces'; import { updateObjectsSpaces } from './update_objects_spaces'; import { ALL_NAMESPACES_STRING } from './utils'; import { SavedObjectsErrorHelpers } from './errors'; diff --git a/src/core/server/saved_objects/service/lib/update_objects_spaces.ts b/src/core/server/saved_objects/service/lib/update_objects_spaces.ts index b8ffd0ad7e528..6b09d393ef0c2 100644 --- a/src/core/server/saved_objects/service/lib/update_objects_spaces.ts +++ b/src/core/server/saved_objects/service/lib/update_objects_spaces.ts @@ -12,14 +12,15 @@ import intersection from 'lodash/intersection'; import type { Logger } from '@kbn/logging'; import { isNotFoundFromUnsupportedServer } from '@kbn/core-elasticsearch-server-internal'; +import type { + SavedObjectsUpdateObjectsSpacesObject, + SavedObjectsUpdateObjectsSpacesOptions, + SavedObjectsUpdateObjectsSpacesResponse, + SavedObjectsUpdateObjectsSpacesResponseObject, +} from '@kbn/core-saved-objects-api-server'; import type { IndexMapping } from '../../mappings'; import type { ISavedObjectTypeRegistry } from '../../saved_objects_type_registry'; import type { SavedObjectsRawDocSource, SavedObjectsSerializer } from '../../serialization'; -import type { - MutatingOperationRefreshSetting, - SavedObjectError, - SavedObjectsBaseOptions, -} from '../../types'; import type { DecoratedError } from './errors'; import { SavedObjectsErrorHelpers } from './errors'; import { @@ -36,65 +37,6 @@ import { ALL_NAMESPACES_STRING } from './utils'; import type { DeleteLegacyUrlAliasesParams } from './legacy_url_aliases'; import { deleteLegacyUrlAliases } from './legacy_url_aliases'; -/** - * An object that should have its spaces updated. - * - * @public - */ -export interface SavedObjectsUpdateObjectsSpacesObject { - /** The type of the object to update */ - id: string; - /** The ID of the object to update */ - type: string; - /** - * The space(s) that the object to update currently exists in. This is only intended to be used by SOC wrappers. - * - * @internal - */ - spaces?: string[]; - /** - * The version of the object to update; this is used for optimistic concurrency control. This is only intended to be used by SOC wrappers. - * - * @internal - */ - version?: string; -} - -/** - * Options for the update operation. - * - * @public - */ -export interface SavedObjectsUpdateObjectsSpacesOptions extends SavedObjectsBaseOptions { - /** The Elasticsearch Refresh setting for this operation */ - refresh?: MutatingOperationRefreshSetting; -} - -/** - * The response when objects' spaces are updated. - * - * @public - */ -export interface SavedObjectsUpdateObjectsSpacesResponse { - objects: SavedObjectsUpdateObjectsSpacesResponseObject[]; -} - -/** - * Details about a specific object's update result. - * - * @public - */ -export interface SavedObjectsUpdateObjectsSpacesResponseObject { - /** The type of the referenced object */ - type: string; - /** The ID of the referenced object */ - id: string; - /** The space(s) that the referenced object exists in */ - spaces: string[]; - /** Included if there was an error updating this object's spaces */ - error?: SavedObjectError; -} - /** * Parameters for the updateObjectsSpaces function. * diff --git a/src/core/server/saved_objects/service/lib/utils.test.ts b/src/core/server/saved_objects/service/lib/utils.test.ts index 0f502d8bfb9f1..8c836afd087d3 100644 --- a/src/core/server/saved_objects/service/lib/utils.test.ts +++ b/src/core/server/saved_objects/service/lib/utils.test.ts @@ -8,7 +8,7 @@ import { mockUuidv1, mockUuidv5 } from './utils.test.mock'; -import { SavedObjectsFindOptions } from '../../types'; +import { SavedObjectsFindOptions } from '@kbn/core-saved-objects-api-server'; import { SavedObjectsUtils } from './utils'; describe('SavedObjectsUtils', () => { diff --git a/src/core/server/saved_objects/service/lib/utils.ts b/src/core/server/saved_objects/service/lib/utils.ts index df79eba56d130..46f562d17aec3 100644 --- a/src/core/server/saved_objects/service/lib/utils.ts +++ b/src/core/server/saved_objects/service/lib/utils.ts @@ -8,8 +8,10 @@ import uuidv1 from 'uuid/v1'; import uuidv5 from 'uuid/v5'; -import { SavedObjectsFindOptions } from '../../types'; -import { SavedObjectsFindResponse } from '..'; +import type { + SavedObjectsFindOptions, + SavedObjectsFindResponse, +} from '@kbn/core-saved-objects-api-server'; export const DEFAULT_NAMESPACE_STRING = 'default'; export const ALL_NAMESPACES_STRING = '*'; diff --git a/src/core/server/saved_objects/service/saved_objects_client.test.ts b/src/core/server/saved_objects/service/saved_objects_client.test.ts index 7017d0d854b6f..77afd3f771a12 100644 --- a/src/core/server/saved_objects/service/saved_objects_client.test.ts +++ b/src/core/server/saved_objects/service/saved_objects_client.test.ts @@ -6,21 +6,16 @@ * Side Public License, v 1. */ -import { +import type { SavedObjectsBulkCreateObject, SavedObjectsBulkGetObject, SavedObjectsBulkResolveObject, SavedObjectsCheckConflictsObject, - SavedObjectsClient, SavedObjectsClosePointInTimeOptions, SavedObjectsCreateOptions, SavedObjectsDeleteOptions, SavedObjectsOpenPointInTimeOptions, SavedObjectsUpdateOptions, -} from './saved_objects_client'; -import { savedObjectsRepositoryMock } from './lib/repository.mock'; -import { savedObjectsClientMock } from './saved_objects_client.mock'; -import { SavedObjectsBaseOptions, SavedObjectsCollectMultiNamespaceReferencesObject, SavedObjectsCollectMultiNamespaceReferencesOptions, @@ -28,7 +23,10 @@ import { SavedObjectsFindOptions, SavedObjectsUpdateObjectsSpacesObject, SavedObjectsUpdateObjectsSpacesOptions, -} from '../..'; +} from '@kbn/core-saved-objects-api-server'; +import { SavedObjectsClient } from './saved_objects_client'; +import { savedObjectsRepositoryMock } from './lib/repository.mock'; +import { savedObjectsClientMock } from './saved_objects_client.mock'; describe('', () => { let mockRepository: ReturnType; diff --git a/src/core/server/saved_objects/service/saved_objects_client.ts b/src/core/server/saved_objects/service/saved_objects_client.ts index ba40127958aab..c9cfd9e720056 100644 --- a/src/core/server/saved_objects/service/saved_objects_client.ts +++ b/src/core/server/saved_objects/service/saved_objects_client.ts @@ -6,436 +6,47 @@ * Side Public License, v 1. */ +import type { SavedObject } from '@kbn/core-saved-objects-common'; import type { + SavedObjectsClientContract, ISavedObjectsRepository, + SavedObjectsBaseOptions, + SavedObjectsBulkResponse, + SavedObjectsUpdateResponse, + SavedObjectsBulkGetObject, + SavedObjectsBulkResolveObject, + SavedObjectsBulkCreateObject, + SavedObjectsBulkResolveResponse, + SavedObjectsCreateOptions, + SavedObjectsFindResponse, + SavedObjectsBulkUpdateResponse, + SavedObjectsUpdateObjectsSpacesOptions, + SavedObjectsCollectMultiNamespaceReferencesOptions, + SavedObjectsCollectMultiNamespaceReferencesResponse, + SavedObjectsCheckConflictsObject, + SavedObjectsCheckConflictsResponse, + SavedObjectsBulkUpdateOptions, + SavedObjectsRemoveReferencesToOptions, + SavedObjectsDeleteOptions, + SavedObjectsBulkUpdateObject, ISavedObjectsPointInTimeFinder, - SavedObjectsCreatePointInTimeFinderOptions, SavedObjectsCreatePointInTimeFinderDependencies, + SavedObjectsResolveResponse, SavedObjectsCollectMultiNamespaceReferencesObject, - SavedObjectsCollectMultiNamespaceReferencesOptions, - SavedObjectsCollectMultiNamespaceReferencesResponse, SavedObjectsUpdateObjectsSpacesObject, - SavedObjectsUpdateObjectsSpacesOptions, -} from './lib'; -import { - SavedObject, - SavedObjectError, - SavedObjectReference, - SavedObjectsMigrationVersion, - SavedObjectsBaseOptions, - MutatingOperationRefreshSetting, + SavedObjectsUpdateOptions, + SavedObjectsOpenPointInTimeOptions, + SavedObjectsClosePointInTimeOptions, + SavedObjectsCreatePointInTimeFinderOptions, SavedObjectsFindOptions, -} from '../types'; +} from '@kbn/core-saved-objects-api-server'; import { SavedObjectsErrorHelpers } from './lib/errors'; /** - * - * @public - */ -export interface SavedObjectsCreateOptions extends SavedObjectsBaseOptions { - /** (not recommended) Specify an id for the document */ - id?: string; - /** Overwrite existing documents (defaults to false) */ - overwrite?: boolean; - /** - * An opaque version number which changes on each successful write operation. - * Can be used in conjunction with `overwrite` for implementing optimistic concurrency control. - **/ - version?: string; - /** {@inheritDoc SavedObjectsMigrationVersion} */ - migrationVersion?: SavedObjectsMigrationVersion; - /** - * A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current - * Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the - * current Kibana version, it will result in an error. - * - * @remarks - * Do not attempt to set this manually. It should only be used if you retrieved an existing object that had the `coreMigrationVersion` - * field set and you want to create it again. - */ - coreMigrationVersion?: string; - references?: SavedObjectReference[]; - /** The Elasticsearch Refresh setting for this operation */ - refresh?: MutatingOperationRefreshSetting; - /** Optional ID of the original saved object, if this object's `id` was regenerated */ - originId?: string; - /** - * Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in - * {@link SavedObjectsCreateOptions}. - * - * * For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, - * including the "All spaces" identifier (`'*'`). - * * For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only - * be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. - * * For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. - */ - initialNamespaces?: string[]; -} - -/** - * - * @public - */ -export interface SavedObjectsBulkCreateObject { - id?: string; - type: string; - attributes: T; - version?: string; - references?: SavedObjectReference[]; - /** {@inheritDoc SavedObjectsMigrationVersion} */ - migrationVersion?: SavedObjectsMigrationVersion; - /** - * A semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current - * Kibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the - * current Kibana version, it will result in an error. - * - * @remarks - * Do not attempt to set this manually. It should only be used if you retrieved an existing object that had the `coreMigrationVersion` - * field set and you want to create it again. - */ - coreMigrationVersion?: string; - /** Optional ID of the original saved object, if this object's `id` was regenerated */ - originId?: string; - /** - * Optional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in - * {@link SavedObjectsCreateOptions}. - * - * * For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, - * including the "All spaces" identifier (`'*'`). - * * For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only - * be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. - * * For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. - */ - initialNamespaces?: string[]; -} - -/** - * - * @public - */ -export interface SavedObjectsBulkUpdateObject - extends Pick, 'version' | 'references'> { - /** The ID of this Saved Object, guaranteed to be unique for all objects of the same `type` */ - id: string; - /** The type of this Saved Object. Each plugin can define it's own custom Saved Object types. */ - type: string; - /** {@inheritdoc SavedObjectAttributes} */ - attributes: Partial; - /** - * Optional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in - * {@link SavedObjectsBulkUpdateOptions}. - * - * Note: the default namespace's string representation is `'default'`, and its ID representation is `undefined`. - **/ - namespace?: string; -} - -/** - * - * @public - */ -export interface SavedObjectsBulkResponse { - saved_objects: Array>; -} - -/** - * - * @public - */ -export interface SavedObjectsFindResult extends SavedObject { - /** - * The Elasticsearch `_score` of this result. - */ - score: number; - /** - * The Elasticsearch `sort` value of this result. - * - * @remarks - * This can be passed directly to the `searchAfter` param in the {@link SavedObjectsFindOptions} - * in order to page through large numbers of hits. It is recommended you use this alongside - * a Point In Time (PIT) that was opened with {@link SavedObjectsClient.openPointInTimeForType}. - * - * @example - * ```ts - * const { id } = await savedObjectsClient.openPointInTimeForType('visualization'); - * const page1 = await savedObjectsClient.find({ - * type: 'visualization', - * sortField: 'updated_at', - * sortOrder: 'asc', - * pit: { id }, - * }); - * const lastHit = page1.saved_objects[page1.saved_objects.length - 1]; - * const page2 = await savedObjectsClient.find({ - * type: 'visualization', - * sortField: 'updated_at', - * sortOrder: 'asc', - * pit: { id: page1.pit_id }, - * searchAfter: lastHit.sort, - * }); - * await savedObjectsClient.closePointInTime(page2.pit_id); - * ``` - */ - sort?: string[]; -} - -/** - * Return type of the Saved Objects `find()` method. - * - * *Note*: this type is different between the Public and Server Saved Objects - * clients. - * - * @public - */ -export interface SavedObjectsFindResponse { - aggregations?: A; - saved_objects: Array>; - total: number; - per_page: number; - page: number; - pit_id?: string; -} - -/** - * - * @public - */ -export interface SavedObjectsCheckConflictsObject { - id: string; - type: string; -} - -/** - * - * @public - */ -export interface SavedObjectsCheckConflictsResponse { - errors: Array<{ - id: string; - type: string; - error: SavedObjectError; - }>; -} - -/** - * - * @public - */ -export interface SavedObjectsUpdateOptions extends SavedObjectsBaseOptions { - /** - * An opaque version number which changes on each successful write operation. - * Can be used for implementing optimistic concurrency control. - */ - version?: string; - /** {@inheritdoc SavedObjectReference} */ - references?: SavedObjectReference[]; - /** The Elasticsearch Refresh setting for this operation */ - refresh?: MutatingOperationRefreshSetting; - /** If specified, will be used to perform an upsert if the document doesn't exist */ - upsert?: Attributes; - /** - * The Elasticsearch `retry_on_conflict` setting for this operation. - * Defaults to `0` when `version` is provided, `3` otherwise. - */ - retryOnConflict?: number; -} - -/** - * - * @public - */ -export interface SavedObjectsRemoveReferencesToOptions extends SavedObjectsBaseOptions { - /** The Elasticsearch Refresh setting for this operation. Defaults to `true` */ - refresh?: boolean; -} - -/** - * - * @public - */ -export interface SavedObjectsRemoveReferencesToResponse extends SavedObjectsBaseOptions { - /** The number of objects that have been updated by this operation */ - updated: number; -} - -/** - * - * @public - */ -export interface SavedObjectsBulkUpdateOptions extends SavedObjectsBaseOptions { - /** The Elasticsearch Refresh setting for this operation */ - refresh?: MutatingOperationRefreshSetting; -} - -/** - * - * @public - */ -export interface SavedObjectsDeleteOptions extends SavedObjectsBaseOptions { - /** The Elasticsearch Refresh setting for this operation */ - refresh?: MutatingOperationRefreshSetting; - /** Force deletion of an object that exists in multiple namespaces */ - force?: boolean; -} - -/** - * - * @public - */ -export interface SavedObjectsBulkGetObject { - id: string; - type: string; - /** SavedObject fields to include in the response */ - fields?: string[]; - /** - * Optional namespace(s) for the object to be retrieved in. If this is defined, it will supersede the namespace ID that is in the - * top-level options. - * - * * For shareable object types (registered with `namespaceType: 'multiple'`): this option can be used to specify one or more spaces, - * including the "All spaces" identifier (`'*'`). - * * For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`): this option can only - * be used to specify a single space, and the "All spaces" identifier (`'*'`) is not allowed. - * * For global object types (registered with `namespaceType: 'agnostic'`): this option cannot be used. - */ - namespaces?: string[]; -} - -/** - * - * @public - */ -export interface SavedObjectsBulkResponse { - saved_objects: Array>; -} - -/** - * - * @public - */ -export interface SavedObjectsBulkUpdateResponse { - saved_objects: Array>; -} - -/** - * - * @public - */ -export interface SavedObjectsUpdateResponse - extends Omit, 'attributes' | 'references'> { - attributes: Partial; - references: SavedObjectReference[] | undefined; -} - -/** - * - * @public - */ -export interface SavedObjectsBulkResolveObject { - id: string; - type: string; -} - -/** - * - * @public - */ -export interface SavedObjectsBulkResolveResponse { - resolved_objects: Array>; -} - -/** - * - * @public - */ -export interface SavedObjectsResolveResponse { - /** - * The saved object that was found. - */ - saved_object: SavedObject; - /** - * The outcome for a successful `resolve` call is one of the following values: - * - * * `'exactMatch'` -- One document exactly matched the given ID. - * * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different - * than the given ID. - * * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the - * `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID. - */ - outcome: 'exactMatch' | 'aliasMatch' | 'conflict'; - /** - * The ID of the object that the legacy URL alias points to. - * - * **Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - */ - alias_target_id?: string; - /** - * The reason this alias was created. - * - * Currently this is used to determine whether or not a toast should be shown when a user is redirected from a legacy URL; if the alias - * was created because of saved object conversion, then we will display a toast telling the user that the object has a new URL. - * - * **Note:** this field is *only* included when an alias was found (in other words, when the outcome is `'aliasMatch'` or `'conflict'`). - */ - alias_purpose?: 'savedObjectConversion' | 'savedObjectImport'; -} - -/** - * @public - */ -export interface SavedObjectsOpenPointInTimeOptions { - /** - * Optionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`. - */ - keepAlive?: string; - /** - * An optional ES preference value to be used for the query. - */ - preference?: string; - /** - * An optional list of namespaces to be used when opening the PIT. - * - * When the spaces plugin is enabled: - * - this will default to the user's current space (as determined by the URL) - * - if specified, the user's current space will be ignored - * - `['*']` will search across all available spaces - */ - namespaces?: string[]; -} - -/** - * @public - */ -export interface SavedObjectsOpenPointInTimeResponse { - /** - * PIT ID returned from ES. - */ - id: string; -} - -/** - * @public - */ -export type SavedObjectsClosePointInTimeOptions = SavedObjectsBaseOptions; - -/** - * @public - */ -export interface SavedObjectsClosePointInTimeResponse { - /** - * If true, all search contexts associated with the PIT id are - * successfully closed. - */ - succeeded: boolean; - /** - * The number of search contexts that have been successfully closed. - */ - num_freed: number; -} - -/** - * - * @public + * Core internal implementation of {@link SavedObjectsClientContract} + * @internal */ -export class SavedObjectsClient { +export class SavedObjectsClient implements SavedObjectsClientContract { public static errors = SavedObjectsErrorHelpers; public errors = SavedObjectsErrorHelpers; @@ -446,23 +57,12 @@ export class SavedObjectsClient { this._repository = repository; } - /** - * Persists a SavedObject - * - * @param type - * @param attributes - * @param options - */ + /** {@inheritDoc SavedObjectsClientContract.create} */ async create(type: string, attributes: T, options?: SavedObjectsCreateOptions) { return await this._repository.create(type, attributes, options); } - /** - * Persists multiple documents batched together as a single request - * - * @param objects - * @param options - */ + /** {@inheritDoc SavedObjectsClientContract.bulkCreate} */ async bulkCreate( objects: Array>, options?: SavedObjectsCreateOptions @@ -470,13 +70,7 @@ export class SavedObjectsClient { return await this._repository.bulkCreate(objects, options); } - /** - * Check what conflicts will result when creating a given array of saved objects. This includes "unresolvable conflicts", which are - * multi-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten. - * - * @param objects - * @param options - */ + /** {@inheritDoc SavedObjectsClientContract.checkConflicts} */ async checkConflicts( objects: SavedObjectsCheckConflictsObject[] = [], options: SavedObjectsBaseOptions = {} @@ -484,39 +78,19 @@ export class SavedObjectsClient { return await this._repository.checkConflicts(objects, options); } - /** - * Deletes a SavedObject - * - * @param type - * @param id - * @param options - */ + /** {@inheritDoc SavedObjectsClientContract.delete} */ async delete(type: string, id: string, options: SavedObjectsDeleteOptions = {}) { return await this._repository.delete(type, id, options); } - /** - * Find all SavedObjects matching the search query - * - * @param options - */ + /** {@inheritDoc SavedObjectsClientContract.find} */ async find( options: SavedObjectsFindOptions ): Promise> { return await this._repository.find(options); } - /** - * Returns an array of objects by id - * - * @param objects - an array of ids, or an array of objects containing id, type and optionally fields - * @example - * - * bulkGet([ - * { id: 'one', type: 'config' }, - * { id: 'foo', type: 'index-pattern' } - * ]) - */ + /** {@inheritDoc SavedObjectsClientContract.bulkGet} */ async bulkGet( objects: SavedObjectsBulkGetObject[] = [], options: SavedObjectsBaseOptions = {} @@ -524,13 +98,7 @@ export class SavedObjectsClient { return await this._repository.bulkGet(objects, options); } - /** - * Retrieves a single object - * - * @param type - The type of SavedObject to retrieve - * @param id - The ID of the SavedObject to retrieve - * @param options - */ + /** {@inheritDoc SavedObjectsClientContract.get} */ async get( type: string, id: string, @@ -539,21 +107,7 @@ export class SavedObjectsClient { return await this._repository.get(type, id, options); } - /** - * Resolves an array of objects by id, using any legacy URL aliases if they exist - * - * @param objects - an array of objects containing id, type - * @example - * - * bulkResolve([ - * { id: 'one', type: 'config' }, - * { id: 'foo', type: 'index-pattern' } - * ]) - * - * @note Saved objects that Kibana fails to find are replaced with an error object and an "exactMatch" outcome. The rationale behind the - * outcome is that "exactMatch" is the default outcome, and the outcome only changes if an alias is found. This behavior is unique to - * `bulkResolve`; the regular `resolve` API will throw an error instead. - */ + /** {@inheritDoc SavedObjectsClientContract.bulkResolve} */ async bulkResolve( objects: SavedObjectsBulkResolveObject[], options?: SavedObjectsBaseOptions @@ -561,13 +115,7 @@ export class SavedObjectsClient { return await this._repository.bulkResolve(objects, options); } - /** - * Resolves a single object, using any legacy URL alias if it exists - * - * @param type - The type of SavedObject to retrieve - * @param id - The ID of the SavedObject to retrieve - * @param options - */ + /** {@inheritDoc SavedObjectsClientContract.resolve} */ async resolve( type: string, id: string, @@ -576,13 +124,7 @@ export class SavedObjectsClient { return await this._repository.resolve(type, id, options); } - /** - * Updates an SavedObject - * - * @param type - * @param id - * @param options - */ + /** {@inheritDoc SavedObjectsClientContract.update} */ async update( type: string, id: string, @@ -592,11 +134,7 @@ export class SavedObjectsClient { return await this._repository.update(type, id, attributes, options); } - /** - * Bulk Updates multiple SavedObject at once - * - * @param objects - */ + /** {@inheritDoc SavedObjectsClientContract.bulkUpdate} */ async bulkUpdate( objects: Array>, options?: SavedObjectsBulkUpdateOptions @@ -604,9 +142,7 @@ export class SavedObjectsClient { return await this._repository.bulkUpdate(objects, options); } - /** - * Updates all objects containing a reference to the given {type, id} tuple to remove the said reference. - */ + /** {@inheritDoc SavedObjectsClientContract.removeReferencesTo} */ async removeReferencesTo( type: string, id: string, @@ -615,14 +151,7 @@ export class SavedObjectsClient { return await this._repository.removeReferencesTo(type, id, options); } - /** - * Opens a Point In Time (PIT) against the indices for the specified Saved Object types. - * The returned `id` can then be passed to {@link SavedObjectsClient.find} to search - * against that PIT. - * - * Only use this API if you have an advanced use case that's not solved by the - * {@link SavedObjectsClient.createPointInTimeFinder} method. - */ + /** {@inheritDoc SavedObjectsClientContract.openPointInTimeForType} */ async openPointInTimeForType( type: string | string[], options: SavedObjectsOpenPointInTimeOptions = {} @@ -630,63 +159,12 @@ export class SavedObjectsClient { return await this._repository.openPointInTimeForType(type, options); } - /** - * Closes a Point In Time (PIT) by ID. This simply proxies the request to ES via the - * Elasticsearch client, and is included in the Saved Objects Client as a convenience - * for consumers who are using {@link SavedObjectsClient.openPointInTimeForType}. - * - * Only use this API if you have an advanced use case that's not solved by the - * {@link SavedObjectsClient.createPointInTimeFinder} method. - */ + /** {@inheritDoc SavedObjectsClientContract.closePointInTime} */ async closePointInTime(id: string, options?: SavedObjectsClosePointInTimeOptions) { return await this._repository.closePointInTime(id, options); } - /** - * Returns a {@link ISavedObjectsPointInTimeFinder} to help page through - * large sets of saved objects. We strongly recommend using this API for - * any `find` queries that might return more than 1000 saved objects, - * however this API is only intended for use in server-side "batch" - * processing of objects where you are collecting all objects in memory - * or streaming them back to the client. - * - * Do NOT use this API in a route handler to facilitate paging through - * saved objects on the client-side unless you are streaming all of the - * results back to the client at once. Because the returned generator is - * stateful, you cannot rely on subsequent http requests retrieving new - * pages from the same Kibana server in multi-instance deployments. - * - * The generator wraps calls to {@link SavedObjectsClient.find} and iterates - * over multiple pages of results using `_pit` and `search_after`. This will - * open a new Point-In-Time (PIT), and continue paging until a set of - * results is received that's smaller than the designated `perPage`. - * - * Once you have retrieved all of the results you need, it is recommended - * to call `close()` to clean up the PIT and prevent Elasticsearch from - * consuming resources unnecessarily. This is only required if you are - * done iterating and have not yet paged through all of the results: the - * PIT will automatically be closed for you once you reach the last page - * of results, or if the underlying call to `find` fails for any reason. - * - * @example - * ```ts - * const findOptions: SavedObjectsCreatePointInTimeFinderOptions = { - * type: 'visualization', - * search: 'foo*', - * perPage: 100, - * }; - * - * const finder = savedObjectsClient.createPointInTimeFinder(findOptions); - * - * const responses: SavedObjectFindResponse[] = []; - * for await (const response of finder.find()) { - * responses.push(...response); - * if (doneSearching) { - * await finder.close(); - * } - * } - * ``` - */ + /** {@inheritDoc SavedObjectsClientContract.createPointInTimeFinder} */ createPointInTimeFinder( findOptions: SavedObjectsCreatePointInTimeFinderOptions, dependencies?: SavedObjectsCreatePointInTimeFinderDependencies @@ -698,12 +176,7 @@ export class SavedObjectsClient { }); } - /** - * Gets all references and transitive references of the listed objects. Ignores any object that is not a multi-namespace type. - * - * @param objects - * @param options - */ + /** {@inheritDoc SavedObjectsClientContract.collectMultiNamespaceReferences} */ async collectMultiNamespaceReferences( objects: SavedObjectsCollectMultiNamespaceReferencesObject[], options?: SavedObjectsCollectMultiNamespaceReferencesOptions @@ -711,14 +184,7 @@ export class SavedObjectsClient { return await this._repository.collectMultiNamespaceReferences(objects, options); } - /** - * Updates one or more objects to add and/or remove them from specified spaces. - * - * @param objects - * @param spacesToAdd - * @param spacesToRemove - * @param options - */ + /** {@inheritDoc SavedObjectsClientContract.updateObjectsSpaces} */ async updateObjectsSpaces( objects: SavedObjectsUpdateObjectsSpacesObject[], spacesToAdd: string[], diff --git a/src/core/server/saved_objects/types.ts b/src/core/server/saved_objects/types.ts index 134289cb2b493..75f3abdc9f9fe 100644 --- a/src/core/server/saved_objects/types.ts +++ b/src/core/server/saved_objects/types.ts @@ -8,42 +8,13 @@ import * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; import type { ElasticsearchClient } from '@kbn/core-elasticsearch-server'; -import { SavedObjectsClient } from './service/saved_objects_client'; +import type { SavedObject, SavedObjectsNamespaceType } from '@kbn/core-saved-objects-common'; import { SavedObjectsTypeMappingDefinition } from './mappings'; import { SavedObjectMigrationMap } from './migrations'; import { SavedObjectsExportTransform } from './export'; import { SavedObjectsImportHook } from './import/types'; import { SavedObjectsValidationMap } from './validation'; -export type { - SavedObjectsImportResponse, - SavedObjectsImportSuccess, - SavedObjectsImportConflictError, - SavedObjectsImportAmbiguousConflictError, - SavedObjectsImportUnsupportedTypeError, - SavedObjectsImportMissingReferencesError, - SavedObjectsImportUnknownError, - SavedObjectsImportFailure, - SavedObjectsImportRetry, - SavedObjectsImportActionRequiredWarning, - SavedObjectsImportSimpleWarning, - SavedObjectsImportWarning, -} from './import/types'; - -import { SavedObject } from '../../types'; - -type KueryNode = any; - -export type { - SavedObjectAttributes, - SavedObjectAttribute, - SavedObjectAttributeSingle, - SavedObject, - SavedObjectError, - SavedObjectReference, - SavedObjectsMigrationVersion, -} from '../../types'; - /** * Meta information about the SavedObjectService's status. Available to plugins via {@link CoreSetup.status}. * @@ -57,198 +28,7 @@ export interface SavedObjectStatusMeta { }; } -/** - * @public - */ -export interface SavedObjectsFindOptionsReference { - type: string; - id: string; -} - -/** - * @public - */ -export interface SavedObjectsPitParams { - id: string; - keepAlive?: string; -} - -/** - * - * @public - */ -export interface SavedObjectsFindOptions { - type: string | string[]; - page?: number; - perPage?: number; - sortField?: string; - sortOrder?: estypes.SortOrder; - /** - * An array of fields to include in the results - * @example - * SavedObjects.find({type: 'dashboard', fields: ['attributes.name', 'attributes.location']}) - */ - fields?: string[]; - /** Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information */ - search?: string; - /** The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information */ - searchFields?: string[]; - /** - * Use the sort values from the previous page to retrieve the next page of results. - */ - searchAfter?: estypes.Id[]; - /** - * The fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not - * be modified. If used in conjunction with `searchFields`, both are concatenated together. - */ - rootSearchFields?: string[]; - - /** - * Search for documents having a reference to the specified objects. - * Use `hasReferenceOperator` to specify the operator to use when searching for multiple references. - */ - hasReference?: SavedObjectsFindOptionsReference | SavedObjectsFindOptionsReference[]; - /** - * The operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR` - */ - hasReferenceOperator?: 'AND' | 'OR'; - - /** - * The search operator to use with the provided filter. Defaults to `OR` - */ - defaultSearchOperator?: 'AND' | 'OR'; - filter?: string | KueryNode; - /** - * A record of aggregations to perform. - * The API currently only supports a limited set of metrics and bucket aggregation types. - * Additional aggregation types can be contributed to Core. - * - * @example - * Aggregating on SO attribute field - * ```ts - * const aggs = { latest_version: { max: { field: 'dashboard.attributes.version' } } }; - * return client.find({ type: 'dashboard', aggs }) - * ``` - * - * @example - * Aggregating on SO root field - * ```ts - * const aggs = { latest_update: { max: { field: 'dashboard.updated_at' } } }; - * return client.find({ type: 'dashboard', aggs }) - * ``` - * - * @alpha - */ - aggs?: Record; - namespaces?: string[]; - /** - * This map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved - * object client wrapper. - * If this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query. - * Any types that are not included in this map will be excluded entirely. - * If a type is included but its value is undefined, the operation will search for that type in the Default namespace. - */ - typeToNamespacesMap?: Map; - /** An optional ES preference value to be used for the query **/ - preference?: string; - /** - * Search against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}. - */ - pit?: SavedObjectsPitParams; -} - -/** - * - * @public - */ -export interface SavedObjectsBaseOptions { - /** Specify the namespace for this operation */ - namespace?: string; -} - -/** - * Elasticsearch Refresh setting for mutating operation - * @public - */ -export type MutatingOperationRefreshSetting = boolean | 'wait_for'; - -/** - * Saved Objects is Kibana's data persisentence mechanism allowing plugins to - * use Elasticsearch for storing plugin state. - * - * ## SavedObjectsClient errors - * - * Since the SavedObjectsClient has its hands in everything we - * are a little paranoid about the way we present errors back to - * to application code. Ideally, all errors will be either: - * - * 1. Caused by bad implementation (ie. undefined is not a function) and - * as such unpredictable - * 2. An error that has been classified and decorated appropriately - * by the decorators in {@link SavedObjectsErrorHelpers} - * - * Type 1 errors are inevitable, but since all expected/handle-able errors - * should be Type 2 the `isXYZError()` helpers exposed at - * `SavedObjectsErrorHelpers` should be used to understand and manage error - * responses from the `SavedObjectsClient`. - * - * Type 2 errors are decorated versions of the source error, so if - * the elasticsearch client threw an error it will be decorated based - * on its type. That means that rather than looking for `error.body.error.type` or - * doing substring checks on `error.body.error.reason`, just use the helpers to - * understand the meaning of the error: - * - * ```js - * if (SavedObjectsErrorHelpers.isNotFoundError(error)) { - * // handle 404 - * } - * - * if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) { - * // 401 handling should be automatic, but in case you wanted to know - * } - * - * // always rethrow the error unless you handle it - * throw error; - * ``` - * - * ### 404s from missing index - * - * From the perspective of application code and APIs the SavedObjectsClient is - * a black box that persists objects. One of the internal details that users have - * no control over is that we use an elasticsearch index for persistence and that - * index might be missing. - * - * At the time of writing we are in the process of transitioning away from the - * operating assumption that the SavedObjects index is always available. Part of - * this transition is handling errors resulting from an index missing. These used - * to trigger a 500 error in most cases, and in others cause 404s with different - * error messages. - * - * From my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The - * object the request/call was targeting could not be found. This is why #14141 - * takes special care to ensure that 404 errors are generic and don't distinguish - * between index missing or document missing. - * - * See {@link SavedObjectsClient} - * See {@link SavedObjectsErrorHelpers} - * - * @public - */ -export type SavedObjectsClientContract = Pick; - -/** - * The namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive: - * * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace. - * * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces. - * * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be - * unique across all namespaces. This is intended to be an intermediate step when objects with a "single" namespace type are being - * converted to a "multiple" namespace type. In other words, objects with a "multiple-isolated" namespace type will be *share-capable*, - * but will not actually be shareable until the namespace type is changed to "multiple". - * * agnostic: This type of saved object is global. - * - * @public - */ -export type SavedObjectsNamespaceType = 'single' | 'multiple' | 'multiple-isolated' | 'agnostic'; +export type { SavedObjectsClientContract } from '@kbn/core-saved-objects-api-server'; /** * @public diff --git a/src/core/server/types.ts b/src/core/server/types.ts index 1bcdd1ac09535..ddf9a61471bd6 100644 --- a/src/core/server/types.ts +++ b/src/core/server/types.ts @@ -8,7 +8,7 @@ /** This module is intended for consumption by public to avoid import issues with server-side code */ export type { EnvironmentMode, PackageInfo } from '@kbn/config'; -export type { PluginOpaqueId } from './plugins/types'; +export type { PluginOpaqueId } from '@kbn/core-base-common'; export type { SavedObjectsImportResponse, SavedObjectsImportSuccess, @@ -26,25 +26,25 @@ export type { SavedObjectAttribute, SavedObjectAttributeSingle, SavedObject, + SavedObjectsNamespaceType, SavedObjectError, SavedObjectReference, SavedObjectsMigrationVersion, - SavedObjectStatusMeta, +} from '@kbn/core-saved-objects-common'; +export type { SavedObjectsFindOptionsReference, SavedObjectsFindOptions, SavedObjectsPitParams, SavedObjectsBaseOptions, MutatingOperationRefreshSetting, SavedObjectsClientContract, - SavedObjectsNamespaceType, -} from './saved_objects/types'; -export type { SavedObjectReferenceWithContext, SavedObjectsCollectMultiNamespaceReferencesResponse, -} from './saved_objects/service'; +} from '@kbn/core-saved-objects-api-server'; export type { DomainDeprecationDetails, DeprecationsGetResponse, } from '@kbn/core-deprecations-common'; -export * from './ui_settings/types'; export type { ExternalUrlConfig } from '@kbn/core-http-server-internal'; +export * from './ui_settings/types'; +export type { SavedObjectStatusMeta } from './saved_objects/types'; diff --git a/src/core/server/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.test.ts b/src/core/server/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.test.ts index 34ef0c5b4f2e1..b3f7b9f2fd55a 100644 --- a/src/core/server/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.test.ts +++ b/src/core/server/ui_settings/create_or_upgrade_saved_config/get_upgradeable_config.test.ts @@ -6,9 +6,9 @@ * Side Public License, v 1. */ +import type { SavedObjectsFindResponse } from '@kbn/core-saved-objects-api-server'; import { getUpgradeableConfig } from './get_upgradeable_config'; import { savedObjectsClientMock } from '../../saved_objects/service/saved_objects_client.mock'; -import { SavedObjectsFindResponse } from '../../saved_objects'; describe('getUpgradeableConfig', () => { it('finds saved objects with type "config"', async () => { diff --git a/src/core/server/ui_settings/ui_settings_client.ts b/src/core/server/ui_settings/ui_settings_client.ts index c6881d2817404..440072c0a769d 100644 --- a/src/core/server/ui_settings/ui_settings_client.ts +++ b/src/core/server/ui_settings/ui_settings_client.ts @@ -192,8 +192,7 @@ export class UiSettingsClient extends BaseUiSettingsClient { } private isIgnorableError(error: Error) { - const { isForbiddenError, isEsUnavailableError } = this.savedObjectsClient.errors; - + const { isForbiddenError, isEsUnavailableError } = SavedObjectsErrorHelpers; return isForbiddenError(error) || isEsUnavailableError(error); } } diff --git a/src/core/types/index.ts b/src/core/types/index.ts index 0ac84f0adbb44..a8cc9ec70420e 100644 --- a/src/core/types/index.ts +++ b/src/core/types/index.ts @@ -11,8 +11,17 @@ * types are stripped. */ export * from './app_category'; -export * from './saved_objects'; export type { Capabilities } from '@kbn/core-capabilities-common'; +export type { + SavedObject, + SavedObjectsNamespaceType, + SavedObjectAttributeSingle, + SavedObjectAttribute, + SavedObjectAttributes, + SavedObjectError, + SavedObjectReference, + SavedObjectsMigrationVersion, +} from '@kbn/core-saved-objects-common'; export type { KibanaExecutionContext } from '@kbn/core-execution-context-common'; export type { UiSettingsType, diff --git a/src/plugins/chart_expressions/expression_metric/common/expression_functions/metric_vis_function.ts b/src/plugins/chart_expressions/expression_metric/common/expression_functions/metric_vis_function.ts index b7b3426f5e132..d01a2400e038a 100644 --- a/src/plugins/chart_expressions/expression_metric/common/expression_functions/metric_vis_function.ts +++ b/src/plugins/chart_expressions/expression_metric/common/expression_functions/metric_vis_function.ts @@ -31,6 +31,7 @@ export const metricVisFunction = (): MetricVisExpressionFunctionDefinition => ({ help: i18n.translate('expressionMetricVis.function.metric.help', { defaultMessage: 'The primary metric.', }), + required: true, }, secondaryMetric: { types: ['vis_dimension', 'string'], @@ -38,6 +39,12 @@ export const metricVisFunction = (): MetricVisExpressionFunctionDefinition => ({ defaultMessage: 'The secondary metric (shown above the primary).', }), }, + max: { + types: ['vis_dimension', 'string'], + help: i18n.translate('expressionMetricVis.function.max.help.', { + defaultMessage: 'The dimension containing the maximum value.', + }), + }, breakdownBy: { types: ['vis_dimension', 'string'], help: i18n.translate('expressionMetricVis.function.breakdownBy.help', { @@ -50,16 +57,10 @@ export const metricVisFunction = (): MetricVisExpressionFunctionDefinition => ({ defaultMessage: 'The subtitle for a single metric. Overridden if breakdownBy is supplied.', }), }, - extraText: { + secondaryPrefix: { types: ['string'], - help: i18n.translate('expressionMetricVis.function.extra.help', { - defaultMessage: 'Text to be shown above metric value. Overridden by secondaryMetric.', - }), - }, - progressMax: { - types: ['vis_dimension', 'string'], - help: i18n.translate('expressionMetricVis.function.progressMax.help.', { - defaultMessage: 'The dimension containing the maximum value.', + help: i18n.translate('expressionMetricVis.function.secondaryPrefix.help', { + defaultMessage: 'Optional text to be show before secondaryMetric.', }), }, progressDirection: { @@ -71,6 +72,12 @@ export const metricVisFunction = (): MetricVisExpressionFunctionDefinition => ({ }), strict: true, }, + color: { + types: ['string'], + help: i18n.translate('expressionMetricVis.function.color.help', { + defaultMessage: 'Provides a static visualization color. Overridden by palette.', + }), + }, palette: { types: ['palette'], help: i18n.translate('expressionMetricVis.function.palette.help', { @@ -79,7 +86,7 @@ export const metricVisFunction = (): MetricVisExpressionFunctionDefinition => ({ }, maxCols: { types: ['number'], - help: i18n.translate('expressionMetricVis.function.maxCols.help', { + help: i18n.translate('expressionMetricVis.function.numCols.help', { defaultMessage: 'Specifies the max number of columns in the metric grid.', }), default: 5, @@ -128,9 +135,9 @@ export const metricVisFunction = (): MetricVisExpressionFunctionDefinition => ({ ]); } - if (args.progressMax) { + if (args.max) { argsTable.push([ - [args.progressMax], + [args.max], i18n.translate('expressionMetricVis.function.dimension.maximum', { defaultMessage: 'Maximum', }), @@ -150,7 +157,8 @@ export const metricVisFunction = (): MetricVisExpressionFunctionDefinition => ({ visConfig: { metric: { subtitle: args.subtitle, - extraText: args.extraText, + secondaryPrefix: args.secondaryPrefix, + color: args.color, palette: args.palette?.params, progressDirection: args.progressDirection, maxCols: args.maxCols, @@ -159,8 +167,8 @@ export const metricVisFunction = (): MetricVisExpressionFunctionDefinition => ({ dimensions: { metric: args.metric, secondaryMetric: args.secondaryMetric, + max: args.max, breakdownBy: args.breakdownBy, - progressMax: args.progressMax, }, }, }, diff --git a/src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts b/src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts index bc383569a1c01..d44b34fa736d1 100644 --- a/src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts +++ b/src/plugins/chart_expressions/expression_metric/common/types/expression_functions.ts @@ -21,11 +21,12 @@ import { EXPRESSION_METRIC_NAME } from '../constants'; export interface MetricArguments { metric: ExpressionValueVisDimension | string; secondaryMetric?: ExpressionValueVisDimension | string; + max?: ExpressionValueVisDimension | string; breakdownBy?: ExpressionValueVisDimension | string; subtitle?: string; - extraText?: string; - progressMax?: ExpressionValueVisDimension | string; + secondaryPrefix?: string; progressDirection: LayoutDirection; + color?: string; palette?: PaletteOutput; maxCols: number; minTiles?: number; diff --git a/src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts b/src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts index 20be978b55684..75144d1cf5525 100644 --- a/src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts +++ b/src/plugins/chart_expressions/expression_metric/common/types/expression_renderers.ts @@ -15,13 +15,14 @@ export const visType = 'metric'; export interface DimensionsVisParam { metric: ExpressionValueVisDimension | string; secondaryMetric?: ExpressionValueVisDimension | string; + max?: ExpressionValueVisDimension | string; breakdownBy?: ExpressionValueVisDimension | string; - progressMax?: ExpressionValueVisDimension | string; } export interface MetricVisParam { subtitle?: string; - extraText?: string; + secondaryPrefix?: string; + color?: string; palette?: CustomPaletteState; progressDirection: LayoutDirection; maxCols: number; diff --git a/src/plugins/chart_expressions/expression_metric/public/components/__snapshots__/metric_vis.test.tsx.snap b/src/plugins/chart_expressions/expression_metric/public/components/__snapshots__/metric_vis.test.tsx.snap new file mode 100644 index 0000000000000..0f4130c238b74 --- /dev/null +++ b/src/plugins/chart_expressions/expression_metric/public/components/__snapshots__/metric_vis.test.tsx.snap @@ -0,0 +1,81 @@ +// Jest Snapshot v1, https://goo.gl/fbAQLP + +exports[`MetricVisComponent coloring by palette percent-based should set correct data bounds with breakdown-by and max dimension 1`] = ` +Array [ + Object { + "max": 28.984375, + "min": 0, + "value": 13.6328125, + }, + Object { + "max": 28.984375, + "min": 0, + "value": 13.639539930555555, + }, + Object { + "max": 25.984375, + "min": 0, + "value": 13.34375, + }, + Object { + "max": 25.784375, + "min": 0, + "value": 13.4921875, + }, + Object { + "max": 25.348011363636363, + "min": 0, + "value": 13.34375, + }, + Object { + "max": 24.984375, + "min": 0, + "value": 13.242513020833334, + }, +] +`; + +exports[`MetricVisComponent coloring by palette percent-based should set correct data bounds with just breakdown-by dimension 1`] = ` +Array [ + Object { + "max": 13.639539930555555, + "min": 13.242513020833334, + "value": 13.6328125, + }, + Object { + "max": 13.639539930555555, + "min": 13.242513020833334, + "value": 13.639539930555555, + }, + Object { + "max": 13.639539930555555, + "min": 13.242513020833334, + "value": 13.34375, + }, + Object { + "max": 13.639539930555555, + "min": 13.242513020833334, + "value": 13.4921875, + }, + Object { + "max": 13.639539930555555, + "min": 13.242513020833334, + "value": 13.34375, + }, + Object { + "max": 13.639539930555555, + "min": 13.242513020833334, + "value": 13.242513020833334, + }, +] +`; + +exports[`MetricVisComponent coloring by palette percent-based should set correct data bounds with just max dimension 1`] = ` +Array [ + Object { + "max": 28.984375, + "min": 0, + "value": 13.6328125, + }, +] +`; diff --git a/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.test.tsx b/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.test.tsx index 4e70f7d75146a..7ecc379b2abc6 100644 --- a/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.test.tsx +++ b/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.test.tsx @@ -9,15 +9,29 @@ import React from 'react'; import { shallow } from 'enzyme'; import { Datatable } from '@kbn/expressions-plugin/common'; -import MetricVis, { MetricVisComponentProps } from './metric_vis'; -import { LayoutDirection, Metric, MetricWProgress, Settings } from '@elastic/charts'; +import { MetricVis, MetricVisComponentProps } from './metric_vis'; +import { + LayoutDirection, + Metric, + MetricElementEvent, + MetricWProgress, + Settings, +} from '@elastic/charts'; import { SerializedFieldFormat } from '@kbn/field-formats-plugin/common'; import { SerializableRecord } from '@kbn/utility-types'; import numeral from '@elastic/numeral'; - -const mockDeserialize = jest.fn(() => ({ - getConverterFor: jest.fn(() => () => 'formatted duration'), -})); +import { HtmlAttributes } from 'csstype'; +import { CustomPaletteState } from '@kbn/charts-plugin/common/expressions/palette/types'; +import { DimensionsVisParam } from '../../common'; +import { euiThemeVars } from '@kbn/ui-theme'; + +const mockDeserialize = jest.fn((params) => { + const converter = + params.id === 'terms' + ? (val: string) => (val === '__other__' ? 'Other' : val) + : () => 'formatted duration'; + return { getConverterFor: jest.fn(() => converter) }; +}); const mockGetColorForValue = jest.fn(() => undefined); @@ -186,14 +200,25 @@ const table: Datatable = { [minPriceColumnId]: 13.34375, }, { - [dayOfWeekColumnId]: 'Monday', + [dayOfWeekColumnId]: '__other__', [basePriceColumnId]: 24.984375, [minPriceColumnId]: 13.242513020833334, }, ], }; +const defaultProps = { + renderComplete: () => {}, + fireEvent: () => {}, + filterable: true, + renderMode: 'view', +} as Pick; + describe('MetricVisComponent', function () { + afterEach(() => { + mockDeserialize.mockClear(); + }); + describe('single metric', () => { const config: Props['config'] = { metric: { @@ -206,9 +231,7 @@ describe('MetricVisComponent', function () { }; it('should render a single metric value', () => { - const component = shallow( - {}} /> - ); + const component = shallow(); const { data } = component.find(Metric).props(); @@ -219,7 +242,7 @@ describe('MetricVisComponent', function () { expect(visConfig).toMatchInlineSnapshot(` Object { - "color": "#343741", + "color": "#f5f7fa", "extra": , "subtitle": undefined, "title": "Median products.base_price", @@ -228,29 +251,26 @@ describe('MetricVisComponent', function () { } `); }); - it('should display subtitle and extra text', () => { + it('should display subtitle and secondary prefix', () => { const component = shallow( {}} + {...defaultProps} /> ); const [[visConfig]] = component.find(Metric).props().data!; expect(visConfig!.subtitle).toBe('subtitle'); - expect(visConfig!.extra).toEqual(extra text); expect(visConfig).toMatchInlineSnapshot(` Object { - "color": "#343741", - "extra": - extra text - , + "color": "#f5f7fa", + "extra": , "subtitle": "subtitle", "title": "Median products.base_price", "value": 28.984375, @@ -263,27 +283,31 @@ describe('MetricVisComponent', function () { {}} + {...defaultProps} /> ); const [[visConfig]] = component.find(Metric).props().data!; - // overrides subtitle and extra text - expect(visConfig!.subtitle).toBe(table.columns[2].name); - expect(visConfig!.extra).toEqual(13.63); + expect(visConfig!.extra).toEqual( + + {'secondary prefix'} + {' ' + 13.63} + + ); expect(visConfig).toMatchInlineSnapshot(` Object { - "color": "#343741", + "color": "#f5f7fa", "extra": - 13.63 + secondary prefix + 13.63 , - "subtitle": "Median products.min_price", + "subtitle": "subtitle", "title": "Median products.base_price", "value": 28.984375, "valueFormatter": [Function], @@ -303,11 +327,11 @@ describe('MetricVisComponent', function () { }, dimensions: { ...config.dimensions, - progressMax: max, + max, }, }} data={table} - renderComplete={() => {}} + {...defaultProps} /> ) .find(Metric) @@ -326,7 +350,7 @@ describe('MetricVisComponent', function () { expect(configWithProgress).toMatchInlineSnapshot(` Object { - "color": "#343741", + "color": "#f5f7fa", "domainMax": 28.984375, "extra": , "progressBarDirection": "vertical", @@ -341,56 +365,6 @@ describe('MetricVisComponent', function () { (getConfig(basePriceColumnId, 'horizontal') as MetricWProgress).progressBarDirection ).toBe('horizontal'); }); - - it('should fetch color from palette if provided', () => { - const colorFromPalette = 'color-from-palette'; - - mockGetColorForValue.mockReturnValue(colorFromPalette); - - const component = shallow( - {}} - /> - ); - - const [[datum]] = component.find(Metric).props().data!; - - expect(datum!.color).toBe(colorFromPalette); - expect(mockGetColorForValue.mock.calls).toMatchInlineSnapshot(` - Array [ - Array [ - 28.984375, - Object { - "colors": Array [], - "gradient": true, - "range": "number", - "rangeMax": 10, - "rangeMin": 2, - "stops": Array [], - }, - Object { - "max": 10, - "min": 2, - }, - ], - ] - `); - }); }); describe('metric grid', () => { @@ -406,9 +380,7 @@ describe('MetricVisComponent', function () { }; it('should render a grid if breakdownBy dimension supplied', () => { - const component = shallow( - {}} /> - ); + const component = shallow(); const { data } = component.find(Metric).props(); @@ -420,7 +392,7 @@ describe('MetricVisComponent', function () { expect(visConfig).toMatchInlineSnapshot(` Array [ Object { - "color": "#343741", + "color": "#f5f7fa", "extra": , "subtitle": "Median products.base_price", "title": "Friday", @@ -428,7 +400,7 @@ describe('MetricVisComponent', function () { "valueFormatter": [Function], }, Object { - "color": "#343741", + "color": "#f5f7fa", "extra": , "subtitle": "Median products.base_price", "title": "Wednesday", @@ -436,7 +408,7 @@ describe('MetricVisComponent', function () { "valueFormatter": [Function], }, Object { - "color": "#343741", + "color": "#f5f7fa", "extra": , "subtitle": "Median products.base_price", "title": "Saturday", @@ -444,7 +416,7 @@ describe('MetricVisComponent', function () { "valueFormatter": [Function], }, Object { - "color": "#343741", + "color": "#f5f7fa", "extra": , "subtitle": "Median products.base_price", "title": "Sunday", @@ -452,7 +424,7 @@ describe('MetricVisComponent', function () { "valueFormatter": [Function], }, Object { - "color": "#343741", + "color": "#f5f7fa", "extra": , "subtitle": "Median products.base_price", "title": "Thursday", @@ -463,17 +435,17 @@ describe('MetricVisComponent', function () { `); }); - it('should display extra text or secondary metric', () => { + it('should display secondary prefix or secondary metric', () => { const componentWithSecondaryDimension = shallow( {}} + {...defaultProps} /> ); @@ -485,19 +457,24 @@ describe('MetricVisComponent', function () { ).toMatchInlineSnapshot(` Array [ - 13.63 + howdy + 13.63 , - 13.64 + howdy + 13.64 , - 13.34 + howdy + 13.34 , - 13.49 + howdy + 13.49 , - 13.34 + howdy + 13.34 , ] `); @@ -506,10 +483,10 @@ describe('MetricVisComponent', function () { {}} + {...defaultProps} /> ); @@ -552,7 +529,7 @@ describe('MetricVisComponent', function () { }, }} data={table} - renderComplete={() => {}} + {...defaultProps} /> ) .find(Metric) @@ -575,7 +552,7 @@ describe('MetricVisComponent', function () { Array [ Array [ Object { - "color": "#343741", + "color": "#f5f7fa", "extra": , "subtitle": "Median products.base_price", "title": "Friday", @@ -583,7 +560,7 @@ describe('MetricVisComponent', function () { "valueFormatter": [Function], }, Object { - "color": "#343741", + "color": "#f5f7fa", "extra": , "subtitle": "Median products.base_price", "title": "Wednesday", @@ -591,7 +568,7 @@ describe('MetricVisComponent', function () { "valueFormatter": [Function], }, Object { - "color": "#343741", + "color": "#f5f7fa", "extra": , "subtitle": "Median products.base_price", "title": "Saturday", @@ -599,7 +576,7 @@ describe('MetricVisComponent', function () { "valueFormatter": [Function], }, Object { - "color": "#343741", + "color": "#f5f7fa", "extra": , "subtitle": "Median products.base_price", "title": "Sunday", @@ -607,7 +584,7 @@ describe('MetricVisComponent', function () { "valueFormatter": [Function], }, Object { - "color": "#343741", + "color": "#f5f7fa", "extra": , "subtitle": "Median products.base_price", "title": "Thursday", @@ -617,10 +594,10 @@ describe('MetricVisComponent', function () { ], Array [ Object { - "color": "#343741", + "color": "#f5f7fa", "extra": , "subtitle": "Median products.base_price", - "title": "Monday", + "title": "Other", "value": 24.984375, "valueFormatter": [Function], }, @@ -644,11 +621,11 @@ describe('MetricVisComponent', function () { }, dimensions: { ...config.dimensions, - progressMax: basePriceColumnId, + max: basePriceColumnId, }, }} data={table} - renderComplete={() => {}} + {...defaultProps} /> ) .find(Metric) @@ -657,7 +634,7 @@ describe('MetricVisComponent', function () { Array [ Array [ Object { - "color": "#343741", + "color": "#f5f7fa", "domainMax": 28.984375, "extra": , "progressBarDirection": "vertical", @@ -667,7 +644,7 @@ describe('MetricVisComponent', function () { "valueFormatter": [Function], }, Object { - "color": "#343741", + "color": "#f5f7fa", "domainMax": 28.984375, "extra": , "progressBarDirection": "vertical", @@ -677,7 +654,7 @@ describe('MetricVisComponent', function () { "valueFormatter": [Function], }, Object { - "color": "#343741", + "color": "#f5f7fa", "domainMax": 25.984375, "extra": , "progressBarDirection": "vertical", @@ -687,7 +664,7 @@ describe('MetricVisComponent', function () { "valueFormatter": [Function], }, Object { - "color": "#343741", + "color": "#f5f7fa", "domainMax": 25.784375, "extra": , "progressBarDirection": "vertical", @@ -697,7 +674,7 @@ describe('MetricVisComponent', function () { "valueFormatter": [Function], }, Object { - "color": "#343741", + "color": "#f5f7fa", "domainMax": 25.348011363636363, "extra": , "progressBarDirection": "vertical", @@ -709,12 +686,12 @@ describe('MetricVisComponent', function () { ], Array [ Object { - "color": "#343741", + "color": "#f5f7fa", "domainMax": 24.984375, "extra": , "progressBarDirection": "vertical", "subtitle": "Median products.base_price", - "title": "Monday", + "title": "Other", "value": 24.984375, "valueFormatter": [Function], }, @@ -722,6 +699,88 @@ describe('MetricVisComponent', function () { ] `); }); + + it('renders with no data', () => { + const component = shallow( + + ); + + const { data } = component.find(Metric).props(); + + expect(data).toBeDefined(); + expect(data).toMatchInlineSnapshot(` + Array [ + Array [ + undefined, + undefined, + undefined, + undefined, + undefined, + ], + Array [ + undefined, + ], + ] + `); + }); + }); + + describe('rendering with no data', () => {}); + + it('should constrain dimensions in edit mode', () => { + const getContainerStyles = (editMode: boolean, multipleTiles: boolean) => + ( + shallow( + + ) + .find('div') + .props() as HtmlAttributes & { css: { styles: string } } + ).css.styles; + + expect(getContainerStyles(false, false)).toMatchInlineSnapshot(` + " + height: 100%; + width: 100%; + max-height: 100%; + max-width: 100%; + " + `); + + expect(getContainerStyles(true, false)).toMatchInlineSnapshot(` + " + height: 300px; + width: 300px; + max-height: 100%; + max-width: 100%; + " + `); + + expect(getContainerStyles(true, true)).toMatchInlineSnapshot(` + " + height: 400px; + width: 1000px; + max-height: 100%; + max-width: 100%; + " + `); }); it('should report render complete', () => { @@ -738,6 +797,7 @@ describe('MetricVisComponent', function () { }, }} data={table} + {...defaultProps} renderComplete={renderCompleteSpy} /> ); @@ -750,6 +810,271 @@ describe('MetricVisComponent', function () { expect(renderCompleteSpy).toHaveBeenCalledTimes(1); }); + describe('filter events', () => { + const fireEventSpy = jest.fn(); + + afterEach(() => fireEventSpy.mockClear()); + + const fireFilter = (event: MetricElementEvent, filterable: boolean, breakdown?: boolean) => { + const component = shallow( + + ); + + component.find(Settings).props().onElementClick!([event]); + }; + + test('without breakdown', () => { + const event: MetricElementEvent = { + type: 'metricElementEvent', + rowIndex: 0, + columnIndex: 0, + }; + + fireFilter(event, true, false); + + expect(fireEventSpy).toHaveBeenCalledTimes(1); + expect(fireEventSpy).toHaveBeenCalledWith({ + name: 'filter', + data: { + data: [ + { + table, + column: 1, + row: 0, + }, + ], + }, + }); + }); + + test('with breakdown', () => { + const event: MetricElementEvent = { + type: 'metricElementEvent', + rowIndex: 1, + columnIndex: 0, + }; + + fireFilter(event, true, true); + + expect(fireEventSpy).toHaveBeenCalledTimes(1); + expect(fireEventSpy).toHaveBeenCalledWith({ + name: 'filter', + data: { + data: [ + { + table, + column: 0, + row: 5, + }, + ], + }, + }); + }); + + it('should do nothing if primary metric is not filterable', () => { + const event: MetricElementEvent = { + type: 'metricElementEvent', + rowIndex: 1, + columnIndex: 0, + }; + + fireFilter(event, false, true); + + expect(fireEventSpy).not.toHaveBeenCalled(); + }); + }); + + describe('coloring', () => { + afterEach(() => mockGetColorForValue.mockClear()); + + describe('by palette', () => { + const colorFromPalette = 'color-from-palette'; + mockGetColorForValue.mockReturnValue(colorFromPalette); + + it('should fetch color from palette if provided', () => { + const component = shallow( + + ); + + const [[datum]] = component.find(Metric).props().data!; + + expect(datum!.color).toBe(colorFromPalette); + expect(mockGetColorForValue.mock.calls).toMatchInlineSnapshot(` + Array [ + Array [ + 28.984375, + Object { + "colors": Array [], + "gradient": true, + "range": "number", + "rangeMax": 10, + "rangeMin": 2, + "stops": Array [], + }, + Object { + "max": 28.984375, + "min": 0, + }, + ], + ] + `); + }); + + describe('percent-based', () => { + const renderWithPalette = ( + palette: CustomPaletteState, + dimensions: MetricVisComponentProps['config']['dimensions'] + ) => + shallow( + + ); + + const dimensionsAndExpectedBounds = [ + [ + 'breakdown-by and max', + { + metric: minPriceColumnId, + max: basePriceColumnId, + breakdownBy: dayOfWeekColumnId, + }, + ], + ['just breakdown-by', { metric: minPriceColumnId, breakdownBy: dayOfWeekColumnId }], + ['just max', { metric: minPriceColumnId, max: basePriceColumnId }], + ]; + + it.each(dimensionsAndExpectedBounds)( + 'should set correct data bounds with %s dimension', + // @ts-expect-error + (label, dimensions) => { + mockGetColorForValue.mockClear(); + + renderWithPalette( + { + range: 'percent', + // the rest of these params don't matter + colors: [], + gradient: false, + stops: [], + rangeMin: 2, + rangeMax: 10, + }, + dimensions as DimensionsVisParam + ); + + expect( + mockGetColorForValue.mock.calls.map(([value, _palette, bounds]) => ({ + value, + ...bounds, + })) + ).toMatchSnapshot(); + } + ); + }); + }); + + describe('by static color', () => { + it('uses static color if no palette', () => { + const staticColor = 'static-color'; + + const component = shallow( + + ); + + const [[datum]] = component.find(Metric).props().data!; + + expect(datum!.color).toBe(staticColor); + expect(mockGetColorForValue).not.toHaveBeenCalled(); + }); + + it('defaults if no static color', () => { + const component = shallow( + + ); + + const [[datum]] = component.find(Metric).props().data!; + + expect(datum!.color).toBe(euiThemeVars.euiColorLightestShade); + expect(mockGetColorForValue).not.toHaveBeenCalled(); + }); + }); + }); + describe('metric value formatting', () => { const getFormattedMetrics = ( value: number, @@ -786,7 +1111,7 @@ describe('MetricVisComponent', function () { ], rows: [{ '1': value, '2': secondaryValue }], }} - renderComplete={() => {}} + {...defaultProps} /> ); @@ -796,7 +1121,7 @@ describe('MetricVisComponent', function () { extra, } = component.find(Metric).props().data?.[0][0]!; - return { primary: valueFormatter(primaryMetric), secondary: extra?.props.children }; + return { primary: valueFormatter(primaryMetric), secondary: extra?.props.children[1] }; }; it('correctly formats plain numbers', () => { diff --git a/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.tsx b/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.tsx index 3f91061cba6c3..5473d98d85c18 100644 --- a/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.tsx +++ b/src/plugins/chart_expressions/expression_metric/public/components/metric_vis.tsx @@ -6,7 +6,7 @@ * Side Public License, v 1. */ -import React, { useCallback } from 'react'; +import React, { useCallback, useEffect, useRef } from 'react'; import numeral from '@elastic/numeral'; import { i18n } from '@kbn/i18n'; @@ -14,21 +14,26 @@ import { Chart, Metric, MetricSpec, + MetricWProgress, + isMetricElementEvent, RenderChangeListener, Settings, - MetricWProgress, } from '@elastic/charts'; import { getColumnByAccessor, getFormatByAccessor } from '@kbn/visualizations-plugin/common/utils'; import { ExpressionValueVisDimension } from '@kbn/visualizations-plugin/common'; -import { +import type { Datatable, DatatableColumn, DatatableRow, IInterpreterRenderHandlers, + RenderMode, } from '@kbn/expressions-plugin/common'; import { CustomPaletteState } from '@kbn/charts-plugin/public'; -import { euiLightVars } from '@kbn/ui-theme'; import { FORMATS_UI_SETTINGS } from '@kbn/field-formats-plugin/common'; +import type { FieldFormatConvertFunction } from '@kbn/field-formats-plugin/common'; +import { CUSTOM_PALETTE } from '@kbn/coloring'; +import { css } from '@emotion/react'; +import { euiThemeVars } from '@kbn/ui-theme'; import { VisParams } from '../../common'; import { getPaletteService, @@ -37,9 +42,9 @@ import { getUiSettingsService, } from '../services'; import { getCurrencyCode } from './currency_codes'; +import { getDataBoundsForPalette } from '../utils'; -const defaultColor = euiLightVars.euiColorDarkestShade; - +export const defaultColor = euiThemeVars.euiColorLightestShade; const getBytesUnit = (value: number) => { const units = ['byte', 'kilobyte', 'megabyte', 'gigabyte', 'terabyte', 'petabyte']; const abs = Math.abs(value); @@ -69,7 +74,7 @@ const getBytesUnit = (value: number) => { return { value, unit }; }; -const getFormatter = ( +const getMetricFormatter = ( accessor: ExpressionValueVisDimension | string, columns: Datatable['columns'] ) => { @@ -79,7 +84,7 @@ const getFormatter = ( if (!['number', 'currency', 'percent', 'bytes', 'duration'].includes(formatId)) { throw new Error( i18n.translate('expressionMetricVis.errors.unsupportedColumnFormat', { - defaultMessage: 'Metric Visualization - Unsupported column format: "{id}"', + defaultMessage: 'Metric visualization expression - Unsupported column format: "{id}"', values: { id: formatId, }, @@ -140,55 +145,97 @@ const getFormatter = ( : new Intl.NumberFormat(locale, intlOptions).format; }; -const getColor = (value: number, paletteParams: CustomPaletteState | undefined) => - paletteParams - ? getPaletteService().get('custom')?.getColorForValue?.(value, paletteParams, { - min: paletteParams.rangeMin, - max: paletteParams.rangeMax, - }) || defaultColor - : defaultColor; +const getColor = ( + value: number, + paletteParams: CustomPaletteState, + accessors: { metric: string; max?: string; breakdownBy?: string }, + data: Datatable, + rowNumber: number +) => { + let minBound = paletteParams.rangeMin; + let maxBound = paletteParams.rangeMax; + + const { min, max } = getDataBoundsForPalette(accessors, data, rowNumber); + minBound = min; + maxBound = max; + + return getPaletteService().get(CUSTOM_PALETTE)?.getColorForValue?.(value, paletteParams, { + min: minBound, + max: maxBound, + }); +}; + +const buildFilterEvent = (rowIdx: number, columnIdx: number, table: Datatable) => { + return { + name: 'filter', + data: { + data: [ + { + table, + column: columnIdx, + row: rowIdx, + }, + ], + }, + }; +}; export interface MetricVisComponentProps { data: Datatable; config: Pick; renderComplete: IInterpreterRenderHandlers['done']; + fireEvent: IInterpreterRenderHandlers['event']; + renderMode: RenderMode; + filterable: boolean; } -const MetricVisComponent = ({ data, config, renderComplete }: MetricVisComponentProps) => { +export const MetricVis = ({ + data, + config, + renderComplete, + fireEvent, + renderMode, + filterable, +}: MetricVisComponentProps) => { const primaryMetricColumn = getColumnByAccessor(config.dimensions.metric, data.columns)!; - const formatPrimaryMetric = getFormatter(config.dimensions.metric, data.columns); + const formatPrimaryMetric = getMetricFormatter(config.dimensions.metric, data.columns); let secondaryMetricColumn: DatatableColumn | undefined; - let formatSecondaryMetric: ReturnType; + let formatSecondaryMetric: ReturnType; if (config.dimensions.secondaryMetric) { secondaryMetricColumn = getColumnByAccessor(config.dimensions.secondaryMetric, data.columns); - formatSecondaryMetric = getFormatter(config.dimensions.secondaryMetric, data.columns); + formatSecondaryMetric = getMetricFormatter(config.dimensions.secondaryMetric, data.columns); } - const breakdownByColumn = config.dimensions.breakdownBy - ? getColumnByAccessor(config.dimensions.breakdownBy, data.columns) - : undefined; + let breakdownByColumn: DatatableColumn | undefined; + let formatBreakdownValue: FieldFormatConvertFunction; + if (config.dimensions.breakdownBy) { + breakdownByColumn = getColumnByAccessor(config.dimensions.breakdownBy, data.columns); + formatBreakdownValue = getFormatService() + .deserialize(getFormatByAccessor(config.dimensions.breakdownBy, data.columns)) + .getConverterFor('text'); + } let getProgressBarConfig = (_row: DatatableRow): Partial => ({}); - if (config.dimensions.progressMax) { - const maxColId = getColumnByAccessor(config.dimensions.progressMax, data.columns)?.id; - if (maxColId) { - getProgressBarConfig = (_row: DatatableRow): Partial => ({ - domainMax: _row[maxColId], - progressBarDirection: config.metric.progressDirection, - }); - } + const maxColId = config.dimensions.max + ? getColumnByAccessor(config.dimensions.max, data.columns)?.id + : undefined; + if (maxColId) { + getProgressBarConfig = (_row: DatatableRow): Partial => ({ + domainMax: _row[maxColId], + progressBarDirection: config.metric.progressDirection, + }); } const metricConfigs: MetricSpec['data'][number] = ( breakdownByColumn ? data.rows : data.rows.slice(0, 1) - ).map((row) => { + ).map((row, rowIdx) => { const value = row[primaryMetricColumn.id]; - const title = breakdownByColumn ? row[breakdownByColumn.id] : primaryMetricColumn.name; - const subtitle = breakdownByColumn - ? primaryMetricColumn.name - : secondaryMetricColumn?.name ?? config.metric.subtitle; + const title = breakdownByColumn + ? formatBreakdownValue(row[breakdownByColumn.id]) + : primaryMetricColumn.name; + const subtitle = breakdownByColumn ? primaryMetricColumn.name : config.metric.subtitle; return { value, valueFormatter: formatPrimaryMetric, @@ -196,12 +243,28 @@ const MetricVisComponent = ({ data, config, renderComplete }: MetricVisComponent subtitle, extra: ( + {config.metric.secondaryPrefix} {secondaryMetricColumn - ? formatSecondaryMetric!(row[secondaryMetricColumn.id]) - : config.metric.extraText} + ? `${config.metric.secondaryPrefix ? ' ' : ''}${formatSecondaryMetric!( + row[secondaryMetricColumn.id] + )}` + : undefined} ), - color: getColor(value, config.metric.palette), + color: + config.metric.palette && value != null + ? getColor( + value, + config.metric.palette, + { + metric: primaryMetricColumn.id, + max: maxColId, + breakdownBy: breakdownByColumn?.id, + }, + data, + rowIdx + ) ?? defaultColor + : config.metric.color ?? defaultColor, ...getProgressBarConfig(row), }; }); @@ -228,17 +291,62 @@ const MetricVisComponent = ({ data, config, renderComplete }: MetricVisComponent [renderComplete] ); + let pixelHeight; + let pixelWidth; + if (renderMode === 'edit') { + // In the editor, we constrain the maximum size of the tiles for aesthetic reasons + const maxTileSideLength = metricConfigs.flat().length > 1 ? 200 : 300; + pixelHeight = grid.length * maxTileSideLength; + pixelWidth = grid[0].length * maxTileSideLength; + } + + // force chart to re-render to circumvent a charts bug + const magicKey = useRef(0); + useEffect(() => { + magicKey.current++; + }, [data]); + return ( - - - - +
+ + { + if (!filterable) { + return; + } + events.forEach((event) => { + if (isMetricElementEvent(event)) { + const colIdx = breakdownByColumn + ? data.columns.findIndex((col) => col === breakdownByColumn) + : data.columns.findIndex((col) => col === primaryMetricColumn); + const rowLength = grid[0].length; + fireEvent( + buildFilterEvent(event.rowIndex * rowLength + event.columnIndex, colIdx, data) + ); + } + }); + }} + /> + + +
); }; - -// default export required for React.Lazy -// eslint-disable-next-line import/no-default-export -export { MetricVisComponent as default }; diff --git a/src/plugins/chart_expressions/expression_metric/public/expression_renderers/metric_vis_renderer.tsx b/src/plugins/chart_expressions/expression_metric/public/expression_renderers/metric_vis_renderer.tsx index f398029de38b8..19b47d57a06a4 100644 --- a/src/plugins/chart_expressions/expression_metric/public/expression_renderers/metric_vis_renderer.tsx +++ b/src/plugins/chart_expressions/expression_metric/public/expression_renderers/metric_vis_renderer.tsx @@ -6,21 +6,42 @@ * Side Public License, v 1. */ -import React, { lazy } from 'react'; +import React from 'react'; import { render, unmountComponentAtNode } from 'react-dom'; import { KibanaThemeProvider } from '@kbn/kibana-react-plugin/public'; import { ExpressionRenderDefinition } from '@kbn/expressions-plugin/common/expression_renderers'; -import { VisualizationContainer } from '@kbn/visualizations-plugin/public'; import { css } from '@emotion/react'; import { StartServicesGetter } from '@kbn/kibana-utils-plugin/public'; import { METRIC_TYPE } from '@kbn/analytics'; +import type { IInterpreterRenderHandlers, Datatable } from '@kbn/expressions-plugin/common'; +import { getColumnByAccessor } from '@kbn/visualizations-plugin/common/utils'; import { ExpressionMetricPluginStart } from '../plugin'; -import { EXPRESSION_METRIC_NAME, MetricVisRenderConfig } from '../../common'; +import { EXPRESSION_METRIC_NAME, MetricVisRenderConfig, VisParams } from '../../common'; import { extractContainerType, extractVisualizationType } from '../../../common'; -const MetricVis = lazy(() => import('../components/metric_vis')); - +async function metricFilterable( + dimensions: VisParams['dimensions'], + table: Datatable, + hasCompatibleActions?: IInterpreterRenderHandlers['hasCompatibleActions'] +) { + const column = getColumnByAccessor(dimensions.breakdownBy ?? dimensions.metric, table.columns); + const colIndex = table.columns.indexOf(column!); + return Boolean( + await hasCompatibleActions?.({ + name: 'filter', + data: { + data: [ + { + table, + column: colIndex, + row: 0, + }, + ], + }, + }) + ); +} interface ExpressionMetricVisRendererDependencies { getStartDeps: StartServicesGetter; } @@ -39,6 +60,11 @@ export const getMetricVisRenderer = ( unmountComponentAtNode(domNode); }); + const filterable = await metricFilterable( + visConfig.dimensions, + visData, + handlers.hasCompatibleActions?.bind(handlers) + ); const renderComplete = () => { const executionContext = handlers.getExecutionContext(); const containerType = extractContainerType(executionContext); @@ -53,20 +79,28 @@ export const getMetricVisRenderer = ( handlers.done(); }; + const { MetricVis } = await import('../components/metric_vis'); render( - - - + + , domNode ); diff --git a/src/plugins/chart_expressions/expression_metric/public/index.ts b/src/plugins/chart_expressions/expression_metric/public/index.ts index dfb442514d5f0..c8d5d080bd4e6 100644 --- a/src/plugins/chart_expressions/expression_metric/public/index.ts +++ b/src/plugins/chart_expressions/expression_metric/public/index.ts @@ -11,3 +11,5 @@ import { ExpressionMetricPlugin } from './plugin'; export function plugin() { return new ExpressionMetricPlugin(); } + +export { getDataBoundsForPalette } from './utils'; diff --git a/src/plugins/chart_expressions/expression_metric/public/utils/index.ts b/src/plugins/chart_expressions/expression_metric/public/utils/index.ts index 66c305a14c460..6927ea10009de 100644 --- a/src/plugins/chart_expressions/expression_metric/public/utils/index.ts +++ b/src/plugins/chart_expressions/expression_metric/public/utils/index.ts @@ -5,5 +5,5 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ -export { parseRgbString, shouldApplyColor, needsLightText } from './palette'; -export { formatValue } from './format'; + +export { getDataBoundsForPalette } from './palette_data_bounds'; diff --git a/src/plugins/chart_expressions/expression_metric/public/utils/palette.ts b/src/plugins/chart_expressions/expression_metric/public/utils/palette.ts deleted file mode 100644 index 7f588aa552385..0000000000000 --- a/src/plugins/chart_expressions/expression_metric/public/utils/palette.ts +++ /dev/null @@ -1,41 +0,0 @@ -/* - * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one - * or more contributor license agreements. Licensed under the Elastic License - * 2.0 and the Server Side Public License, v 1; you may not use this file except - * in compliance with, at your election, the Elastic License 2.0 or the Server - * Side Public License, v 1. - */ - -import { isColorDark } from '@elastic/eui'; - -export const parseRgbString = (rgb: string) => { - const groups = rgb.match(/rgb\(\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*?(,\s*(\d+)\s*)?\)/) ?? []; - if (!groups) { - return null; - } - - const red = parseFloat(groups[1]); - const green = parseFloat(groups[2]); - const blue = parseFloat(groups[3]); - const opacity = groups[5] ? parseFloat(groups[5]) : undefined; - - return { red, green, blue, opacity }; -}; - -export const shouldApplyColor = (color: string) => { - const rgb = parseRgbString(color); - const { opacity } = rgb ?? {}; - - // if opacity === 0, it means there is no color to apply to the metric - return !rgb || (rgb && opacity !== 0); -}; - -export const needsLightText = (bgColor: string = '') => { - const rgb = parseRgbString(bgColor); - if (!rgb) { - return false; - } - - const { red, green, blue, opacity } = rgb; - return isColorDark(red, green, blue) && opacity !== 0; -}; diff --git a/src/plugins/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts b/src/plugins/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts new file mode 100644 index 0000000000000..0776def5ab9ab --- /dev/null +++ b/src/plugins/chart_expressions/expression_metric/public/utils/palette_data_bounds.ts @@ -0,0 +1,37 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { Datatable } from '@kbn/expressions-plugin/common'; + +export const getDataBoundsForPalette = ( + accessors: { metric: string; max?: string; breakdownBy?: string }, + data?: Datatable, + rowNumber?: number +) => { + if (!data) { + return { min: -Infinity, max: Infinity }; + } + + const smallestMetric = Math.min(...data.rows.map((row) => row[accessors.metric])); + const greatestMetric = Math.max(...data.rows.map((row) => row[accessors.metric])); + const greatestMaximum = accessors.max + ? rowNumber + ? data.rows[rowNumber][accessors.max] + : Math.max(...data.rows.map((row) => row[accessors.max!])) + : greatestMetric; + + const dataMin = accessors.breakdownBy && !accessors.max ? smallestMetric : 0; + + const dataMax = accessors.breakdownBy + ? accessors.max + ? greatestMaximum + : greatestMetric + : greatestMaximum; + + return { min: dataMin, max: dataMax }; +}; diff --git a/src/plugins/chart_expressions/expression_xy/public/components/reference_lines/reference_line_annotations.tsx b/src/plugins/chart_expressions/expression_xy/public/components/reference_lines/reference_line_annotations.tsx index b97c105e2ab3e..886a7c7fcae68 100644 --- a/src/plugins/chart_expressions/expression_xy/public/components/reference_lines/reference_line_annotations.tsx +++ b/src/plugins/chart_expressions/expression_xy/public/components/reference_lines/reference_line_annotations.tsx @@ -33,7 +33,7 @@ import { export interface ReferenceLineAnnotationConfig { id: string; name?: string; - value: number; + value?: number; nextValue?: number; icon?: AvailableReferenceLineIcon; lineWidth?: number; @@ -103,7 +103,7 @@ export const ReferenceLineAnnotations: FC = ({ const dataValues = { dataValue: value, header: name, - details: formatter?.convert(value) || value.toString(), + details: formatter?.convert(value) || value?.toString(), }; const line = ( diff --git a/src/plugins/chart_expressions/expression_xy/public/components/reference_lines/reference_lines.test.tsx b/src/plugins/chart_expressions/expression_xy/public/components/reference_lines/reference_lines.test.tsx index 5d5ace297ba5f..6aa7319c0ba4c 100644 --- a/src/plugins/chart_expressions/expression_xy/public/components/reference_lines/reference_lines.test.tsx +++ b/src/plugins/chart_expressions/expression_xy/public/components/reference_lines/reference_lines.test.tsx @@ -6,8 +6,8 @@ * Side Public License, v 1. */ -import { LineAnnotation, RectAnnotation } from '@elastic/charts'; -import { shallow } from 'enzyme'; +import { Chart, LineAnnotation, RectAnnotation } from '@elastic/charts'; +import { mount, shallow } from 'enzyme'; import React from 'react'; import { Datatable } from '@kbn/expressions-plugin/common'; import { FieldFormat } from '@kbn/field-formats-plugin/common'; @@ -131,6 +131,38 @@ describe('ReferenceLines', () => { }; }); + it('should not throw on null data', () => { + const position = getAxisFromId('yAccessorLeft'); + const [layer] = createLayers([ + { + forAccessor: `yAccessorLeftFirstId`, + position, + lineStyle: 'solid', + fill: 'above', + type: 'referenceLineDecorationConfig', + }, + ]); + expect(() => + mount( + + + + ) + ).not.toThrow(); + }); + it.each([ ['yAccessorLeft', 'above'], ['yAccessorLeft', 'below'], diff --git a/src/plugins/chart_expressions/expression_xy/public/components/reference_lines/utils.tsx b/src/plugins/chart_expressions/expression_xy/public/components/reference_lines/utils.tsx index fab4f9a665526..2ccf2890efd49 100644 --- a/src/plugins/chart_expressions/expression_xy/public/components/reference_lines/utils.tsx +++ b/src/plugins/chart_expressions/expression_xy/public/components/reference_lines/utils.tsx @@ -121,7 +121,7 @@ export const getBottomRect = ( headerLabel: string | undefined, isFillAbove: boolean, formatter: FieldFormat | undefined, - currentValue: number, + currentValue?: number, nextValue?: number ) => ({ coordinates: { @@ -131,14 +131,14 @@ export const getBottomRect = ( y1: undefined, }, header: headerLabel, - details: formatter?.convert(currentValue) || currentValue.toString(), + details: formatter?.convert(currentValue) || currentValue?.toString(), }); export const getHorizontalRect = ( headerLabel: string | undefined, isFillAbove: boolean, formatter: FieldFormat | undefined, - currentValue: number, + currentValue?: number, nextValue?: number ) => ({ coordinates: { @@ -148,7 +148,7 @@ export const getHorizontalRect = ( y1: isFillAbove ? nextValue : currentValue, }, header: headerLabel, - details: formatter?.convert(currentValue) || currentValue.toString(), + details: formatter?.convert(currentValue) || currentValue?.toString(), }); const sortReferenceLinesByGroup = (referenceLines: ReferenceLineConfig[], group: FillStyle) => { diff --git a/src/plugins/dashboard/public/application/lib/dashboard_session_restoration.ts b/src/plugins/dashboard/public/application/lib/dashboard_session_restoration.ts index 60116c69dca9f..0b7f9ccb0e84f 100644 --- a/src/plugins/dashboard/public/application/lib/dashboard_session_restoration.ts +++ b/src/plugins/dashboard/public/application/lib/dashboard_session_restoration.ts @@ -8,6 +8,7 @@ import { History } from 'history'; import { createQueryParamObservable } from '@kbn/kibana-utils-plugin/public'; +import type { Query } from '@kbn/es-query'; import { DashboardAppLocatorParams, DashboardConstants } from '../..'; import { DashboardState } from '../../types'; import { getDashboardTitle } from '../../dashboard_strings'; @@ -113,7 +114,7 @@ function getLocatorParams({ timeRange: shouldRestoreSearchSession ? timefilter.getAbsoluteTime() : timefilter.getTime(), searchSessionId: shouldRestoreSearchSession ? data.search.session.getSessionId() : undefined, panels: getDashboardId() ? undefined : appState.panels, - query: queryString.formatQuery(appState.query), + query: queryString.formatQuery(appState.query) as Query, filters: filterManager.getFilters(), savedQuery: appState.savedQuery, dashboardId: getDashboardId(), diff --git a/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts b/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts index 94c9d996499c3..a23ae278c6978 100644 --- a/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts +++ b/src/plugins/dashboard/public/application/lib/sync_dashboard_filter_state.ts @@ -9,7 +9,6 @@ import _ from 'lodash'; import { merge } from 'rxjs'; import { debounceTime, finalize, map, switchMap, tap } from 'rxjs/operators'; - import { setQuery } from '../state'; import { DashboardBuildContext, DashboardState } from '../../types'; import { DashboardSavedObject } from '../../saved_dashboards'; @@ -100,7 +99,7 @@ export const syncDashboardFilterState = ({ // apply filters when the filter manager changes const filterManagerSubscription = merge(filterManager.getUpdates$(), queryString.getUpdates$()) .pipe(debounceTime(100)) - .subscribe(() => applyFilters(queryString.getQuery(), filterManager.getFilters())); + .subscribe(() => applyFilters(queryString.getQuery() as Query, filterManager.getFilters())); const timeRefreshSubscription = merge( timefilterService.getRefreshIntervalUpdate$(), diff --git a/src/plugins/data/common/query/query_state.ts b/src/plugins/data/common/query/query_state.ts index fbc5626f9a28c..a9ca73d7f0def 100644 --- a/src/plugins/data/common/query/query_state.ts +++ b/src/plugins/data/common/query/query_state.ts @@ -8,7 +8,7 @@ import type { Filter } from '@kbn/es-query'; import type { TimeRange, RefreshInterval } from './timefilter/types'; -import type { Query } from './types'; +import type { Query, AggregateQuery } from './types'; /** * All query state service state @@ -22,5 +22,5 @@ export type QueryState = { time?: TimeRange; refreshInterval?: RefreshInterval; filters?: Filter[]; - query?: Query; + query?: Query | AggregateQuery; }; diff --git a/src/plugins/data/common/query/to_expression_ast.test.ts b/src/plugins/data/common/query/to_expression_ast.test.ts index 9865b70bd491c..d7c1424869aa8 100644 --- a/src/plugins/data/common/query/to_expression_ast.test.ts +++ b/src/plugins/data/common/query/to_expression_ast.test.ts @@ -5,106 +5,74 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ - +import { DataViewsContract } from '@kbn/data-views-plugin/common'; import { queryStateToExpressionAst } from './to_expression_ast'; describe('queryStateToExpressionAst', () => { - it('returns an object with the correct structure', () => { - const actual = queryStateToExpressionAst({ + it('returns an object with the correct structure', async () => { + const dataViewsService = {} as unknown as DataViewsContract; + const actual = await queryStateToExpressionAst({ filters: [], query: { language: 'lucene', query: '' }, time: { from: 'now', to: 'now+7d', }, + dataViewsService, }); - expect(actual).toMatchInlineSnapshot(` - Object { - "findFunction": [Function], - "functions": Array [ - Object { - "addArgument": [Function], - "arguments": Object {}, - "getArgument": [Function], - "name": "kibana", - "removeArgument": [Function], - "replaceArgument": [Function], - "toAst": [Function], - "toString": [Function], - "type": "expression_function_builder", - }, - Object { - "addArgument": [Function], - "arguments": Object { - "filters": Array [], - "q": Array [ - Object { - "findFunction": [Function], - "functions": Array [ - Object { - "addArgument": [Function], - "arguments": Object { - "q": Array [ - "\\"\\"", - ], - }, - "getArgument": [Function], - "name": "lucene", - "removeArgument": [Function], - "replaceArgument": [Function], - "toAst": [Function], - "toString": [Function], - "type": "expression_function_builder", - }, - ], - "toAst": [Function], - "toString": [Function], - "type": "expression_builder", - }, - ], - "timeRange": Array [ - Object { - "findFunction": [Function], - "functions": Array [ - Object { - "addArgument": [Function], - "arguments": Object { - "from": Array [ - "now", - ], - "to": Array [ - "now+7d", - ], - }, - "getArgument": [Function], - "name": "timerange", - "removeArgument": [Function], - "replaceArgument": [Function], - "toAst": [Function], - "toString": [Function], - "type": "expression_function_builder", - }, - ], - "toAst": [Function], - "toString": [Function], - "type": "expression_builder", - }, - ], - }, - "getArgument": [Function], - "name": "kibana_context", - "removeArgument": [Function], - "replaceArgument": [Function], - "toAst": [Function], - "toString": [Function], - "type": "expression_function_builder", + expect(actual).toHaveProperty( + 'chain.1.arguments.timeRange.0.chain.0.arguments', + expect.objectContaining({ + from: ['now'], + to: ['now+7d'], + }) + ); + + expect(actual).toHaveProperty('chain.1.arguments.filters', expect.arrayContaining([])); + }); + + it('returns an object with the correct structure for an SQL query', async () => { + const dataViewsService = { + getIdsWithTitle: jest.fn(() => { + return [ + { + title: 'foo', + id: 'bar', }, - ], - "toAst": [Function], - "toString": [Function], - "type": "expression_builder", - } - `); + ]; + }), + get: jest.fn(() => { + return { + title: 'foo', + id: 'bar', + timeFieldName: 'baz', + }; + }), + } as unknown as DataViewsContract; + const actual = await queryStateToExpressionAst({ + filters: [], + query: { sql: 'SELECT * FROM foo' }, + time: { + from: 'now', + to: 'now+7d', + }, + dataViewsService, + }); + + expect(actual).toHaveProperty( + 'chain.1.arguments.timeRange.0.chain.0.arguments', + expect.objectContaining({ + from: ['now'], + to: ['now+7d'], + }) + ); + + expect(actual).toHaveProperty( + 'chain.2.arguments', + expect.objectContaining({ + query: ['SELECT * FROM foo'], + }) + ); }); }); diff --git a/src/plugins/data/common/query/to_expression_ast.ts b/src/plugins/data/common/query/to_expression_ast.ts index 929a7cc928cdd..e522ea367a47e 100644 --- a/src/plugins/data/common/query/to_expression_ast.ts +++ b/src/plugins/data/common/query/to_expression_ast.ts @@ -5,31 +5,73 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ - +import { + isOfAggregateQueryType, + getAggregateQueryMode, + getIndexPatternFromSQLQuery, + Query, +} from '@kbn/es-query'; import { buildExpression, buildExpressionFunction } from '@kbn/expressions-plugin/common'; +import type { DataViewsContract } from '@kbn/data-views-plugin/common'; import { ExpressionFunctionKibana, ExpressionFunctionKibanaContext, - filtersToAst, QueryState, + aggregateQueryToAst, queryToAst, + filtersToAst, timerangeToAst, } from '..'; +interface Args extends QueryState { + dataViewsService: DataViewsContract; + inputQuery?: Query; +} + /** * Converts QueryState to expression AST * @param filters array of kibana filters - * @param query kibana query + * @param query kibana query or aggregate query * @param time kibana time range */ -export function queryStateToExpressionAst({ filters, query, time }: QueryState) { +export async function queryStateToExpressionAst({ + filters, + query, + inputQuery, + time, + dataViewsService, +}: Args) { const kibana = buildExpressionFunction('kibana', {}); + let q; + if (inputQuery) { + q = inputQuery; + } const kibanaContext = buildExpressionFunction('kibana_context', { - q: query && queryToAst(query), - filters: filters && filtersToAst(filters), + q: q && queryToAst(q), timeRange: time && timerangeToAst(time), + filters: filters && filtersToAst(filters), }); + const ast = buildExpression([kibana, kibanaContext]).toAst(); + + if (query && isOfAggregateQueryType(query)) { + const mode = getAggregateQueryMode(query); + // sql query + if (mode === 'sql' && 'sql' in query) { + const idxPattern = getIndexPatternFromSQLQuery(query.sql); + const idsTitles = await dataViewsService.getIdsWithTitle(); + const dataViewIdTitle = idsTitles.find(({ title }) => title === idxPattern); + if (dataViewIdTitle) { + const dataView = await dataViewsService.get(dataViewIdTitle.id); + const timeFieldName = dataView.timeFieldName; + const essql = aggregateQueryToAst(query, timeFieldName); - const ast = buildExpression([kibana, kibanaContext]); + if (essql) { + ast.chain.push(essql); + } + } else { + throw new Error(`No data view found for index pattern ${idxPattern}`); + } + } + } return ast; } diff --git a/src/plugins/data/common/query/types.ts b/src/plugins/data/common/query/types.ts index fea59ea558a35..e10afaf746455 100644 --- a/src/plugins/data/common/query/types.ts +++ b/src/plugins/data/common/query/types.ts @@ -10,7 +10,7 @@ import type { Query, Filter } from '@kbn/es-query'; import type { RefreshInterval, TimeRange } from './timefilter/types'; export type { RefreshInterval, TimeRange, TimeRangeBounds } from './timefilter/types'; -export type { Query } from '@kbn/es-query'; +export type { Query, AggregateQuery } from '@kbn/es-query'; export type SavedQueryTimeFilter = TimeRange & { refreshInterval: RefreshInterval; diff --git a/src/plugins/data/common/search/expressions/aggregate_query_to_ast.test.ts b/src/plugins/data/common/search/expressions/aggregate_query_to_ast.test.ts new file mode 100644 index 0000000000000..f292954feea82 --- /dev/null +++ b/src/plugins/data/common/search/expressions/aggregate_query_to_ast.test.ts @@ -0,0 +1,25 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { aggregateQueryToAst } from './aggregate_query_to_ast'; + +describe('aggregateQueryToAst', () => { + it('should return a function', () => { + expect(aggregateQueryToAst({ sql: 'SELECT * from foo' })).toHaveProperty('type', 'function'); + }); + + it('should forward arguments', () => { + expect(aggregateQueryToAst({ sql: 'SELECT * from foo' }, 'baz')).toHaveProperty( + 'arguments', + expect.objectContaining({ + query: ['SELECT * from foo'], + timeField: ['baz'], + }) + ); + }); +}); diff --git a/src/plugins/data/common/search/expressions/aggregate_query_to_ast.ts b/src/plugins/data/common/search/expressions/aggregate_query_to_ast.ts new file mode 100644 index 0000000000000..84e1e4e5f2262 --- /dev/null +++ b/src/plugins/data/common/search/expressions/aggregate_query_to_ast.ts @@ -0,0 +1,23 @@ +/* + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one + * or more contributor license agreements. Licensed under the Elastic License + * 2.0 and the Server Side Public License, v 1; you may not use this file except + * in compliance with, at your election, the Elastic License 2.0 or the Server + * Side Public License, v 1. + */ + +import { buildExpressionFunction, ExpressionAstFunction } from '@kbn/expressions-plugin/common'; +import { AggregateQuery } from '../../query'; +import { EssqlExpressionFunctionDefinition } from './essql'; + +export const aggregateQueryToAst = ( + query: AggregateQuery, + timeField?: string +): undefined | ExpressionAstFunction => { + if ('sql' in query) { + return buildExpressionFunction('essql', { + query: query.sql, + timeField, + }).toAst(); + } +}; diff --git a/src/plugins/data/common/search/expressions/essql.ts b/src/plugins/data/common/search/expressions/essql.ts index 1038bf422fee8..398b92de490d8 100644 --- a/src/plugins/data/common/search/expressions/essql.ts +++ b/src/plugins/data/common/search/expressions/essql.ts @@ -40,9 +40,9 @@ type Output = Observable; interface Arguments { query: string; - parameter: Array; - count: number; - timezone: string; + parameter?: Array; + count?: number; + timezone?: string; timeField?: string; } diff --git a/src/plugins/data/common/search/expressions/index.ts b/src/plugins/data/common/search/expressions/index.ts index 23d3b865b4c05..8c37836e30dea 100644 --- a/src/plugins/data/common/search/expressions/index.ts +++ b/src/plugins/data/common/search/expressions/index.ts @@ -27,6 +27,7 @@ export * from './numerical_range_to_ast'; export * from './query_filter'; export * from './query_filter_to_ast'; export * from './query_to_ast'; +export * from './aggregate_query_to_ast'; export * from './timerange_to_ast'; export * from './kibana_context_type'; export * from './esaggs'; diff --git a/src/plugins/data/common/search/expressions/kibana_context.ts b/src/plugins/data/common/search/expressions/kibana_context.ts index 6183484a57b46..5c29ed23aad76 100644 --- a/src/plugins/data/common/search/expressions/kibana_context.ts +++ b/src/plugins/data/common/search/expressions/kibana_context.ts @@ -11,7 +11,7 @@ import { i18n } from '@kbn/i18n'; import { ExpressionFunctionDefinition, ExecutionContext } from '@kbn/expressions-plugin/common'; import { Adapters } from '@kbn/inspector-plugin/common'; import { Filter } from '@kbn/es-query'; -import { Query, uniqFilters } from '@kbn/es-query'; +import { Query, uniqFilters, AggregateQuery } from '@kbn/es-query'; import { unboxExpressionValue } from '@kbn/expressions-plugin/common'; import { SavedObjectReference } from '@kbn/core/types'; import { SavedObjectsClientCommon } from '@kbn/data-views-plugin/common'; @@ -41,8 +41,11 @@ export type ExpressionFunctionKibanaContext = ExpressionFunctionDefinition< const getParsedValue = (data: any, defaultValue: any) => typeof data === 'string' && data.length ? JSON.parse(data) || defaultValue : defaultValue; -const mergeQueries = (first: Query | Query[] = [], second: Query | Query[]) => - uniqBy( +const mergeQueries = ( + first: Query | AggregateQuery | Array = [], + second: Query | AggregateQuery | Array +) => + uniqBy( [...(Array.isArray(first) ? first : [first]), ...(Array.isArray(second) ? second : [second])], (n: any) => JSON.stringify(n.query) ); diff --git a/src/plugins/data/common/search/expressions/kibana_context_type.ts b/src/plugins/data/common/search/expressions/kibana_context_type.ts index 53a443166a57f..3c65f4e20a070 100644 --- a/src/plugins/data/common/search/expressions/kibana_context_type.ts +++ b/src/plugins/data/common/search/expressions/kibana_context_type.ts @@ -5,7 +5,7 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ -import { Filter } from '@kbn/es-query'; +import { Filter, AggregateQuery } from '@kbn/es-query'; import { ExpressionValueBoxed, ExpressionValueFilter } from '@kbn/expressions-plugin/common'; import { Query, TimeRange } from '../../query'; import { adaptToExpressionValueFilter, DataViewField } from '../..'; @@ -13,7 +13,7 @@ import { adaptToExpressionValueFilter, DataViewField } from '../..'; // eslint-disable-next-line @typescript-eslint/consistent-type-definitions export type ExecutionContextSearch = { filters?: Filter[]; - query?: Query | Query[]; + query?: Query | AggregateQuery | Array; timeRange?: TimeRange; }; diff --git a/src/plugins/data/common/search/search_source/migrate_legacy_query.ts b/src/plugins/data/common/search/search_source/migrate_legacy_query.ts index 70961d705f7b8..1395173562953 100644 --- a/src/plugins/data/common/search/search_source/migrate_legacy_query.ts +++ b/src/plugins/data/common/search/search_source/migrate_legacy_query.ts @@ -5,9 +5,8 @@ * in compliance with, at your election, the Elastic License 2.0 or the Server * Side Public License, v 1. */ - +import { Query, AggregateQuery, isOfAggregateQueryType } from '@kbn/es-query'; import { has } from 'lodash'; -import { Query } from '../../query/types'; /** * Creates a standardized query object from old queries that were either strings or pure ES query DSL @@ -16,9 +15,15 @@ import { Query } from '../../query/types'; * @return Object */ -export function migrateLegacyQuery(query: Query | { [key: string]: any } | string): Query { +export function migrateLegacyQuery( + query: Query | { [key: string]: any } | string | AggregateQuery +): Query | AggregateQuery { // Lucene was the only option before, so language-less queries are all lucene + // If the query is already a AggregateQuery, just return it if (!has(query, 'language')) { + if (typeof query === 'object' && isOfAggregateQueryType(query)) { + return query; + } return { query, language: 'lucene' }; } diff --git a/src/plugins/data/common/search/search_source/search_source.ts b/src/plugins/data/common/search/search_source/search_source.ts index a3f127573644d..295f105cd4c35 100644 --- a/src/plugins/data/common/search/search_source/search_source.ts +++ b/src/plugins/data/common/search/search_source/search_source.ts @@ -72,7 +72,7 @@ import { } from 'rxjs/operators'; import { defer, EMPTY, from, lastValueFrom, Observable } from 'rxjs'; import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; -import { buildEsQuery, Filter } from '@kbn/es-query'; +import { buildEsQuery, Filter, isOfQueryType } from '@kbn/es-query'; import { fieldWildcardFilter } from '@kbn/kibana-utils-plugin/common'; import { getHighlightRequest } from '@kbn/field-formats-plugin/common'; import type { DataView } from '@kbn/data-views-plugin/common'; @@ -261,7 +261,11 @@ export class SearchSource { filters = this.getFilters(originalFilters); } - const queryString = Array.isArray(query) ? query.map((q) => q.query) : query?.query; + const queryString = Array.isArray(query) + ? query.map((q) => q.query) + : isOfQueryType(query) + ? query?.query + : undefined; const indexPatternFromQuery = typeof queryString === 'string' @@ -380,7 +384,6 @@ export class SearchSource { /** * Fetch this source and reject the returned Promise on error * @deprecated Use the `fetch$` method instead - * @removeBy 8.1 */ fetch(options: ISearchOptions = {}) { return lastValueFrom(this.fetch$(options)).then((r) => { diff --git a/src/plugins/data/common/search/search_source/types.ts b/src/plugins/data/common/search/search_source/types.ts index 04cee3603bedb..3cee6355ccbfa 100644 --- a/src/plugins/data/common/search/search_source/types.ts +++ b/src/plugins/data/common/search/search_source/types.ts @@ -7,13 +7,13 @@ */ import type * as estypes from '@elastic/elasticsearch/lib/api/typesWithBodyKey'; +import { Query, AggregateQuery } from '@kbn/es-query'; import { SerializableRecord } from '@kbn/utility-types'; import { PersistableStateService } from '@kbn/kibana-utils-plugin/common'; import type { Filter } from '@kbn/es-query'; import type { DataView, DataViewSpec } from '@kbn/data-views-plugin/common'; // eslint-disable-next-line @kbn/eslint/no-restricted-paths import { AggConfigSerialized, IAggConfigs } from '../../../public'; -import { Query } from '../..'; import type { SearchSource } from './search_source'; /** @@ -78,7 +78,7 @@ export interface SearchSourceFields { /** * {@link Query} */ - query?: Query; + query?: Query | AggregateQuery; /** * {@link Filter} */ @@ -125,7 +125,7 @@ export type SerializedSearchSourceFields = { /** * {@link Query} */ - query?: Query; + query?: Query | AggregateQuery; /** * {@link Filter} */ diff --git a/src/plugins/data/public/query/query_string/query_string_manager.test.ts b/src/plugins/data/public/query/query_string/query_string_manager.test.ts index 7ba28a7e04cd9..2da2ee68c86e6 100644 --- a/src/plugins/data/public/query/query_string/query_string_manager.test.ts +++ b/src/plugins/data/public/query/query_string/query_string_manager.test.ts @@ -10,7 +10,7 @@ import { QueryStringManager } from './query_string_manager'; import { Storage } from '@kbn/kibana-utils-plugin/public/storage'; import { StubBrowserStorage } from '@kbn/test-jest-helpers'; import { coreMock } from '@kbn/core/public/mocks'; -import { Query } from '../../../common/query'; +import { Query, AggregateQuery } from '../../../common/query'; describe('QueryStringManager', () => { let service: QueryStringManager; @@ -24,7 +24,7 @@ describe('QueryStringManager', () => { test('getUpdates$ is a cold emits only after query changes', () => { const obs$ = service.getUpdates$(); - const emittedValues: Query[] = []; + const emittedValues: Array = []; obs$.subscribe((v) => { emittedValues.push(v); }); diff --git a/src/plugins/data/public/query/query_string/query_string_manager.ts b/src/plugins/data/public/query/query_string/query_string_manager.ts index f8d9025ad0db4..b259b29130055 100644 --- a/src/plugins/data/public/query/query_string/query_string_manager.ts +++ b/src/plugins/data/public/query/query_string/query_string_manager.ts @@ -10,18 +10,19 @@ import { BehaviorSubject } from 'rxjs'; import { skip } from 'rxjs/operators'; import { PublicMethodsOf } from '@kbn/utility-types'; import { CoreStart } from '@kbn/core/public'; -import type { Query } from '@kbn/es-query'; +import type { Query, AggregateQuery } from '@kbn/es-query'; import { IStorageWrapper } from '@kbn/kibana-utils-plugin/public'; +import { isEqual } from 'lodash'; import { KIBANA_USER_QUERY_LANGUAGE_KEY, UI_SETTINGS } from '../../../common'; export class QueryStringManager { - private query$: BehaviorSubject; + private query$: BehaviorSubject; constructor( private readonly storage: IStorageWrapper, private readonly uiSettings: CoreStart['uiSettings'] ) { - this.query$ = new BehaviorSubject(this.getDefaultQuery()); + this.query$ = new BehaviorSubject(this.getDefaultQuery()); } private getDefaultLanguage() { @@ -38,7 +39,7 @@ export class QueryStringManager { }; } - public formatQuery(query: Query | string | undefined): Query { + public formatQuery(query: Query | AggregateQuery | string | undefined): Query | AggregateQuery { if (!query) { return this.getDefaultQuery(); } else if (typeof query === 'string') { @@ -55,17 +56,17 @@ export class QueryStringManager { return this.query$.asObservable().pipe(skip(1)); }; - public getQuery = (): Query => { + public getQuery = (): Query | AggregateQuery => { return this.query$.getValue(); }; /** * Updates the query. - * @param {Query} query + * @param {Query | AggregateQuery} query */ - public setQuery = (query: Query) => { + public setQuery = (query: Query | AggregateQuery) => { const curQuery = this.query$.getValue(); - if (query?.language !== curQuery.language || query?.query !== curQuery.query) { + if (!isEqual(query, curQuery)) { this.query$.next(query); } }; diff --git a/src/plugins/data/public/search/session/sessions_client.ts b/src/plugins/data/public/search/session/sessions_client.ts index 71e8d9dafb78d..f05f7b794763e 100644 --- a/src/plugins/data/public/search/session/sessions_client.ts +++ b/src/plugins/data/public/search/session/sessions_client.ts @@ -7,11 +7,12 @@ */ import { PublicContract } from '@kbn/utility-types'; -import { HttpSetup, SavedObjectsFindOptions } from '@kbn/core/public'; +import { HttpSetup } from '@kbn/core/public'; import type { SavedObject, SavedObjectsFindResponse, SavedObjectsUpdateResponse, + SavedObjectsFindOptions, // eslint-disable-next-line @kbn/eslint/no-restricted-paths } from '@kbn/core/server'; import type { SearchSessionSavedObjectAttributes } from '../../../common'; diff --git a/src/plugins/data/server/query/route_handler_context.test.ts b/src/plugins/data/server/query/route_handler_context.test.ts index 33d4597ecff0b..1c274fcfc3953 100644 --- a/src/plugins/data/server/query/route_handler_context.test.ts +++ b/src/plugins/data/server/query/route_handler_context.test.ts @@ -7,7 +7,7 @@ */ import { coreMock } from '@kbn/core/server/mocks'; -import { FilterStateStore } from '@kbn/es-query'; +import { FilterStateStore, Query } from '@kbn/es-query'; import { DATA_VIEW_SAVED_OBJECT_TYPE } from '../../common'; import type { SavedObject, SavedQueryAttributes } from '../../common'; import { registerSavedQueryRouteHandlerContext } from './route_handler_context'; @@ -438,7 +438,8 @@ describe('saved query route handler context', () => { }); const response = await context.get('food'); - expect(response.attributes.query.query).toEqual({ x: 'y' }); + const query = response.attributes.query as Query; + expect(query.query).toEqual({ x: 'y' }); }); it('should handle null string', async () => { @@ -460,7 +461,8 @@ describe('saved query route handler context', () => { }); const response = await context.get('food'); - expect(response.attributes.query.query).toEqual('null'); + const query = response.attributes.query as Query; + expect(query.query).toEqual('null'); }); it('should handle null quoted string', async () => { @@ -482,7 +484,8 @@ describe('saved query route handler context', () => { }); const response = await context.get('food'); - expect(response.attributes.query.query).toEqual('"null"'); + const query = response.attributes.query as Query; + expect(query.query).toEqual('"null"'); }); it('should not lose quotes', async () => { @@ -504,7 +507,8 @@ describe('saved query route handler context', () => { }); const response = await context.get('food'); - expect(response.attributes.query.query).toEqual('"Bob"'); + const query = response.attributes.query as Query; + expect(query.query).toEqual('"Bob"'); }); it('should inject references', async () => { diff --git a/src/plugins/data/server/query/route_handler_context.ts b/src/plugins/data/server/query/route_handler_context.ts index a79063014abc0..6179a909eee57 100644 --- a/src/plugins/data/server/query/route_handler_context.ts +++ b/src/plugins/data/server/query/route_handler_context.ts @@ -7,7 +7,7 @@ */ import { CustomRequestHandlerContext, RequestHandlerContext, SavedObject } from '@kbn/core/server'; -import { isFilters } from '@kbn/es-query'; +import { isFilters, isOfQueryType } from '@kbn/es-query'; import { isQuery, SavedQueryAttributes } from '../../common'; import { extract, inject } from '../../common/query/filters/persistable_state'; @@ -17,7 +17,7 @@ function injectReferences({ references, }: Pick, 'id' | 'attributes' | 'references'>) { const { query } = attributes; - if (typeof query.query === 'string') { + if (isOfQueryType(query) && typeof query.query === 'string') { try { const parsed = JSON.parse(query.query); query.query = parsed instanceof Object ? parsed : query.query; @@ -37,13 +37,22 @@ function extractReferences({ timefilter, }: SavedQueryAttributes) { const { state: extractedFilters, references } = extract(filters); + const isOfQueryTypeQuery = isOfQueryType(query); + let queryString = ''; + if (isOfQueryTypeQuery) { + if (typeof query.query === 'string') { + queryString = query.query; + } else { + queryString = JSON.stringify(query.query); + } + } const attributes: SavedQueryAttributes = { title: title.trim(), description: description.trim(), query: { ...query, - query: typeof query.query === 'string' ? query.query : JSON.stringify(query.query), + ...(queryString && { query: queryString }), }, filters: extractedFilters, ...(timefilter && { timefilter }), diff --git a/src/plugins/data/server/search/session/session_service.test.ts b/src/plugins/data/server/search/session/session_service.test.ts index c19731d370803..6565eaf11d3be 100644 --- a/src/plugins/data/server/search/session/session_service.test.ts +++ b/src/plugins/data/server/search/session/session_service.test.ts @@ -358,17 +358,15 @@ describe('SearchSessionService', () => { Object { "arguments": Array [ Object { + "isQuoted": false, "type": "literal", "value": "search-session.attributes.realmType", }, Object { + "isQuoted": false, "type": "literal", "value": "my_realm_type", }, - Object { - "type": "literal", - "value": false, - }, ], "function": "is", "type": "function", @@ -376,17 +374,15 @@ describe('SearchSessionService', () => { Object { "arguments": Array [ Object { + "isQuoted": false, "type": "literal", "value": "search-session.attributes.realmName", }, Object { + "isQuoted": false, "type": "literal", "value": "my_realm_name", }, - Object { - "type": "literal", - "value": false, - }, ], "function": "is", "type": "function", @@ -394,17 +390,15 @@ describe('SearchSessionService', () => { Object { "arguments": Array [ Object { + "isQuoted": false, "type": "literal", "value": "search-session.attributes.username", }, Object { + "isQuoted": false, "type": "literal", "value": "my_username", }, - Object { - "type": "literal", - "value": false, - }, ], "function": "is", "type": "function", @@ -450,17 +444,15 @@ describe('SearchSessionService', () => { Object { "arguments": Array [ Object { + "isQuoted": false, "type": "literal", "value": "search-session.attributes.realmType", }, Object { + "isQuoted": false, "type": "literal", "value": "my_realm_type", }, - Object { - "type": "literal", - "value": false, - }, ], "function": "is", "type": "function", @@ -468,17 +460,15 @@ describe('SearchSessionService', () => { Object { "arguments": Array [ Object { + "isQuoted": false, "type": "literal", "value": "search-session.attributes.realmName", }, Object { + "isQuoted": false, "type": "literal", "value": "my_realm_name", }, - Object { - "type": "literal", - "value": false, - }, ], "function": "is", "type": "function", @@ -486,17 +476,15 @@ describe('SearchSessionService', () => { Object { "arguments": Array [ Object { + "isQuoted": false, "type": "literal", "value": "search-session.attributes.username", }, Object { + "isQuoted": false, "type": "literal", "value": "my_username", }, - Object { - "type": "literal", - "value": false, - }, ], "function": "is", "type": "function", @@ -504,17 +492,15 @@ describe('SearchSessionService', () => { Object { "arguments": Array [ Object { + "isQuoted": false, "type": "literal", "value": null, }, Object { + "isQuoted": false, "type": "literal", "value": "foobar", }, - Object { - "type": "literal", - "value": false, - }, ], "function": "is", "type": "function", @@ -533,17 +519,15 @@ describe('SearchSessionService', () => { Object { "arguments": Array [ Object { + "isQuoted": false, "type": "literal", "value": "search-session.attributes.realmType", }, Object { + "isQuoted": false, "type": "literal", "value": "my_realm_type", }, - Object { - "type": "literal", - "value": false, - }, ], "function": "is", "type": "function", @@ -551,17 +535,15 @@ describe('SearchSessionService', () => { Object { "arguments": Array [ Object { + "isQuoted": false, "type": "literal", "value": "search-session.attributes.realmName", }, Object { + "isQuoted": false, "type": "literal", "value": "my_realm_name", }, - Object { - "type": "literal", - "value": false, - }, ], "function": "is", "type": "function", @@ -569,17 +551,15 @@ describe('SearchSessionService', () => { Object { "arguments": Array [ Object { + "isQuoted": false, "type": "literal", "value": "search-session.attributes.username", }, Object { + "isQuoted": false, "type": "literal", "value": "my_username", }, - Object { - "type": "literal", - "value": false, - }, ], "function": "is", "type": "function", @@ -587,17 +567,15 @@ describe('SearchSessionService', () => { Object { "arguments": Array [ Object { + "isQuoted": false, "type": "literal", "value": "foo", }, Object { + "isQuoted": false, "type": "literal", "value": "bar", }, - Object { - "type": "literal", - "value": false, - }, ], "function": "is", "type": "function", diff --git a/src/plugins/data_view_editor/public/components/data_view_editor_flyout_content.tsx b/src/plugins/data_view_editor/public/components/data_view_editor_flyout_content.tsx index 3c1305d8e7860..c9baa374ed1de 100644 --- a/src/plugins/data_view_editor/public/components/data_view_editor_flyout_content.tsx +++ b/src/plugins/data_view_editor/public/components/data_view_editor_flyout_content.tsx @@ -410,7 +410,12 @@ const IndexPatternEditorFlyoutContentComponent = ({